Skip to content
Vocapable Developers

Chat with this agent draft in text - no publish, no dial, no recording

POST
/v1/agents/{agent_id}/chat
curl --request POST \
  --url https://api.vocapable.com/v1/agents/example/chat \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "messages": [ { "role": "user", "content": "example" } ] }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
agent_id
required
Agent Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
AgentChatRequest

The full visible transcript, oldest first, ending with the user’s new message.

object
messages
required
Messages
Array<object>
>= 1 items <= 40 items
AgentChatMessage
object
role
required
Role
string
Allowed values: user assistant
content
required
Content
string
>= 1 characters <= 4000 characters

Responses

Section titled “Responses”

200

Section titled “200”

Server-sent events: delta / guard / proposal / done / problem.

Examplegenerated
example

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}