API Reference

Beta

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Assistants

Build Assistants that can call models and use tools.

Create assistant

Deprecated

beta.assistants.create(**kwargs) -> Assistant { id, created_at, description, 10 more }

POST/assistants

Delete assistant

Deprecated

beta.assistants.delete(assistant_id) -> AssistantDeleted { id, deleted, object }

DELETE/assistants/{assistant_id}

List assistants

Deprecated

beta.assistants.list(**kwargs) -> CursorPage<Assistant { id, created_at, description, 10 more } >

GET/assistants

Retrieve assistant

Deprecated

beta.assistants.retrieve(assistant_id) -> Assistant { id, created_at, description, 10 more }

GET/assistants/{assistant_id}

Modify assistant

Deprecated

beta.assistants.update(assistant_id, **kwargs) -> Assistant { id, created_at, description, 10 more }

POST/assistants/{assistant_id}

ModelsExpand Collapse

class Assistant { id, created_at, description, 10 more }

Represents an assistant that can call the model and use tools.

class AssistantDeleted { id, deleted, object }

AssistantStreamEvent = ThreadCreated{ data, event, enabled} | ThreadRunCreated{ data, event} | ThreadRunQueued{ data, event} | 21 more

Represents an event emitted when streaming a Run.

Each event in a server-sent events stream has 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 Assistants API quickstart to learn how to integrate the Assistants API with streaming.

AssistantTool = CodeInterpreterTool { type } | FileSearchTool { type, file_search } | FunctionTool { function, type }

class CodeInterpreterTool { type }

class FileSearchTool { type, file_search }

class FunctionTool { function, type }

MessageStreamEvent = ThreadMessageCreated{ data, event} | ThreadMessageInProgress{ data, event} | ThreadMessageDelta{ data, event} | 2 more

Occurs when a message is created.

RunStepStreamEvent = ThreadRunStepCreated{ data, event} | ThreadRunStepInProgress{ data, event} | ThreadRunStepDelta{ data, event} | 4 more

Occurs when a run step is created.

RunStreamEvent = ThreadRunCreated{ data, event} | ThreadRunQueued{ data, event} | ThreadRunInProgress{ data, event} | 7 more

Occurs when a new run is created.

class ThreadStreamEvent { data, event, enabled }

Occurs when a new thread is created.