/ 
OpenAPI-Client-OpenAI-0.21
River stage zero No dependents
/ OpenAPI::Client::OpenAI::Path::assistants-assistant_id

NAME

OpenAPI::Client::OpenAI::Path::assistants-assistant_id - Documentation for the /assistants/{assistant_id} path.

DESCRIPTION

This document describes the API endpoint at /assistants/{assistant_id}.

PATHS

DELETE /assistants/{assistant_id}

Delete an assistant.

Operation ID

deleteAssistant

$client->deleteAssistant( ... );

Parameters

  • assistant_id (in path) (Required) - The ID of the assistant to delete.

    Type: string

Responses

Status Code: 200

OK

Content Types:

GET /assistants/{assistant_id}

Retrieves an assistant.

Operation ID

getAssistant

$client->getAssistant( ... );

Parameters

  • assistant_id (in path) (Required) - The ID of the assistant to retrieve.

    Type: string

Responses

Status Code: 200

OK

Content Types:

  • application/json

    Example (See the OpenAI spec for more detail):

    {
  "id": "asst_abc123",
  "object": "assistant",
  "created_at": 1698984975,
  "name": "Math Tutor",
  "description": null,
  "model": "gpt-4o",
  "instructions": "You are a personal math tutor. When asked a question, write and run Python code to answer the question.",
  "tools": [
    {
      "type": "code_interpreter"
    }
  ],
  "metadata": {},
  "top_p": 1.0,
  "temperature": 1.0,
  "response_format": "auto"
}

POST /assistants/{assistant_id}

Modifies an assistant.

Operation ID

modifyAssistant

$client->modifyAssistant( ... );

Parameters

  • assistant_id (in path) (Required) - The ID of the assistant to modify.

    Type: string

Request Body

Content Type: application/json

Models

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.

  • o3-mini

  • o3-mini-2025-01-31

  • o1

  • o1-2024-12-17

  • gpt-4o

  • gpt-4o-2024-11-20

  • gpt-4o-2024-08-06

  • gpt-4o-2024-05-13

  • gpt-4o-mini

  • gpt-4o-mini-2024-07-18

  • gpt-4.5-preview

  • gpt-4.5-preview-2025-02-27

  • gpt-4-turbo

  • gpt-4-turbo-2024-04-09

  • gpt-4-0125-preview

  • gpt-4-turbo-preview

  • gpt-4-1106-preview

  • gpt-4-vision-preview

  • gpt-4

  • gpt-4-0314

  • gpt-4-0613

  • gpt-4-32k

  • gpt-4-32k-0314

  • gpt-4-32k-0613

  • gpt-3.5-turbo

  • gpt-3.5-turbo-16k

  • gpt-3.5-turbo-0613

  • gpt-3.5-turbo-1106

  • gpt-3.5-turbo-0125

  • gpt-3.5-turbo-16k-0613

Example:

{
   "temperature" : 1,
   "tool_resources" : {
      "code_interpreter" : {
         "file_ids" : [
            null
         ]
      },
      "file_search" : {
         "vector_store_ids" : [
            null
         ]
      }
   },
   "tools" : [
      null
   ],
   "top_p" : 1
}

Responses

Status Code: 200

OK

Content Types:

  • application/json

    Example (See the OpenAI spec for more detail):

    {
  "id": "asst_abc123",
  "object": "assistant",
  "created_at": 1698984975,
  "name": "Math Tutor",
  "description": null,
  "model": "gpt-4o",
  "instructions": "You are a personal math tutor. When asked a question, write and run Python code to answer the question.",
  "tools": [
    {
      "type": "code_interpreter"
    }
  ],
  "metadata": {},
  "top_p": 1.0,
  "temperature": 1.0,
  "response_format": "auto"
}

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.