Sign inGet Started
Começar
Guias
Referência de API
SDKs
CLI
Base de conhecimento
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);
Resposta200
{
  "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.

Parâmetros

upload_idstring

ID of the media-library upload session.

Payload de resposta

id
string
obrigatório
state
string
obrigatório

The session is awaiting transfer and completion.

Value: pending

expires_at
string
obrigatório

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

name
string
obrigatório

Frozen display name for a newly published asset.

alt_text
nullable string
obrigatório

Frozen alternative text, or null when omitted.

folder_id
nullable string
obrigatório

Frozen destination folder, or null for the library root.

file
object
obrigatório

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.

Mostrar atributos secundários
result
nullable object
obrigatório

Saved publication receipt, or null until completed.

Mostrar atributos secundários
last_error
nullable object
obrigatório

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

Mostrar atributos secundários
next
array of object
obrigatório

Available next steps for this session.

Mostrar atributos secundários
upload
object
obrigatório

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.

Mostrar atributos secundários
upload.method
string
obrigatório

HTTP method for transferring the file.

Value: PUT

upload.url
string
obrigatório

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

upload.required_headers
object
obrigatório

Headers the upload request must send exactly as provided.

upload.content_length
integer
obrigatório

Required HTTP content length in bytes.

upload.expires_at
string
obrigatório

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

Recursos relacionados

Continue com a documentação, guias e exemplos sobre este tópico.

Obtenha um resumo de implementação