AI/ML API Documentation
API KeyModelsPlaygroundGitHubGet Support
  • 📞Contact Sales
  • 🗯️Send Feedback
  • Quickstart
    • 🧭Documentation Map
    • Setting Up
    • Supported SDKs
  • API REFERENCES
    • 📒All Model IDs
    • Text Models (LLM)
      • Alibaba Cloud
        • qwen-max
        • qwen-plus
        • qwen-turbo
        • Qwen2-72B-Instruct
        • Qwen2.5-7B-Instruct-Turbo
        • Qwen2.5-72B-Instruct-Turbo
        • Qwen2.5-Coder-32B-Instruct
        • Qwen-QwQ-32B
        • Qwen3-235B-A22B
      • Anthracite
        • magnum-v4
      • Anthropic
        • Claude 3 Haiku
        • Claude 3.5 Haiku
        • Claude 3 Opus
        • Claude 3 Sonnet
        • Claude 3.5 Sonnet
        • Claude 3.7 Sonnet
      • Cohere
        • command-r-plus
      • DeepSeek
        • DeepSeek V3
        • DeepSeek R1
        • DeepSeek Prover V2
      • Google
        • gemini-1.5-flash
        • gemini-1.5-pro
        • gemini-2.0-flash-exp
        • gemini-2.0-flash
        • gemini-2.5-flash-preview
        • gemini-2.5-pro-exp
        • gemini-2.5-pro-preview
        • gemma-2
        • gemma-3
      • Gryphe
        • MythoMax-L2-13b-Lite
      • Meta
        • Llama-3-chat-hf
        • Llama-3-8B-Instruct-Lite
        • Llama-3.1-8B-Instruct-Turbo
        • Llama-3.1-70B-Instruct-Turbo
        • Llama-3.1-405B-Instruct-Turbo
        • Llama-3.2-11B-Vision-Instruct-Turbo
        • Llama-3.2-90B-Vision-Instruct-Turbo
        • Llama-Vision-Free
        • Llama-3.2-3B-Instruct-Turbo
        • Llama-3.3-70B-Instruct-Turbo
        • Llama-4-scout
        • Llama-4-maverick
      • MiniMax
        • text-01
        • abab6.5s-chat
      • Mistral AI
        • codestral-2501
        • mistral-nemo
        • mistral-tiny
        • Mistral-7B-Instruct
        • Mixtral-8x22B-Instruct
        • Mixtral-8x7B-Instruct
      • NVIDIA
        • Llama-3.1-Nemotron-70B-Instruct-HF
        • llama-3.1-nemotron-70b
      • NeverSleep
        • llama-3.1-lumimaid
      • NousResearch
        • Nous-Hermes-2-Mixtral-8x7B-DPO
      • OpenAI
        • gpt-3.5-turbo
        • gpt-4
        • gpt-4-preview
        • gpt-4-turbo
        • gpt-4o
        • gpt-4o-mini
        • gpt-4o-audio-preview
        • gpt-4o-mini-audio-preview
        • gpt-4o-search-preview
        • gpt-4o-mini-search-preview
        • o1
        • o1-mini
        • o1-preview
        • o3-mini
        • gpt-4.5-preview
        • gpt-4.1
        • gpt-4.1-mini
        • gpt-4.1-nano
        • o4-mini
      • xAI
        • grok-beta
        • grok-3-beta
        • grok-3-mini-beta
    • Image Models
      • Flux
        • flux-pro
        • flux-pro/v1.1
        • flux-pro/v1.1-ultra
        • flux-realism
        • flux/dev
        • flux/dev/image-to-image
        • flux/schnell
      • Google
        • Imagen 3
        • Imagen 4 Preview
      • OpenAI
        • DALL·E 2
        • DALL·E 3
      • RecraftAI
        • Recraft v3
      • Stability AI
        • Stable Diffusion v3 Medium
        • Stable Diffusion v3.5 Large
    • Video Models
      • Alibaba Cloud
        • Wan 2.1 (Text-to-Video)
      • Google
        • Veo2 (Image-to-Video)
        • Veo2 (Text-to-Video)
      • Kling AI
        • v1-standard/image-to-video
        • v1-standard/text-to-video
        • v1-pro/image-to-video
        • v1-pro/text-to-video
        • v1.6-standard/text-to-video
        • v1.6-standard/image-to-video
        • v1.6-pro/image-to-video
        • v1.6-pro/text-to-video
        • v1.6-standard/effects
        • v1.6-pro/effects
        • v2-master/image-to-video
        • v2-master/text-to-video
      • Luma AI
        • Text-to-Video v2
        • Text-to-Video v1 (legacy)
      • MiniMax
        • video-01
        • video-01-live2d
      • Runway
        • gen3a_turbo
        • gen4_turbo
    • Music Models
      • MiniMax
        • minimax-music [legacy]
        • music-01
      • Stability AI
        • stable-audio
    • Voice/Speech Models
      • Speech-to-Text
        • stt [legacy]
        • Deepgram
          • nova-2
        • OpenAI
          • whisper-base
          • whisper-large
          • whisper-medium
          • whisper-small
          • whisper-tiny
      • Text-to-Speech
        • Deepgram
          • aura
    • Content Moderation Models
      • Meta
        • Llama-Guard-3-11B-Vision-Turbo
        • LlamaGuard-2-8b
        • Meta-Llama-Guard-3-8B
    • 3D-Generating Models
      • Stability AI
        • triposr
    • Vision Models
      • Image Analysis
      • OCR: Optical Character Recognition
        • Google
          • Google OCR
        • Mistral AI
          • mistral-ocr-latest
      • OFR: Optical Feature Recognition
    • Embedding Models
      • Anthropic
        • voyage-2
        • voyage-code-2
        • voyage-finance-2
        • voyage-large-2
        • voyage-large-2-instruct
        • voyage-law-2
        • voyage-multilingual-2
      • BAAI
        • bge-base-en
        • bge-large-en
      • Google
        • textembedding-gecko
        • text-multilingual-embedding-002
      • OpenAI
        • text-embedding-3-large
        • text-embedding-3-small
        • text-embedding-ada-002
      • Together AI
        • m2-bert-80M-retrieval
  • Solutions
    • Bagoodex
      • AI Search Engine
        • Find Links
        • Find Images
        • Find Videos
        • Find the Weather
        • Find a Local Map
        • Get a Knowledge Structure
    • OpenAI
      • Assistants
        • Assistant API
        • Thread API
        • Message API
        • Run and Run Step API
        • Events
  • Use Cases
    • Create Images: Illustrate an Article
    • Animate Images: A Children’s Encyclopedia
    • Create an Assistant to Discuss a Specific Document
    • Create a 3D Model from an Image
    • Create a Looped GIF for a Web Banner
    • Read Text Aloud and Describe Images: Support People with Visual Impairments
    • Find Relevant Answers: Semantic Search with Text Embeddings
    • Summarize Websites with AI-Powered Chrome Extension
  • Capabilities
    • Completion and Chat Completion
    • Streaming Mode
    • Code Generation
    • Thinking / Reasoning
    • Function Calling
    • Vision in Text Models (Image-To-Text)
    • Web Search
    • Features of Anthropic Models
    • Model comparison
  • FAQ
    • Can I use API in Python?
    • Can I use API in NodeJS?
    • What are the Pro Models?
    • How to use the Free Tier?
    • Are my requests cropped?
    • Can I call API in the asynchronous mode?
    • OpenAI SDK doesn't work?
  • Errors and Messages
    • General Info
    • Errors with status code 4xx
    • Errors with status code 5xx
  • Glossary
    • Concepts
  • Integrations
    • 🧩Our Integration List
    • Cline
    • Langflow
    • LiteLLM
    • Roo Code
