Export agent spec
Return the agent's config as one spec, in exactly the shape apply_agent_spec takes, listing only what differs from a new agent: name, description, systemPrompt, the three greetings, channels, the brief, voice and fallback voice, models, the call engine, speech, turn-taking, behaviour, keyterms, pronunciations, vocabulary, caller memory, guardrails, agent response guardrails, privacy and disclosure settings, call handling, the overflow number, the closed message, answering hours, closed early, caller routing, built-in and HTTP tools with their mocks in the agent's order (not the knowledge-search tool the first knowledge source adds, while it is unchanged), variables (a secret appears as {name, secret: true}; its value is never returned), workflow functions, post-call analysis, knowledge sources (text sources with their text) and test scenarios. Edit it and pass it back to apply_agent_spec with replace: true to make the draft match it. `secrets` says which secret variables hold a value.
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/export_agent_spec" \ -H "Content-Type: application/json" \ -d '{ "agent": "string" }'{
"spec": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}{
"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
}Evaluate call POST
Run the metric catalogue over a real call and persist the results. Reuses the call-metric engine (never recomputes in TS); deterministic metrics always run, and the LLM-judge metrics run too unless you pass judge=false (deterministic-only, no token cost). After this, get_call_metrics returns the persisted grid. Use it when a call has no metric results yet, or to re-score after fixing the agent. The call must have an analysable transcript.
Generate persona POST
Generate one or more custom caller personas from a free-text brief. A persona is the SIMULATED CALLER a test scenario runs as, this expands a short brief (e.g. 'impatient elderly caller with hearing loss') into that many full personas, each with a second-person behaviour prompt plus advanced voice settings (accent, speaking pace, interruption level), and saves them to the workspace persona catalogue as 'custom' personas. Use it to quickly populate the catalogue with the kinds of callers you want to test against. Each persona is a TEST HARNESS only, it never changes how the agent itself behaves. Personas are workspace-scoped (reusable across every agent's tests). Persists immediately; call list_personas first so you don't duplicate an existing persona.