Assistants
- GETList assistants
- POSTCreate assistant
- GETRetrieve assistant
- POSTModify assistant
- DELDelete assistant
- POSTCreate thread
- POSTCreate thread and run
- GETRetrieve thread.
- POSTModify thread
- DELDelete thread
- GETList messages
- POSTCreate message
- GETRetrieve message
- POSTModify message
- DELDelete message
- GETList runs
- POSTCreate run
- GETRetrieve run
- POSTModify run
- POSTCancel run
- GETList run steps
- GETRetrieve run step
- POSTThe run step object
Chat
Completions
Embeddings
Evals
Files
Fine-tuning
- GETList checkpoint permissions
- POSTCreate checkpoint permissions
- DELDelete checkpoint permission
- GETList your organization's fine-tuning jobs
- POSTCreate a fine-tuning job
- GETRetrieve fine-tuning job
- POSTImmediately cancel a fine-tune job.
- GETList checkpoints for a fine-tuning job.
- GETGet status updates for a fine-tuning job.
Moderations
API Reference
Audit Logs
Certificates
Usage
Projects
- GETReturns a list of projects.
- POSTCreate project
- GETRetrieves a project.
- POSTModify project
- GETList project API keys
- GETRetrieve project API key
- DELDelete project API key
- POSTArchive project
- GETList project rate limits
- POSTUpdate project rate limit
- GETList project service accounts
- POSTCreate project service account
- GETRetrieve project service account
- DELDelete project service account
- GETReturn project users
- POSTCreate project user
- GETRetrieve project user
- POSTModify project user
- DELDelete project user
Responses
Vector stores
- GETReturns a list of vector stores.
- POSTCreate a vector store.
- GETRetrieves a vector store.
- POSTModifies a vector store.
- DELDelete a vector store.
- POSTCreate a vector store file batch.
- GETRetrieves a vector store file batch.
- POSTCancel vector store file batch
- GETReturns a list of vector store files in a batch.
- GETReturns a list of vector store files.
- POSTCreate vector store file
- GETRetrieves a vector store file.
- POSTUpdate attributes on a vector store file.
- DELDelete vector store file
- GETRetrieve vector store
- POSTSearch vector store
Assistants
Retrieve assistant
Retrieves an assistant.
GET
/
assistants
/
{assistant_id}
Copy
Ask AI
curl --request GET \
--url https://api.openai.com/v1/assistants/{assistant_id} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"id": "<string>",
"object": "assistant",
"created_at": 123,
"name": "<string>",
"description": "<string>",
"model": "<string>",
"instructions": "<string>",
"tools": [],
"tool_resources": {
"code_interpreter": {
"file_ids": []
},
"file_search": {
"vector_store_ids": [
"<string>"
]
}
},
"metadata": {},
"temperature": 1,
"top_p": 1,
"response_format": "auto"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The ID of the assistant to retrieve.
Response
200 - application/json
OK
Represents an assistant
that can call the model and use tools.
Was this page helpful?
Copy
Ask AI
curl --request GET \
--url https://api.openai.com/v1/assistants/{assistant_id} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"id": "<string>",
"object": "assistant",
"created_at": 123,
"name": "<string>",
"description": "<string>",
"model": "<string>",
"instructions": "<string>",
"tools": [],
"tool_resources": {
"code_interpreter": {
"file_ids": []
},
"file_search": {
"vector_store_ids": [
"<string>"
]
}
},
"metadata": {},
"temperature": 1,
"top_p": 1,
"response_format": "auto"
}
Assistant
Responses are generated using AI and may contain mistakes.