=encoding utf8
=head1 NAME
OpenAPI::Client::OpenAI::Path::assistants-assistant_id - Documentation for the /assistants/{assistant_id} path.
=head1 DESCRIPTION
This document describes the API endpoint at C</assistants/{assistant_id}>.
=head1 PATHS
=head2 C<DELETE /assistants/{assistant_id}>
Delete an assistant.
=head3 Operation ID
C<deleteAssistant>
$client->deleteAssistant( ... );
=head3 Parameters
=over 4
=item * C<assistant_id> (in path) (Required) - The ID of the assistant to delete.
Type: C<string>
=back
=head3 Responses
=head4 Status Code: C<200>
OK
=head4 Content Types:
=over 4
=item * C<application/json>
Example (See the L<OpenAI spec for more detail|https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):
=back
=head2 C<GET /assistants/{assistant_id}>
Retrieves an assistant.
=head3 Operation ID
C<getAssistant>
$client->getAssistant( ... );
=head3 Parameters
=over 4
=item * C<assistant_id> (in path) (Required) - The ID of the assistant to retrieve.
Type: C<string>
=back
=head3 Responses
=head4 Status Code: C<200>
OK
=head4 Content Types:
=over 4
=item * C<application/json>
Example (See the L<OpenAI spec for more detail|https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):
{
"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"
}
=back
=head2 C<POST /assistants/{assistant_id}>
Modifies an assistant.
=head3 Operation ID
C<modifyAssistant>
$client->modifyAssistant( ... );
=head3 Parameters
=over 4
=item * C<assistant_id> (in path) (Required) - The ID of the assistant to modify.
Type: C<string>
=back
=head3 Request Body
=head3 Content Type: C<application/json>
=head4 Models
ID of the model to use. You can use the L<List models|https://platform.openai.com/docs/api-reference/models/list> API to see all of your available models, or see our L<Model overview|https://platform.openai.com/docs/models> for descriptions of them.
=over 4
=item * C<o3-mini>
=item * C<o3-mini-2025-01-31>
=item * C<o1>
=item * C<o1-2024-12-17>
=item * C<gpt-4o>
=item * C<gpt-4o-2024-11-20>
=item * C<gpt-4o-2024-08-06>
=item * C<gpt-4o-2024-05-13>
=item * C<gpt-4o-mini>
=item * C<gpt-4o-mini-2024-07-18>
=item * C<gpt-4.5-preview>
=item * C<gpt-4.5-preview-2025-02-27>
=item * C<gpt-4-turbo>
=item * C<gpt-4-turbo-2024-04-09>
=item * C<gpt-4-0125-preview>
=item * C<gpt-4-turbo-preview>
=item * C<gpt-4-1106-preview>
=item * C<gpt-4-vision-preview>
=item * C<gpt-4>
=item * C<gpt-4-0314>
=item * C<gpt-4-0613>
=item * C<gpt-4-32k>
=item * C<gpt-4-32k-0314>
=item * C<gpt-4-32k-0613>
=item * C<gpt-3.5-turbo>
=item * C<gpt-3.5-turbo-16k>
=item * C<gpt-3.5-turbo-0613>
=item * C<gpt-3.5-turbo-1106>
=item * C<gpt-3.5-turbo-0125>
=item * C<gpt-3.5-turbo-16k-0613>
=back
Example:
{
"temperature" : 1,
"tool_resources" : {
"code_interpreter" : {
"file_ids" : [
null
]
},
"file_search" : {
"vector_store_ids" : [
null
]
}
},
"tools" : [
null
],
"top_p" : 1
}
=head3 Responses
=head4 Status Code: C<200>
OK
=head4 Content Types:
=over 4
=item * C<application/json>
Example (See the L<OpenAI spec for more detail|https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):
{
"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"
}
=back
=head1 SEE ALSO
L<OpenAPI::Client::OpenAI::Path>
=head1 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.
=cut