Sign inGet Started

Refresh a media-library upload instruction

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

Refreshes the temporary upload instruction for a pending session. File properties and the one-hour session deadline remain unchanged. No replacement file or metadata is accepted.

Parameter

upload_idstring

ID of the media-library upload session.

Payload Respons

id
string
wajib
state
string
wajib

The session is awaiting transfer and completion.

Value: pending

expires_at
string
wajib

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

name
string
wajib

Frozen display name for a newly published asset.

alt_text
nullable string
wajib

Frozen alternative text, or null when omitted.

folder_id
nullable string
wajib

Frozen destination folder, or null for the library root.

file
object
wajib

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.

Tampilkan atribut turunan
file.filename
string
wajib

Original filename, including its extension.

file.content_type
string
wajib

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
wajib

Exact size of the original file in bytes.

file.sha256
string
wajib

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

result
nullable object
wajib

Saved publication receipt, or null until completed.

Tampilkan atribut turunan
last_error
nullable object
wajib

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

Tampilkan atribut turunan
next
array of object
wajib

Available next steps for this session.

Tampilkan atribut turunan
upload
object
wajib

Send the original file bytes to this URL with the exact headers and content length. Send no Bird credentials or cookies. Keep the URL private and call complete after the PUT succeeds.

Tampilkan atribut turunan