Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agentId
string
required

The Suppio agent ID. The bearer API key must be scoped to this same agent.

Example:

"agent_123"

Body

application/json
message
string
required

The support message. Empty messages are rejected. Input is capped at 12,000 characters after trimming.

Required string length: 1 - 12000
Example:

"How do I reset my password?"

attachments
object[]

Optional base64-encoded image inputs. Images count toward input tokens and Suppio credit usage.

Maximum array length: 5
tools
object[]

Optional caller-defined action-signal tools for this request. Up to 10 tools are allowed. Each parameters schema is limited to 16 KB, and the complete tools array is limited to 64 KB.

Maximum array length: 10

Response

The request was processed. Check outcome for success or blocked.

outcome
enum<string>
required
Available options:
success,
blocked
response
string
required
actions
object[]
required
tool_calls
object[]
required

Caller-defined tool calls recorded during the agent run. Blocked responses return an empty array.

usage
object
required