Sample - OpenAI API
POST/threads

Create a thread

Creates a thread for storing messages and tool resources. Supply messages to populate the thread initially, or create an empty thread for use in a later run. The response returns the new thread identifier, creation timestamp, tool resources, and metadata.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 body fields

Optional thread creation options containing initial messages, tool resources, and metadata.

messagesarray<object>optional
A list of [messages](https://developers.openai.com/api/docs/assistants/migration) to start the thread with.
tool_resourcesobjectoptional
Resources made available to thread tools, such as code interpreter file IDs or file search vector store IDs.
metadataobjectoptional
Key-value metadata attached to the thread. Keys must be no longer than 64 characters and values must be strings.

2 status codes
200Returns the created thread object with its identifier, `thread` object type, creation timestamp, tool resources, and metadata.
idstringrequired
The identifier, which can be referenced in API endpoints.
objectstringrequired
The object type, which is always `thread`.
Allowed:thread
created_atintegerrequired
The Unix timestamp (in seconds) for when the thread was created.
tool_resourcesobjectrequired
A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.
metadataobjectrequired
Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
429Returned when the request exceeds the rate limit.
errorobjectrequired

Error handling

A 429 is returned when the request exceeds the rate limit. Each message must include role and content, and role must be user or assistant. When supplied, message metadata values must be strings and metadata keys must not exceed 64 characters.