Manage assistants

This page shows you how to view a list of assistants, check the status of an assistant, update an assistant, and delete an assistant.

​

List assistants for a project

Use the list_assistants operation to get the name, status, and metadata for each Assistant in your project as in the following example:

This operation returns a response like the following:

{
  "assistants": [
    {
      "name": "example-assistant",
      "instructions": "You are ABC company's assistant and are extremely polite.",
      "metadata": {},
      "status": "Initializing",
      "created_on": "2023-11-07T05:31:56Z",
      "updated_on": "2023-11-07T05:31:56Z"
    }
  ]
}

You can use the name value to check the status of an assistant.

​

Get the status of an assistant

Use the get_assistant operation to get the status and metadata for your assistant as in the following example:

This operation returns a response like the following:

{
  "name": "example-assistant",
  "instructions": "You are ABC company's assistant and are extremely polite.",
  "metadata": {},
  "status": "Initializing",
  "created_on": "2023-11-07T05:31:56Z",
  "updated_on": "2023-11-07T05:31:56Z"
}

The status field has the following possible values:

• Initializing
• Failed
• Ready
• Terminating

​

Update an existing assistant

Use the update_assistant operation to update the instructions for an existing assistant. Instructions are a short description or directive for the assistant to apply to all of its responses. For example, you can update the instructions to reflect the assistant’s role or purpose.

For example:

The example above returns a result like the following:

{
    "name":"example-assistant",
    "instructions":"You are ABC company's assistant and are extremely polite",
    "metadata":{"updated":"2024-09-30"},
    "status":"Ready",
    "created_at":"2024-06-14T14:58:06.573004549Z","updated_at":"2024-10-01T19:44:32.813235817Z"
}

​

Delete an assistant

Use the delete_assistant operation to delete an assistant.