AI Chat

Get AI chat processing status

Poll for the current processing status of an AI chat session. Returns the status (idle, processing, completed, or error) along with any pending question, completed response, or error message.

get/v1/ai/chat/{chat-id}/status

Path parameters

chat-idinteger required

Chat session ID

Response

Status retrieved successfully

status'idle' | 'processing' | 'completed' | 'error'

Current processing state

currentFunctionstring nullable

Name of the function currently being executed by AI (present when status is processing)

responsestring nullable

AI response text (present when status is completed)

errorMessagestring

Error description (present when status is error)

Changes

Changed in 3 of the 115 revisions of this API.13

    • ○

      removed the non-success response with the status

      response-non-success-status-removed

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ▲

      the response's property type changed from no type to object for status

      response-property-type-changed

    • ○

      added to the response property allOf list for the response status

      response-property-all-of-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog