SpyBara
Go Premium

ruby/resources/uploads/methods/cancel/index.md 2026-07-10 23:02 UTC to 2026-07-12 06:58 UTC

3 added, 1 removed.

2026
Thu 16 20:57 Wed 15 02:58 Tue 14 06:58 Mon 13 15:59 Sun 12 06:58 Fri 10 23:02 Thu 9 20:58 Tue 7 08:02

Cancel upload

uploads.cancel(upload_id) -> Upload

post /uploads/{upload_id}/cancel

Cancels the Upload. No Parts may be added after an Upload is cancelled.

Returns the Upload object with status cancelled.

Parameters

  • upload_id: String

Returns

  • class Upload

    The Upload object can accept byte chunks in the form of Parts.

    • id: String

      The Upload unique identifier, which can be referenced in API endpoints.

    • bytes: Integer

      The intended number of bytes to be uploaded.

    • created_at: Integer

      The Unix timestamp (in seconds) for when the Upload was created.

    • expires_at: Integer

      The Unix timestamp (in seconds) for when the Upload will expire.

    • filename: String

      The name of the file to be uploaded.

    • object: :upload

      The object type, which is always "upload".

      • :upload

    • purpose: String

      The intended purpose of the file. Please refer here for acceptable values.

    • status: :pending | :completed | :cancelled | :expired

      The status of the Upload.

      • :pending

      • :completed

      • :cancelled

      • :expired

    • file: FileObject

      The File object represents a document that has been uploaded to OpenAI.

      • id: String

        The file identifier, which can be referenced in the API endpoints.

      • bytes: Integer

        The size of the file, in bytes.

      • created_at: Integer

        The Unix timestamp (in seconds) for when the file was created.

      • filename: String

        The name of the file.

      • object: :file

        The object type, which is always file.

        • :file

      • purpose: :assistants | :assistants_output | :batch | 5 more

        The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results, vision, and user_data.

        • :assistants

        • :assistants_output

        • :batch

        • :batch_output

        • :"fine-tune"

        • :"fine-tune-results"

        • :vision

        • :user_data

      • status: :uploaded | :processed | :error

        Deprecated. The current status of the file, which can be either uploaded, processed, or error.

        • :uploaded

        • :processed

        • :error

      • expires_at: Integer

        The Unix timestamp (in seconds) for when the file will expire.

      • status_details: String

        Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.

Example

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

upload = openai.uploads.cancel("upload_abc123")

puts(upload)

Response

{
  "id": "id",
  "bytes": 0,
  "created_at": 0,
  "expires_at": 0,
  "filename": "filename",
  "object": "upload",
  "purpose": "purpose",
  "status": "pending",
  "file": {
    "id": "id",
    "bytes": 0,
    "created_at": 0,
    "filename": "filename",
    "object": "file",
    "purpose": "assistants",
    "status": "uploaded",
    "expires_at": 0,
    "status_details": "status_details"
  }
}