/ 
OpenAPI-Client-OpenAI-0.20
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}.

See the examples/ directory in the distribution for examples of how to use this.

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:

  • application/json

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:

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

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

Example:

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

Responses

Status Code: 200

OK

Content Types:

  • application/json

    Example:

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

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.