Edit description
Set the agent's description (the one-liner shown in the workspace list + breadcrumb). Pass an empty string to clear.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Header Parameters
A key you choose, such as a UUID, that makes this POST safe to retry. Within 24 hours the same key and request answers with the first successful answer and runs nothing, the same key with a different request answers 422 idempotency_key_reused, and a key whose request is still running answers 409 idempotency_key_in_use. A failed request keeps nothing, so the same key runs it again.
1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/operations/set_description" \ -H "Content-Type: application/json" \ -d '{ "description": "string", "agent": "string" }'{}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}Set closed message POST
Write and render the message the agent speaks when a call arrives outside answering hours. Agent-level, NOT versioned. Pass exactly one of text (the exact words to save) or generate: true (draft it from the agent's persona + its stored schedule). Either way this ALWAYS renders the clip in the agent's current voice and saves it, a saved-but-unrendered message is what publish blocks on, so this op never leaves one behind. Call this BEFORE set_answering_hours enabled: true, turning answering hours on with no message is refused.
Set fallback model POST
Set the FALLBACK LLM model the live agent runs on calls and chats when its primary model (set_model) becomes unavailable, a disabled or decommissioned key. It is versioned exactly like the primary model: the write lands on the current draft version (create a draft first if the current version is published). Pass null to clear the fallback so the runtime uses the platform's default model as the backstop. Pick a model different from the primary: the same model cannot stand in for itself, and validate_agent flags it as a risk. Take the key from the model picker, which lists every model with its tier (Fast, Balanced, Power, Speed) and marks the default; get_agent shows the key the agent runs on now. When the user names a model loosely, map it to the matching picker key.