API Reference
API Reference

Agent Version

GET/api/v1/agents/{agent_id}/history/{version}

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Path parameters

agent_id integer path required
version integer path required

Responses

200Successful Response

application/json

response AgentHistoryResponse required
6 fields
agent_idintegerrequired
version_numberintegerrequired
created_atstring (date-time)required
updated_bystringrequired
commentsstring | nullrequired
configurationobjectrequired

Saved Agent settings and resource references, without joined live resources. Legacy JSON fields are decoded without applying current Agent save validation.

Response example
{
  "agent_id": 0,
  "version_number": 0,
  "created_at": "string",
  "updated_by": "string",
  "comments": "string",
  "configuration": "string"
}
403Agent read permission required

application/json

response AgentErrorResponse required
1 field
detailstringrequired
Response example
{
  "detail": "string"
}
404Agent or version not found

application/json

response AgentErrorResponse required
1 field
detailstringrequired
Response example
{
  "detail": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}