Activate agent
curl --request POST \
--url http://localhost:3000/api/agents/{id}/activate \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/api/agents/{id}/activate"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/api/agents/{id}/activate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/agents/{id}/activate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/agents/{id}/activate"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/agents/{id}/activate")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/agents/{id}/activate")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"organizationId": "<string>",
"name": "Customer Support Agent",
"instructions": "<string>",
"status": "draft",
"version": 123,
"modelConfig": {
"model": "openai/gpt-4o",
"modelSettings": {},
"providerOptions": {}
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"policy": "<string>",
"voiceConfig": {
"pipelineMode": "batch",
"voiceId": "EXAVITQdyfvLewQXW32eyLI",
"stsProvider": "openai"
},
"memoryConfig": {
"enabled": true,
"lastMessages": 20,
"semanticRecall": false
},
"metadata": {},
"knowledgeBaseConfig": {},
"createdBy": "<string>"
}Agent Studio
Activate agent
POST
/
api
/
agents
/
{id}
/
activate
Activate agent
curl --request POST \
--url http://localhost:3000/api/agents/{id}/activate \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/api/agents/{id}/activate"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/api/agents/{id}/activate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/agents/{id}/activate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/agents/{id}/activate"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/agents/{id}/activate")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/agents/{id}/activate")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"organizationId": "<string>",
"name": "Customer Support Agent",
"instructions": "<string>",
"status": "draft",
"version": 123,
"modelConfig": {
"model": "openai/gpt-4o",
"modelSettings": {},
"providerOptions": {}
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"policy": "<string>",
"voiceConfig": {
"pipelineMode": "batch",
"voiceId": "EXAVITQdyfvLewQXW32eyLI",
"stsProvider": "openai"
},
"memoryConfig": {
"enabled": true,
"lastMessages": 20,
"semanticRecall": false
},
"metadata": {},
"knowledgeBaseConfig": {},
"createdBy": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Agent ID
Response
Agent activated successfully
Agent ID
Organization ID
Agent name
Example:
"Customer Support Agent"
Agent instructions
Agent status
Available options:
draft, active, archived Agent version
Model configuration
Show child attributes
Show child attributes
Created at timestamp
Updated at timestamp
Agent description
Agent policy (business rules)
Voice configuration
Show child attributes
Show child attributes
Memory configuration
Show child attributes
Show child attributes
Additional metadata
Knowledge base configuration for RAG
Created by user ID