cancel.md

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

Path Parameters

• upload_id: string

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.

  • 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 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: 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.

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

  • object: optional "upload"

    The object type, which is always "upload".

    • "upload"

Example

curl https://api.openai.com/v1/uploads/$UPLOAD_ID/cancel \
    -X POST \
    -H "Authorization: Bearer $OPENAI_API_KEY"

Response

{
  "id": "id",
  "bytes": 0,
  "created_at": 0,
  "expires_at": 0,
  "filename": "filename",
  "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"
  },
  "object": "upload"
}

Example

curl https://api.openai.com/v1/uploads/upload_abc123/cancel

Response

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