Sign inGet Started
Aan de slag
Gidsen
API Reference
SDK's
CLI
Kennisbank
Changelog

Cancel a media-library upload

POST
/v1/asset-upload-sessions/{upload_id}/cancel
const upload = await bird.assets.uploads.cancel("aus_01krdgeqcxet5s7t44vh8rt9mg");
console.log(upload.state);
Reactie200
{
  "id": "aus_01krdgeqcxet5s7t44vh8rt9mg",
  "state": "pending",
  "folder_id": "asf_01krdgeqcxet5s7t44vh8rt9mg",
  "file": {
    "filename": "invoice.pdf",
    "content_type": "application/pdf",
    "size_bytes": 1024,
    "sha256": "4e2090a479f7ce6b17ad31f991988f12571bcafbd4a441cc4063644fc1400ae0"
  },
  "result": {
    "asset_id": "ast_01krdgeqcxet5s7t44vh8rt9mg"
  },
  "next": [
    {
      "kind": "operation"
    }
  ],
  "asset": {
    "id": "ast_01krdgeqcxet5s7t44vh8rt9mg",
    "url": "https://us1.assets.birdusercontent.com/6fcy8y6a483sewgnjk2g35y2qz/01krdgeqcxet5s7t44vh8rt9mg/document.pdf",
    "thumbnail_url": null,
    "name": "document.pdf",
    "content_type": "application/pdf",
    "kind": "document",
    "size_bytes": 48210,
    "width": null,
    "height": null,
    "alt_text": null,
    "folder_id": null,
    "deleted_at": null,
    "created_at": "2026-05-20T09:14:52Z",
    "updated_at": "2026-05-20T09:14:52Z"
  }
}

Cancels an unfinished upload. The temporary file is reclaimed after issued upload instructions expire. A completed session remains completed and its published asset is unchanged.

Parameters

upload_idstring

ID of the media-library upload session.

Response Payload

id
string
verplicht
state
string
verplicht

Upload progress. Pending accepts a transfer; finalizing is checking and publishing it. Completed has a saved result. Rejected, cancelled and expired allow no new upload instruction or publication. An already issued upload URL can remain usable until its expiry.

Possible values: pending, finalizing, completed, rejected, cancelled, expired

expires_at
string
verplicht

Absolute session expiry. Completion must finish before this deadline; starting it or refreshing an upload instruction does not extend it.

name
string
verplicht

Frozen display name for a newly published asset.

alt_text
nullable string
verplicht

Frozen alternative text, or null when omitted.

folder_id
nullable string
verplicht

Frozen destination folder, or null for the library root.

file
object
verplicht

Exact properties of the original file. Calculate size and SHA-256 from its bytes before creating a session. Images allow up to 5,242,880 bytes; other supported media allow up to 25,000,000 bytes.

Onderliggende attributen tonen
result
nullable object
verplicht

Saved publication receipt, or null until completed.

Onderliggende attributen tonen
result.asset_id
string
verplicht
result.reused_existing
boolean
verplicht

Whether the upload reused an existing active asset with identical source bytes. Reused assets keep their original metadata and folder.

result.completed_at
string
verplicht

When publication completed.

last_error
nullable object
verplicht

Last completion error, or null when no failure is recorded.

Onderliggende attributen tonen
next
array of object
verplicht

Available next steps for this session.

Onderliggende attributen tonen
asset
nullable object
verplicht

Canonical asset when available, or null before completion or when unavailable.

Onderliggende attributen tonen

Gerelateerde bronnen

Ga verder met de documentatie, handleidingen en voorbeelden voor dit onderwerp.

Ontvang een implementatieoverzicht