Cancel upload

POST https://api.fastapi.ai/v1/uploads/{upload_id}/cancel

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

Path parameters

---

upload_id string Required
The ID of the Upload.

Returns

---

The Upload object with status cancelled.

---

The upload object

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.

---

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

---

filename string
The name of the file to be uploaded.

---

bytes integer
The intended number of bytes to be uploaded.

---

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

---

status string
The status of the Upload.

---

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

---

object string
The object type, which is always "upload".

---

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

---

OBJECT The upload object

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

Example

Request

curl https://api.fastapi.ai/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
}