=encoding utf8
=head1 NAME
OpenAPI::Client::OpenAI::Path::threads-thread_id - Documentation for the /threads/{thread_id} path.
=head1 DESCRIPTION
This document describes the API endpoint at C</threads/{thread_id}>.
=head1 PATHS
=head2 C<DELETE /threads/{thread_id}>
Delete a thread.
=head3 Operation ID
C<deleteThread>
$client->deleteThread( ... );
=head3 Parameters
=over 4
=item * C<thread_id> (in path) (Required) - The ID of the thread 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 /threads/{thread_id}>
Retrieves a thread.
=head3 Operation ID
C<getThread>
$client->getThread( ... );
=head3 Parameters
=over 4
=item * C<thread_id> (in path) (Required) - The ID of the thread 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": "thread_abc123",
"object": "thread",
"created_at": 1698107661,
"metadata": {}
}
=back
=head2 C<POST /threads/{thread_id}>
Modifies a thread.
=head3 Operation ID
C<modifyThread>
$client->modifyThread( ... );
=head3 Parameters
=over 4
=item * C<thread_id> (in path) (Required) - The ID of the thread to modify. Only the `metadata` can be modified.
Type: C<string>
=back
=head3 Request Body
=head3 Content Type: C<application/json>
Example:
{
"tool_resources" : {
"code_interpreter" : {
"file_ids" : [
null
]
},
"file_search" : {
"vector_store_ids" : [
null
]
}
}
}
=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": "thread_abc123",
"object": "thread",
"created_at": 1698107661,
"metadata": {}
}
=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