Powered by GitBook
On this page
  • Assistant stream events
  • Event list
  • Errors that may occur while working with Assistants

Was this helpful?

  1. Solutions
  2. OpenAI
  3. Assistants

Events

PreviousRun and Run Step APINextCreate Images: Illustrate an Article

Last updated 1 month ago

Was this helpful?

Assistant stream events

During the execution of Runs with , a series of events occur sequentially, allowing you to track the current step in processing user Messages by the Assistant, as well as the statuses of the previously completed steps.

Every event in a server-sent events stream includes an event and data property:

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

We emit events whenever a new object is created, transitions to a new state, or is being streamed in parts (deltas). For example, we emit thread.run.created when a new Run is created, thread.run.completed when a Run completes, and so on. When an Assistant chooses to create a Message during a Run, we emit a thread.message.created event, a thread.message.in_progress event, many thread.message.delta events, and finally a thread.message.completed event.

We may add additional events over time, so we recommend handling unknown events gracefully in your code. See the to learn how to integrate the Assistants API with streaming.

Event list

Event name
Content of the 'data' parameter
When occurs

done

[DONE]

Occurs when a stream ends.

error

an error object

Occurs when an error occurs. This can happen due to an internal server error or a timeout.

thread.created

a Thread object

Occurs when a new Thread is created.

