Skip to main content
POST
/
v1
/
agents
/
{agentId}
/
responses
Create an agent response
curl --request POST \
  --url https://api.suppio.ai/v1/agents/{agentId}/responses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "How do I reset my password?"
}
'
{
  "outcome": "success",
  "response": "You can reset your password from Account Settings.",
  "actions": [
    {
      "type": "mark_resolved",
      "reason": "The request was fully answered."
    }
  ],
  "usage": {
    "credits": 12,
    "tokens": 1234
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.suppio.ai/llms.txt

Use this file to discover all available pages before exploring further.

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?"

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
​
usage
object
required