Sign in
asyncMessages

Get Async Chat Stream Status

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
get/v1/messages/async/{message_id}/status

Path parameters

message_idstring required

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

Response

Stream status and metadata information

message_idstring required

Unique identifier for the stream

status'pending' | 'processing' | 'completed' | 'failed' | 'cancelled' | 'error' required

Enumeration of possible stream statuses.

created_atstring date-time required

Timestamp when the stream was created

updated_atstring date-time required

Timestamp when the stream was last updated

completed_atstring date-time nullable

Timestamp when the stream was completed, if applicable

error_messagestring nullable

Error message if the stream encountered an error

stream_typestring

Type of the stream, used for categorization

metadataobject

Additional metadata associated with the stream

Changes