Skip to main content
curl --request GET \
  --url https://app.voker.ai/api/v1/agents/customer-support-agent \
  --header "Authorization: Bearer $VOKER_API_KEY"
Pass your API key as a Bearer token in the Authorization header: Authorization: Bearer YOUR_API_KEYSet the VOKER_API_KEY environment variable in your application to keep your key out of source code.

​
Get Agent

GET /api/v1/agents/{agent_name} Path parameters
​
agent_name
string
required
The unique name of the agent.
Responses
​
agent_name
string
Unique identifier for the agent.
​
description
string
Optional description of the agent. May be null.
​
agent_number
integer
Unique number assigned to the agent.
​
created_at
string
ISO 8601 timestamp of when the agent was created.
​
deprecated_at
string
ISO 8601 timestamp of when the agent was deprecated, or null if active.
{ "type": "agent-not-found" }

​
Create Agent

PUT /api/v1/agents Request body
​
agent_name
string
required
A unique identifier for the agent. This name is used when referencing the agent in events.
​
description
string
An optional human-readable description of what the agent does.
Responses
​
agent_name
string
The unique name of the created agent.
​
description
string
Description of the agent. May be null.
​
agent_number
integer
Auto-assigned numeric identifier.
​
created_at
string
ISO 8601 timestamp of when the agent was created.
​
deprecated_at
string
Always null for newly created agents.