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

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);
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"
    }
  ]
}

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.

Parameters

upload_idstring

ID of the media-library upload session.

Response Payload

id
string
verplicht
state
string
verplicht

The session is awaiting transfer and completion.

Value: pending

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
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
upload
object
verplicht

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.

Onderliggende attributen tonen
upload.method
string
verplicht

HTTP method for transferring the file.

Value: PUT

upload.url
string
verplicht

Temporary HTTPS upload URL. It can be reused for the same fixed file until expiry.

upload.required_headers
object
verplicht

Headers the upload request must send exactly as provided.

upload.content_length
integer
verplicht

Required HTTP content length in bytes.

upload.expires_at
string
verplicht

Upload instruction expiry, bounded by the session and signing credentials.

Gerelateerde bronnen

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

Ontvang een implementatieoverzicht