Sign inGet Started
立即开始
指南
API 参考
SDK
CLI
知识库
更新日志

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);
响应200
{
  "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.

参数

upload_idstring

ID of the media-library upload session.

响应载荷

id
string
必填
state
string
必填

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
必填

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

name
string
必填

Frozen display name for a newly published asset.

alt_text
nullable string
必填

Frozen alternative text, or null when omitted.

folder_id
nullable string
必填

Frozen destination folder, or null for the library root.

file
object
必填

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.

显示子属性
result
nullable object
必填

Saved publication receipt, or null until completed.

显示子属性
last_error
nullable object
必填

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

显示子属性
next
array of object
必填

Available next steps for this session.

显示子属性
asset
nullable object
必填

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

显示子属性

相关资源

继续查看此主题的文档、指南和示例。

获取实施简报