Group
Extension

Matches 214

OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path.pod ( view source; MetaCPAN )
Container File

You can send either a multipart/form-data request with the raw file content, or a JSON request with a file ID.


=back

See L<OpenAPI::Client::OpenAI::Path::containers-container_id-fil
s://platform.openai.com/docs/assistants/tools> for details.

The Fine-tuning API only supports C<.jsonl> files. The input also has certain required formats for fine-tuning L<chat|https://platform.open
nai.com/docs/api-reference/fine-tuning/completions-input> models.

The Batch API only supports C<.jsonl> files up to 200 MB in size. The input also has a specific required L<format|https://platform.op
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/lib/OpenAPI/Client/OpenAI/Path/containers-container_id-files.pod ( view source; MetaCPAN )
es


=head4 Status Code: C<200>

Success


=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/ma
921ff305e08e78805b9fdbb04\",\n    \"path\": \"/mnt/data/88e12fa445d32636f190a0b33daed6cb-tsconfig.json\",\n    \"source\": \"user\"\n}\n"
       ]
    }


=back

=head2 C<POST /containers/{container_i
Container File

You can send either a multipart/form-data request with the raw file content, or a JSON request with a file ID.



=head3 Operation ID

C<CreateContainerFile>

    $client->CreateContai
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path/organization-certificates.pod ( view source; MetaCPAN )
<200>

Certificates listed successfully.


=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/ma
ication/json>

    
      

      
             

=head3 Responses


=head4 Status Code: C<200>

Certificate uploaded successfully.


=head4 Content Types:

=over 4


=item * C<application/json>

Exam
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path/realtime-transcription_sessions.pod ( view source; MetaCPAN )
 );

=head3 Parameters

=over 4

=back

=head3 Request Body
  
=head3 Content Type: C<application/json>

    
      Realtime transcription session object configuration.

      
      
Example:

    {
e: C<200>

Session created successfully.


=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/ma
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path/organization-usage-completions.pod ( view source; MetaCPAN )
200>

Usage data retrieved successfully.


=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/ma
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path/organization-projects-project_id-rate_limits-rate_limit_id.pod ( view source; MetaCPAN )
tion/json>

    
      

      
             

=head3 Responses


=head4 Status Code: C<200>

Project rate limit updated successfully.


=head4 Content Types:

=over 4


=item * C<application/json>

E


Error response for various conditions.


=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/ma
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path/organization-usage-embeddings.pod ( view source; MetaCPAN )
200>

Usage data retrieved successfully.


=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/ma
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path/audio-speech.pod ( view source; MetaCPAN )
 );

=head3 Parameters

=over 4

=back

=head3 Request Body
  
=head3 Content Type: C<application/json>

    
      

      

=head4 Models

One of the available L<TTS models|https://platform.openai.c
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path/responses-response_id.pod ( view source; MetaCPAN )



=head4 Status Code: C<404>

Not Found


=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/ma
sponses


=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/ma
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path/organization-projects-project_id-users.pod ( view source; MetaCPAN )
200>

Project users listed successfully.


=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/ma
Error response when project is archived.


=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/ma
cation/json>

    
      

      
             

=head3 Responses


=head4 Status Code: C<200>

User added to project successfully.


=head4 Content Types:

=over 4


=item * C<application/json>

Exam
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path/organization-admin_api_keys.pod ( view source; MetaCPAN )
C<200>

A list of organization API keys.


=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/ma
 );

=head3 Parameters

=over 4

=back

=head3 Request Body
  
=head3 Content Type: C<application/json>

    
      

      
      
Example:

    {
       "name" : "New Admin Key"
    }


            
C<200>

The newly created admin API key.


=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/ma
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path/organization-projects-project_id-archive.pod ( view source; MetaCPAN )
: C<200>

Project archived successfully.


=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/ma
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path/chat-completions.pod ( view source; MetaCPAN )
Code: C<200>

A list of Chat Completions


=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/ma
ent Type: C<application/json>

    
      

      
             

=head3 Responses


=head4 Status Code: C<200>

OK


=head4 Content Types:

=over 4


=item * C<application/json>

Example (See the L<O
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path/organization-costs.pod ( view source; MetaCPAN )
200>

Costs data retrieved successfully.


=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/ma
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path/vector_stores-vector_store_id-files.pod ( view source; MetaCPAN )
sponses


=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/ma
ent Type: C<application/json>

    
      

      
             

=head3 Responses


=head4 Status Code: C<200>

OK


=head4 Content Types:

=over 4


=item * C<application/json>

Example (See the L<O
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path/organization-projects.pod ( view source; MetaCPAN )
e: C<200>

Projects listed successfully.


=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/ma
plication/json>

    
      

      
             

=head3 Responses


=head4 Status Code: C<200>

Project created successfully.


=head4 Content Types:

=over 4


=item * C<application/json>

Example
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path/organization-projects-project_id-api_keys.pod ( view source; MetaCPAN )
>

Project API keys listed successfully.


=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/ma
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path/chat-completions-completion_id.pod ( view source; MetaCPAN )
hat completion was deleted successfully.


=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/ma
4 Status Code: C<200>

A chat completion


=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/ma
: C<application/json>

    
      

      
             

=head3 Responses


=head4 Status Code: C<200>

A chat completion


=head4 Content Types:

=over 4


=item * C<application/json>

Example (See 
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path/assistants-assistant_id.pod ( view source; MetaCPAN )
sponses


=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/ma
sponses


=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/ma
t 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
OpenAPI-Client-OpenAI ( O/OV/OVID/OpenAPI-Client-OpenAI-0.24.tar.gz, OVID, 2025; MetaCPAN )
OpenAPI-Client-OpenAI/blib/lib/OpenAPI/Client/OpenAI/Path/files.pod ( view source; MetaCPAN )
sponses


=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/ma
s://platform.openai.com/docs/assistants/tools> for details.

The Fine-tuning API only supports C<.jsonl> files. The input also has certain required formats for fine-tuning L<chat|https://platform.open
nai.com/docs/api-reference/fine-tuning/completions-input> models.

The Batch API only supports C<.jsonl> files up to 200 MB in size. The input also has a specific required L<format|https://platform.op

Powered by Groonga
Maintained by Kenichi Ishigaki <ishigaki@cpan.org>. If you find anything, submit it on GitHub.