Sign inGet Started
Get started
Guides
API Reference
SDKs
CLI
Knowledge Base
Changelog

Get a media-library upload session

GET
/v1/asset-upload-sessions/{upload_id}
const upload = await bird.assets.uploads.get("aus_01krdgeqcxet5s7t44vh8rt9mg");
console.log(upload.state);
Response200
{
  "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"
  }
}

Returns the upload session and its saved publication receipt. Requires current asset write access and the connection that created the session. Status checks do not issue another upload capability.

Parameters

upload_idstring

ID of the media-library upload session.

Response Payload

id
string
required
state
string
required

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
required

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

name
string
required

Frozen display name for a newly published asset.

alt_text
nullable string
required

Frozen alternative text, or null when omitted.

folder_id
nullable string
required

Frozen destination folder, or null for the library root.

file
object
required

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.

Show child attributes
file.filename
string
required

Original filename, including its extension.

file.content_type
string
required

Media type of the original file. Supported values are image/png, image/jpeg, image/gif, video/mp4, video/webm, video/quicktime, audio/mpeg, audio/mp4, audio/ogg, audio/wav, and application/pdf.

Supply the exact value without parameters. Unsupported values return E20001. Completion checks this against the file's contents.

file.size_bytes
integer
required

Exact size of the original file in bytes.

file.sha256
string
required

SHA-256 of the original bytes, encoded as lowercase hexadecimal.

result
nullable object
required

Saved publication receipt, or null until completed.

Show child attributes
last_error
nullable object
required

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

Show child attributes
next
array of object
required

Available next steps for this session.

Show child attributes
asset
nullable object
required

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

Show child attributes

Related resources

Continue with the documentation, guides and examples for this topic.

Get an implementation brief