SpyBara
Go Premium

cli/resources/uploads/methods/cancel/index.md 2026-05-05 23:00 UTC to 2026-05-07 21:57 UTC

157 added, 0 removed.

2026
Wed 27 06:42 Fri 22 06:33 Wed 20 06:35 Tue 19 06:34 Mon 18 22:01 Mon 11 18:00 Thu 7 21:57 Tue 5 23:00 Sat 2 05:57

Cancel upload

$ openai uploads cancel

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

    The ID of the Upload.

Returns

  • upload: object { id, bytes, created_at, 6 more }

    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: number

      The intended number of bytes to be uploaded.

    • created_at: number

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

    • expires_at: number

      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".

    • purpose: string

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

    • status: "pending" or "completed" or "cancelled" or "expired"

      The status of the Upload.

      • "pending"

      • "completed"

      • "cancelled"

      • "expired"

    • file: optional object { id, bytes, created_at, 6 more }

      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: number

        The size of the file, in bytes.

      • created_at: number

        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.

      • purpose: "assistants" or "assistants_output" or "batch" or 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" or "processed" or "error"

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

        • "uploaded"

        • "processed"

        • "error"

      • expires_at: optional number

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

      • status_details: optional string

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

Example

openai uploads cancel \
  --api-key 'My API Key' \
  --upload-id upload_abc123

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"
  }
}