OpenAPI::Client::OpenAI::Path::uploads-upload_id-cancel(3)

NAME
OpenAPI::Client::OpenAI::Path::uploads-upload_id-cancel - Documentation for the /uploads/{upload_id}/cancel path.

DESCRIPTION
This document describes the API endpoint at "/uploads/{upload_id}/cancel".

PATHS

  "POST /uploads/{upload_id}/cancel"
Cancels the Upload. No Parts may be added after an Upload is cancelled.

Operation ID

"cancelUpload"

    $client->cancelUpload( ... );

Parameters

•   "upload_id" (in path) (Required) - The ID of the Upload.

    Type: "string"

Responses

Status Code: 200

OK

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
          "id": "upload_abc123",
          "object": "upload",
          "bytes": 2147483648,
          "created_at": 1719184911,
          "filename": "training_examples.jsonl",
          "purpose": "fine-tune",
          "status": "completed",
          "expires_at": 1719127296,
          "file": {
            "id": "file-xyz321",
            "object": "file",
            "bytes": 2147483648,
            "created_at": 1719186911,
            "filename": "training_examples.jsonl",
            "purpose": "fine-tune",
          }
        }

SEE ALSO
OpenAPI::Client::OpenAI::Path

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.