thread.message.completed

a Message object

Occurs when a Message is completed.

thread.message.created

a Message object

Occurs when a Message is created.

thread.message.delta

a Message delta

Occurs when parts of a Message are being streamed.

thread.message.in_progress

a Message object

Occurs when a Message moves to an in_progress state.

thread.message.incomplete

a Message object

Occurs when a Message ends before it is completed.

thread.run.cancelled

a Run object

Occurs when a Run is cancelled.

thread.run.cancelling

a Run object

Occurs when a Run moves to a cancelling status.

thread.run.completed

a Run object

Occurs when a Run is completed.

thread.run.created

a Run object

Occurs when a new Run is created.

thread.run.expired

a Run object

Occurs when a Run expires.

thread.run.failed

a Run object

Occurs when a Run fails.

thread.run.in_progress

a Run object

Occurs when a Run moves to an in_progress status.

thread.run.incomplete

a Run object

Occurs when a Run ends with status incomplete.

thread.run.queued

a Run object

Occurs when a Run moves to a queued status.

thread.run.requires_action

a Run object

Occurs when a Run moves to a requires_action status.

thread.run.step.cancelled

a Run step object

Occurs when a Run step is cancelled.

thread.run.step.completed

a Run step object

Occurs when a Run step is completed.

thread.run.step.created

a Run step object

Occurs when a Run step is created.

thread.run.step.delta

a Run step delta object

Occurs when parts of a Run step are being streamed.

thread.run.step.expired

a Run step object

Occurs when a Run step expires.

thread.run.step.failed

a Run step object

Occurs when a Run step fails.

thread.run.step.in_progress

a Run step object

Occurs when a Run step moves to an in_progress state.

Errors that may occur while working with Assistants

Code
Overview

401 - Invalid Authentication

Cause: Invalid Authentication Solution: Ensure the correct AIML API key and requesting organization are being used.

401 - Incorrect API key provided

403 - Country, region, or territory not supported

429 - Rate limit reached for requests

429 - You exceeded your current quota, please check your plan and billing details

500 - The server had an error while processing your request

Cause: Issue on our servers. Solution: Retry your request after a brief wait and contact us if the issue persists.

503 - The engine is currently overloaded, please try again later

Cause: Our servers are experiencing high traffic. Solution: Please retry your requests after a brief wait.

503 - Slow Down

Cause: A sudden increase in your request rate is impacting service reliability. Solution: Please reduce your request rate to its original level, maintain a consistent rate for at least 15 minutes, and then gradually increase it.

Cause: The requesting AIML API key is not correct. Solution: Ensure the AIML API key used is correct, clear your browser cache, or .

Cause: You are accessing the API from an unsupported country, region, or territory. Solution: Please see for more information.

Cause: You are sending requests too quickly. Solution: Pace your requests. Read the OpenAI .

Cause: You have run out of credits or hit your maximum monthly spend. Solution: Buy more credits or learn how to increase your limits on inside your personal account on the AI/ML API website.

generate a new key
the complete list of supported countries by OpenAI
Rate limit guide
the billing page
this guide