For the complete documentation index, see llms.txt. This page is also available as Markdown.

Services

List services

get

List services in a workspace with pagination. Requires Service.view permission.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
searchstring · min: 1 · max: 200 · nullableOptional
sort_bystring · nullableOptional
is_activeboolean · nullableOptional
limitinteger · max: 100OptionalDefault: 10
continuation_tokenintegerOptionalDefault: 0
Responses
200

Successful Response

application/json
has_morebooleanRequired
continuation_tokeninteger · nullableOptional
totalinteger · nullableOptional
get/v1/{workspace_id}/services

Create a service

post

Create a new service linking an agent and HSM. Validates that agent_id and context_graph_id exist in the workspace. Requires Service.create permission.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Body
namestring · min: 1 · max: 256Required
descriptionstring · max: 2000OptionalDefault: ""
agent_idstring · uuidRequired
context_graph_idstring · uuidRequired
keytermsstring[] · max: 500Optional
is_activebooleanOptionalDefault: true
tool_capacityinteger · min: 1 · max: 10OptionalDefault: 3
channel_typestring · enumOptionalDefault: voicePossible values:
environmentstring · enumOptionalDefault: productionPossible values:
Responses
201

Successful Response

application/json
idstring · uuidRequired
workspace_idstring · uuidRequired
namestringRequired
descriptionstringRequired
agent_idstring · uuidRequired
context_graph_idstring · uuidRequired
agent_namestring · nullableOptional
context_graph_namestring · nullableOptional
keytermsstring[]Required
is_activebooleanRequired
tool_capacityintegerRequired
channel_typestring · enumOptionalDefault: voicePossible values:
environmentstring · enumOptionalDefault: productionPossible values:
is_systembooleanOptionalDefault: false
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
post/v1/{workspace_id}/services

Get a service

get

Retrieve a service by ID. Requires Service.view permission.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
service_idstring · uuidRequired
Responses
200

Successful Response

application/json
idstring · uuidRequired
workspace_idstring · uuidRequired
namestringRequired
descriptionstringRequired
agent_idstring · uuidRequired
context_graph_idstring · uuidRequired
agent_namestring · nullableOptional
context_graph_namestring · nullableOptional
keytermsstring[]Required
is_activebooleanRequired
tool_capacityintegerRequired
channel_typestring · enumOptionalDefault: voicePossible values:
environmentstring · enumOptionalDefault: productionPossible values:
is_systembooleanOptionalDefault: false
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
get/v1/{workspace_id}/services/{service_id}

Update a service

put

Update a service's configuration. Requires Service.update permission.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
service_idstring · uuidRequired
Body
namestring · min: 1 · max: 256 · nullableOptional
descriptionstring · max: 2000 · nullableOptional
agent_idstring · uuid · nullableOptional
context_graph_idstring · uuid · nullableOptional
keytermsstring[] · max: 500 · nullableOptional
is_activeboolean · nullableOptional
tool_capacityinteger · min: 1 · max: 10 · nullableOptional
channel_typestring · enum · nullableOptionalPossible values:
environmentstring · enum · nullableOptionalPossible values:
Responses
200

Successful Response

application/json
idstring · uuidRequired
workspace_idstring · uuidRequired
namestringRequired
descriptionstringRequired
agent_idstring · uuidRequired
context_graph_idstring · uuidRequired
agent_namestring · nullableOptional
context_graph_namestring · nullableOptional
keytermsstring[]Required
is_activebooleanRequired
tool_capacityintegerRequired
channel_typestring · enumOptionalDefault: voicePossible values:
environmentstring · enumOptionalDefault: productionPossible values:
is_systembooleanOptionalDefault: false
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
put/v1/{workspace_id}/services/{service_id}

Delete a service

delete

Delete a service. Requires Service.delete permission.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
service_idstring · uuidRequired
Responses
204

Successful Response

No content

delete/v1/{workspace_id}/services/{service_id}

No content

Upsert a service version set

put

Replace or create a named version set on a service. Pinned agent/HSM versions are validated.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
service_idstring · uuidRequired
namestring · max: 40Required

Version set name (e.g. 'release')

Body
Responses
204

Successful Response

No content

put/v1/{workspace_id}/services/{service_id}/version-sets/{name}

No content

Voice Turn

post

Run one WhatsApp-style voice-note turn against the service's agent.

Accepts OGG Opus audio (or any format Deepgram's prerecorded endpoint accepts). Server keys the conversation on (workspace, service, phone_number) and returns the agent's spoken reply as OGG Opus.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
service_idstring · uuidRequired
Body
audiostringRequired
phone_numberstring · max: 16RequiredPattern: ^\+[1-9]\d{1,14}$
Responses
200

OGG Opus agent reply

anyOptional
post/v1/{workspace_id}/services/{service_id}/voice-turn

No content

Text Turn

post

Run one WhatsApp-style text turn against the service's agent.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
service_idstring · uuidRequired
Body

Request body for POST /v1/{ws}/services/{service_id}/text-turn.

phone_numberstring · max: 16RequiredPattern: ^\+[1-9]\d{1,14}$
agent_phonestring · max: 16RequiredPattern: ^\+[1-9]\d{1,14}$
textstring · min: 1 · max: 8192Required
Responses
200

Agent text reply

application/json

Response body — the agent's text reply.

Returned only on 200; 204 indicates the engine elected silence.

textstring · max: 8192Required
post/v1/{workspace_id}/services/{service_id}/text-turn

Last updated

Was this helpful?