ReferenceAgents, threads and templates
Rename, describe, or turn an agent on or off (its owner; team editors and above)
PATCH
Turning an agent off hibernates it and refuses new work; its conversations are kept.
agentId*stringFormat
uuidIf-Match*stringThe resource's revision, as returned in ETag (for example "3"). Missing returns 428; stale returns 412.
application/json- body
name?stringLength
length <= 100description?stringLength
length <= 2000enabled?booleantemplateVersion?integerMove to another version of the template (upgrade or roll back); applies when the agent next starts
Format
int32modelId?stringA model published to the team, or "" for its template's; applies when the agent next starts
Updated
application/json- response
data*curl -X PATCH 'https://agents.example.com/v1/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'If-Match: string' \ -H 'Content-Type: application/json' \ -d '{}'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec", "teamSlug": "string", "teamName": "string", "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d", "templateSlug": "string", "templateName": "string", "templateVersion": 0, "templateCurrentVersion": 0, "externalKey": "string", "enabled": true, "running": true, "model": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "providerName": "string", "source": "agent", "available": true }, "lastUsedAt": "2019-08-24T14:15:22Z", "revision": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}