SpyBara
Go Premium

java/resources/uploads/methods/cancel/index.md 2026-07-07 08:02 UTC to 2026-07-09 20:58 UTC

172 added, 0 removed.

2026
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

Upload uploads().cancel(UploadCancelParamsparams = UploadCancelParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

post /uploads/{upload_id}/cancel

Cancel upload

Parameters

  • UploadCancelParams params

    • Optional<String> uploadId

Returns

  • class Upload:

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

    • String id

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

    • long bytes

      The intended number of bytes to be uploaded.

    • long createdAt

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

    • long expiresAt

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

    • String filename

      The name of the file to be uploaded.

    • JsonValue; object_ "upload"constant

      The object type, which is always "upload".

      • UPLOAD("upload")

    • String purpose

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

    • Status status

      The status of the Upload.

      • PENDING("pending")

      • COMPLETED("completed")

      • CANCELLED("cancelled")

      • EXPIRED("expired")

    • Optional<FileObject> file

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

      • String id

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

      • long bytes

        The size of the file, in bytes.

      • long createdAt

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

      • String filename

        The name of the file.

      • JsonValue; object_ "file"constant

        The object type, which is always file.

        • FILE("file")

      • Purpose purpose

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

        • ASSISTANTS_OUTPUT("assistants_output")

        • BATCH("batch")

        • BATCH_OUTPUT("batch_output")

        • FINE_TUNE("fine-tune")

        • FINE_TUNE_RESULTS("fine-tune-results")

        • VISION("vision")

        • USER_DATA("user_data")

      • Status status

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

        • UPLOADED("uploaded")

        • PROCESSED("processed")

        • ERROR("error")

      • Optional<Long> expiresAt

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

      • Optional<String> statusDetails

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

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.uploads.Upload;
import com.openai.models.uploads.UploadCancelParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        Upload upload = client.uploads().cancel("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"
  }
}