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

Cancel upload

client.Uploads.Cancel(ctx, uploadID) (*Upload, error)

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

• uploadID string

Returns

• type Upload struct{…}

  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 int64

    The intended number of bytes to be uploaded.

  • CreatedAt int64

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

  • ExpiresAt int64

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

    • const UploadUpload Upload = "upload"

  • Purpose string

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

  • Status UploadStatus

    The status of the Upload.

    • const UploadStatusPending UploadStatus = "pending"

    • const UploadStatusCompleted UploadStatus = "completed"

    • const UploadStatusCancelled UploadStatus = "cancelled"

    • const UploadStatusExpired UploadStatus = "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 int64

      The size of the file, in bytes.

    • CreatedAt int64

      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.

      • const FileFile File = "file"

    • Purpose FileObjectPurpose

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

      • const FileObjectPurposeAssistants FileObjectPurpose = "assistants"

      • const FileObjectPurposeAssistantsOutput FileObjectPurpose = "assistants_output"

      • const FileObjectPurposeBatch FileObjectPurpose = "batch"

      • const FileObjectPurposeBatchOutput FileObjectPurpose = "batch_output"

      • const FileObjectPurposeFineTune FileObjectPurpose = "fine-tune"

      • const FileObjectPurposeFineTuneResults FileObjectPurpose = "fine-tune-results"

      • const FileObjectPurposeVision FileObjectPurpose = "vision"

      • const FileObjectPurposeUserData FileObjectPurpose = "user_data"

    • Status FileObjectStatus

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

      • const FileObjectStatusUploaded FileObjectStatus = "uploaded"

      • const FileObjectStatusProcessed FileObjectStatus = "processed"

      • const FileObjectStatusError FileObjectStatus = "error"

    • ExpiresAt int64

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

    • StatusDetails string

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

Example

package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  upload, err := client.Uploads.Cancel(context.TODO(), "upload_abc123")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", upload.ID)
}

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