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

upload = client.assets.uploads.cancel("aus_01krdgeqcxet5s7t44vh8rt9mg")
print(upload.state)

upload, err := client.Assets.Uploads.Cancel(context.Background(), "aus_01krdgeqcxet5s7t44vh8rt9mg")
if err != nil {
	log.Fatal(err)
}
fmt.Println(upload.State)

$upload = $bird->assets->uploads->cancel('aus_01krdgeqcxet5s7t44vh8rt9mg');
echo $upload->getState();

bird assets uploads cancel <upload-id> --yes

curl -X POST "https://us1.platform.bird.com/v1/asset-upload-sessions/{upload_id}/cancel" \
  -H "Authorization: Bearer $TOKEN"

Respuesta200

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

Parámetros

upload_idstring

ID of the media-library upload session.

Carga de respuesta

id

string

obligatorio

state

string

obligatorio

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

obligatorio

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

name

string

obligatorio

Frozen display name for a newly published asset.

alt_text

nullable string

obligatorio

Frozen alternative text, or null when omitted.

folder_id

nullable string

obligatorio

Frozen destination folder, or null for the library root.

file

object

obligatorio

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.

Mostrar atributos secundarios

result

nullable object

obligatorio

Saved publication receipt, or null until completed.

Mostrar atributos secundarios

result.asset_id

string

obligatorio

result.reused_existing

boolean

obligatorio

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

result.completed_at

string

obligatorio

When publication completed.

last_error

nullable object

obligatorio

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

Mostrar atributos secundarios

next

array of object

obligatorio

Available next steps for this session.

Mostrar atributos secundarios

asset

nullable object

obligatorio

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

Mostrar atributos secundarios

Continúa con la documentación, guías y ejemplos de este tema.

Obtener un resumen de implementación

const upload = await bird.assets.uploads.cancel("aus_01krdgeqcxet5s7t44vh8rt9mg");
console.log(upload.state);

upload = client.assets.uploads.cancel("aus_01krdgeqcxet5s7t44vh8rt9mg")
print(upload.state)

upload, err := client.Assets.Uploads.Cancel(context.Background(), "aus_01krdgeqcxet5s7t44vh8rt9mg")
if err != nil {
	log.Fatal(err)
}
fmt.Println(upload.State)

$upload = $bird->assets->uploads->cancel('aus_01krdgeqcxet5s7t44vh8rt9mg');
echo $upload->getState();

bird assets uploads cancel <upload-id> --yes

curl -X POST "https://us1.platform.bird.com/v1/asset-upload-sessions/{upload_id}/cancel" \
  -H "Authorization: Bearer $TOKEN"

Respuesta200

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

Cancel a media-library upload

Parámetros

Carga de respuesta

Recursos relacionados