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

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