—

              
HideShow 193 lines of Pod
=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}>.
See the C<examples/> directory in the distribution for examples of how to use this.
=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
=head3 Status Code: C<200>
OK
Content Types:
=over 4
=item * C<application/json>
=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
=head3 Status Code: C<200>
OK
Content Types:
=over 4
=item * C<application/json>
Example:
    {
       "tool_resources" : {
          "file_search" : {
             "vector_store_ids" : [
                null
             ]
          },
          "code_interpreter" : {
             "file_ids" : [
                null
             ]
          }
       }
    }
=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>
=head3 Example:
    {
       "tool_resources" : {
          "code_interpreter" : {
             "file_ids" : [
                null
             ]
          },
          "file_search" : {
             "vector_store_ids" : [
                null
             ]
          }
       }
    }
=head3 Responses
=head3 Status Code: C<200>
OK
Content Types:
=over 4
=item * C<application/json>
Example:
    {
       "tool_resources" : {
          "code_interpreter" : {
             "file_ids" : [
                null
             ]
          },
          "file_search" : {
             "vector_store_ids" : [
                null
             ]
          }
       }
    }
=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