For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact usJoin the Discord
ManualAPI GuideAPI Reference
  • Overview
    • API Reference
    • Client libraries
  • API Reference
      • POSTInitiate Async Chat Stream
      • GETObserve Async Chat Stream Events
      • GETGet Async Chat Stream Status
      • POSTCancel Async Chat Stream
      • DELDelete Async Chat Stream
LogoLogo
Contact usJoin the Discord
API ReferenceAsync Messages

Get Async Chat Stream Status

GET
https://host.com/v1/messages/async/:message_id/status
GET
/v1/messages/async/:message_id/status
$curl https://host.com/v1/messages/async/message_id/status
1{
2  "message_id": "msg_async_12345",
3  "status": "pending",
4  "created_at": "2025-07-10T09:11:16Z",
5  "updated_at": "2025-07-10T09:11:16Z",
6  "completed_at": "2024-01-15T09:30:00Z",
7  "error_message": "error_message",
8  "stream_type": "default",
9  "metadata": {
10    "metadata": {
11      "key": "value"
12    }
13  }
14}
Get the current status and metadata of an asynchronous chat stream. This endpoint returns comprehensive information about a chat stream's current state, including processing status, timestamps, error information, and additional metadata collected during processing. Status Values: - pending: Stream created but processing not yet started - processing: Active processing with events being generated - completed: Stream finished successfully - cancelled: Stream was cancelled by user request - error: Stream encountered an error and stopped Use Cases: - Monitor stream progress without consuming events - Check completion status before attempting to observe - Debugging failed streams via error messages - Performance monitoring through metadata
Was this page helpful?
Previous

Cancel Async Chat Stream

Next
Built with

Get the current status and metadata of an asynchronous chat stream.

This endpoint returns comprehensive information about a chat stream’s current state, including processing status, timestamps, error information, and additional metadata collected during processing.

Status Values:

  • pending: Stream created but processing not yet started
  • processing: Active processing with events being generated
  • completed: Stream finished successfully
  • cancelled: Stream was cancelled by user request
  • error: Stream encountered an error and stopped

Use Cases:

  • Monitor stream progress without consuming events
  • Check completion status before attempting to observe
  • Debugging failed streams via error messages
  • Performance monitoring through metadata

Path parameters

message_idstringRequired
Message ID of the asynchronous chat stream to check status for.

Response

This endpoint returns an object.
message_idstring
Unique identifier for the stream
statusenum
Current status of the stream
created_atdatetime
Timestamp when the stream was created
updated_atdatetime
Timestamp when the stream was last updated
completed_atdatetime
Timestamp when the stream was completed, if applicable
error_messagestring
Error message if the stream encountered an error
stream_typestringDefaults to default
Type of the stream, used for categorization
metadatamap from strings to any
Additional metadata associated with the stream

Errors

401
Unauthorized
404
Not Found
422
Unprocessable Entity