Assistant

API reference descriptions are provided in English to preserve the exact published contract.

GETThe AI assistant's settingsassistant.list
PUTSet the AI assistant: on or off, what the business is, tone, hand-offassistant.update
GETThe knowledge base the assistant answers fromassistant.articles.list
POSTAdd a knowledge articleassistant.articles.create
DELETERemove a knowledge articleassistant.articles.delete
PUTPause or explicitly resume automatic AI replies for one conversationassistant.conversations.update
POSTDraft a reply to a conversation from the knowledge base (does not send)assistant.draft

The AI assistant's settings

GET/v1/accounts/{AC}/assistant

assistant.listSDK operation getV1AccountsByAcAssistant

Required scope: inboxes:read.

GET /v1/accounts/{AC}/assistant

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/assistant" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Set the AI assistant: on or off, what the business is, tone, hand-off

PUT/v1/accounts/{AC}/assistant

assistant.updateSDK operation putV1AccountsByAcAssistant

Required scope: inboxes:write.Idempotency-Key required

Request body

businessSummarystring (max 2000 chars)Required
enabledbooleanRequired
handoffInboxSidstring (IB… SID) | nullRequired
handoffMessagestring (max 1000 chars)Required
languagestring (max 16 chars)Required
neverAnswerstring (max 120 chars)[]Required
toneenumRequired
FRIENDLYFORMALBRIEF

PUT /v1/accounts/{AC}/assistant

curl -X PUT "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/assistant" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "businessSummary": "string",
  "enabled": true,
  "handoffInboxSid": "IB...",
  "handoffMessage": "string",
  "language": "string",
  "neverAnswer": [],
  "tone": "FRIENDLY"
}'

Responses

The knowledge base the assistant answers from

GET/v1/accounts/{AC}/assistant/articles

assistant.articles.listSDK operation getV1AccountsByAcAssistantArticles

Required scope: inboxes:read.

GET /v1/accounts/{AC}/assistant/articles

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/assistant/articles" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Add a knowledge article

POST/v1/accounts/{AC}/assistant/articles

assistant.articles.createSDK operation postV1AccountsByAcAssistantArticles

Required scope: inboxes:write.Idempotency-Key required

Request body

bodystring (max 8000 chars)Required
titlestring (max 200 chars)Required

POST /v1/accounts/{AC}/assistant/articles

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/assistant/articles" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "string",
  "title": "string"
}'

Responses

Remove a knowledge article

DELETE/v1/accounts/{AC}/assistant/articles/{KA}

assistant.articles.deleteSDK operation deleteV1AccountsByAcAssistantArticlesByKa

Required scope: inboxes:write.

Parameters

KAstring (KA… SID)Required

DELETE /v1/accounts/{AC}/assistant/articles/{KA}

curl -X DELETE "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/assistant/articles/KA..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Pause or explicitly resume automatic AI replies for one conversation

PUT/v1/accounts/{AC}/assistant/conversations/{CO}

assistant.conversations.updateSDK operation putV1AccountsByAcAssistantConversationsByCo

Required scope: conversations:write.Idempotency-Key required

Inbox and dashboard sessions

Alternatively, a normal tenant USER session may use conversations:write on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.

Parameters

COstring (CO… SID)Required

Request body

conversationVersioninteger (1–)Required
pausedbooleanRequired

PUT /v1/accounts/{AC}/assistant/conversations/{CO}

curl -X PUT "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/assistant/conversations/CO..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "conversationVersion": 1,
  "paused": true
}'

Responses

Draft a reply to a conversation from the knowledge base (does not send)

POST/v1/accounts/{AC}/assistant/draft

assistant.draftSDK operation postV1AccountsByAcAssistantDraft

Required scope: conversations:write.Idempotency-Key required

Request body

conversationSidstring (CO… SID)Required
dataUseConsenttrueRequired
Explicitly authorize this one AI draft request to send the conversation and matching knowledge articles to the configured model provider. This is separate from automatic reply settings.

POST /v1/accounts/{AC}/assistant/draft

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/assistant/draft" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "conversationSid": "CO...",
  "dataUseConsent": "string"
}'

Responses