Group
Extension

OpenAPI-Client-OpenAI/lib/OpenAPI/Client/OpenAI/Path/containers-container_id.pod

=encoding utf8

=head1 NAME

OpenAPI::Client::OpenAI::Path::containers-container_id - Documentation for the /containers/{container_id} path.

=head1 DESCRIPTION

This document describes the API endpoint at C</containers/{container_id}>.

=head1 PATHS


=head2 C<DELETE /containers/{container_id}>

Delete a container


Delete Container



=head3 Operation ID

C<DeleteContainer>

    $client->DeleteContainer( ... );

=head3 Parameters

=over 4

=item * C<container_id> (in path) (Required) - The ID of the container to delete.

Type: C<string>



=back


=head3 Responses


=head4 Status Code: C<200>

OK


=head2 C<GET /containers/{container_id}>

Retrieve container


Retrieve Container



=head3 Operation ID

C<RetrieveContainer>

    $client->RetrieveContainer( ... );

=head3 Parameters

=over 4

=item * C<container_id> (in path) (Required) - 

Type: C<string>



=back


=head3 Responses


=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/master/openapi.yaml>):

    {
       "id": "cntr_682dfebaacac8198bbfe9c2474fb6f4a085685cbe3cb5863",
       "object": "container",
       "created_at": 1747844794,
       "status": "running",
       "expires_after": {
         "anchor": "last_active_at",
         "minutes": 20
       },
       "last_active_at": 1747844794,
       "name": "My Container"
    }


=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

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