Sign inGet Started
Commencer
Guides
Référence API
SDK
CLI
Base de connaissances
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);
Réponse200
{
  "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. This operation accepts no replacement file or metadata; an authorized browser may have selected a different source since creation. Use the returned file descriptor.

Paramètres

upload_idstring

ID of the media-library upload session.

Contenu de la réponse

id
string
obligatoire
state
string
obligatoire

The session is awaiting transfer and completion.

Value: pending

expires_at
string
obligatoire

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

name
string
obligatoire

Frozen display name for a newly published asset.

alt_text
nullable string
obligatoire

Frozen alternative text, or null when omitted.

folder_id
nullable string
obligatoire

Frozen destination folder, or null for the library root.

file
object
obligatoire

Exact properties of the active source file. Calculate size and SHA-256 from its bytes before creating a session or preparing a browser-selected source. Images allow up to 5,242,880 bytes; other supported media allow up to 25,000,000 bytes.

Afficher les attributs enfants
result
nullable object
obligatoire

Saved publication receipt, or null until completed.

Afficher les attributs enfants
last_error
nullable object
obligatoire

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

Afficher les attributs enfants
next
array of object
obligatoire

Available next steps for this session.

Afficher les attributs enfants
upload
object
obligatoire

Send the active source bytes described by the session 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.

Afficher les attributs enfants
upload.method
string
obligatoire

HTTP method for transferring the file.

Value: PUT

upload.url
string
obligatoire

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

upload.required_headers
object
obligatoire

Headers the upload request must send exactly as provided.

upload.content_length
integer
obligatoire

Required HTTP content length in bytes.

upload.expires_at
string
obligatoire

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

Ressources associées

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.

Obtenir un guide d'implémentation