OVID / OpenAPI-Client-OpenAI-0.21 / lib / OpenAPI / Client / OpenAI / Path / files-file_id.pod 
=encoding utf8

=head1 NAME

OpenAPI::Client::OpenAI::Path::files-file_id - Documentation for the /files/{file_id} path.

=head1 DESCRIPTION

This document describes the API endpoint at C</files/{file_id}>.

=head1 PATHS


=head2 C<DELETE /files/{file_id}>

Delete a file.



=head3 Operation ID

C<deleteFile>

    $client->deleteFile( ... );

=head3 Parameters

=over 4

=item * C<file_id> (in path) (Required) - The ID of the file to use for this request.

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 /files/{file_id}>

Returns information about a specific file.



=head3 Operation ID

C<retrieveFile>

    $client->retrieveFile( ... );

=head3 Parameters

=over 4

=item * C<file_id> (in path) (Required) - The ID of the file to use for this request.

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": "file-abc123",
      "object": "file",
      "bytes": 120000,
      "created_at": 1677610602,
      "expires_at": 1680202602,
      "filename": "salesOverview.pdf",
      "purpose": "assistants",
    }


=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