Open AI (ChatGPT)
🇺🇸 English
  • 🇺🇸 English
  • 🇯🇵 Japanese
  • 🇵🇹 Portuguese
  • 🇰🇷 Korea
  • 🇩🇪 German
  1. Assistants (v1)
Open AI (ChatGPT)
🇺🇸 English
  • 🇺🇸 English
  • 🇯🇵 Japanese
  • 🇵🇹 Portuguese
  • 🇰🇷 Korea
  • 🇩🇪 German
  • README
  • Introduction
  • Authentication
  • Making requests
  • Streaming
  • Debugging requests
  • Backward compatibility
  • Administration
  • Audio
    • Create speech
      POST
    • Create transcription
      POST
    • Create translation
      POST
  • Chat
    • Create chat completion
      POST
  • Embeddings
    • Create embeddings
      POST
  • Fine-tuning
    • Create fine-tuning job
      POST
    • List fine-tuning jobs
      GET
    • List fine-tuning events
      GET
    • List fine-tuning checkpoints
      GET
    • Retrieve fine-tuning job
      GET
    • Cancel fine-tuning
      POST
  • Batch
    • Create batch
    • Retrieve batch
    • Cancel batch
    • List batch
  • Files
    • README
    • Upload file
    • List files
    • Retrieve file
    • Delete file
    • Retrieve file content
  • Uploads
    • Create upload
    • Add upload part
    • Complete upload
  • Images
    • README
    • Create image
    • Create image edit
    • Create image variation
  • Models
    • List models
    • Retrieve model
    • Delete a fine-tuned model
  • Moderations
    • Create moderation
  • Invites
    • List invites
    • Create invite
    • Retrieve invite
    • Delete invite
  • Users
    • List users
    • Modify user
    • Retrieve user
  • Projects
    • List projects
    • Create project
    • Retrieve project
    • Modify project
    • Archive project
  • Project users
    • List project users
    • Create project user
    • Retrieve project user
    • Modify project user
    • Delete project user
    • Create project service account
  • Project service accounts
    • List project service accounts
    • Create project service account
    • Retrieve project service account
    • Delete project service account
  • Project API keys
    • List project API keys
    • Retrieve project API key
    • Delete project API key
  • Project rate limits
    • List project rate limits
    • Modify project rate limit
  • Audit logs
    • List audit logs
  • Usage
    • Completions
    • Embeddings
    • Moderations
    • Images
    • Audio speeches
    • Audio transcriptions
    • Vector stores
    • Code interpreter sessions
    • Costs
  • Completions
    • Create completion
  • Assistants (v1)
    • Create assistant (v1)
      POST
    • Create assistant file (v1)
      POST
    • List assistants (v1)
      GET
    • List assistant files (v1)
      GET
    • Retrieve assistant (v1)
      GET
    • Retrieve assistant file (v1)
      GET
    • Modify assistant (v1)
      POST
    • Delete assistant (v1)
      DELETE
    • Delete assistant file (v1)
      DELETE
  • Threads (v1)
    • Create thread (v1)
    • Retrieve thread (v1)
    • Modify thread (v1)
    • Delete thread (v1)
  • Messages (v1)
    • Create message (v1)
    • List messages (v1)
    • List message files (v1)
    • Retrieve message (v1)
    • Retrieve message file (v1)
    • Modify message (v1)
  • Runs (v1)
    • Create run (v1)
    • Create thread and run (v1)
    • List runs (v1)
    • List run steps (v1)
    • Retrieve run (v1)
    • Retrieve run step (v1)
    • Modify run (v1)
    • Submit tool outputs to run (v1)
    • Cancel a run (v1)
  1. Assistants (v1)

Create assistant (v1)

POST
https://api.openai.com/v1/assistants
Create an assistant with a model and instructions.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.openai.com/v1/assistants' \
--header 'Authorization: Bearer $OPENAI_API_KEY' \
--header 'OpenAI-Beta: assistants=v1' \
--header 'Content-Type: application/json' \
--data-raw '{
    "instructions": "You are a personal math tutor. When asked a question, write and run Python code to answer the question.",
    "name": "Math Tutor",
    "tools": [{"type": "code_interpreter"}],
    "model": "gpt-4-turbo"
  }'
Response Response Example
{
  "id": "asst_abc123",
  "object": "assistant",
  "created_at": 1698984975,
  "name": "Math Tutor",
  "description": null,
  "model": "gpt-4-turbo",
  "instructions": "You are a personal math tutor. When asked a question, write and run Python code to answer the question.",
  "tools": [
    {
      "type": "code_interpreter"
    }
  ],
  "file_ids": [],
  "metadata": {},
  "top_p": 1,
  "temperature": 1,
  "response_format": "auto"
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params
Content-Type
string 
required
Example:
application/json
Authorization
string 
required
Example:
Bearer $OPENAI_API_KEY
OpenAI-Beta
string 
required
Example:
assistants=v1
Body Params application/json
instructions
string 
required
The system instructions that the assistant uses. The maximum length is 256,000 characters.
name
string 
required
The name of the assistant. The maximum length is 256 characters.
tools
array [object {1}] 
required
A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, retrieval, or function.
type
string 
optional
model
string 
required
ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them. type: string
Examples

Responses

🟢200Success
application/json
Body
id
string 
required
object
string 
required
created_at
integer 
required
name
string 
required
description
null 
required
model
string 
required
instructions
string 
required
tools
array [object {1}] 
required
type
string 
optional
file_ids
array[string]
required
metadata
object 
required
top_p
integer 
required
temperature
integer 
required
response_format
string 
required
Modified at 2024-12-12 07:57:34
Previous
Create completion
Next
Create assistant file (v1)
Built with