Skip to main content
POST
Enqueue an async export job

Authorizations

Authorization
string
header
required

Autenticação por API Key no formato Authorization: Bearer sk-... (sempre inclua o prefixo Bearer).

Gere sua chave em /dashboard/api-keys após criar a conta e verificar o e-mail. A chave é exibida uma única vez no momento da criação — armazene em variável de ambiente no seu backend. Nunca exponha em código client-side.

Path Parameters

siteId
string
required

Site UUID

Response

Queued

Resposta ao enfileirar um export assíncrono.

id
string

Identificador do job de export. Use para consultar o status.

Example:

"exp_01HK8WD2QXKB4R7N9F1H3P5T0G"

status
enum<string>

Status inicial sempre queued.

Available options:
queued
Example:

"queued"

status_url
string

URL relativa para consultar o status do job (GET /exports/{id}).

Example:

"/api/v1/exports/exp_01HK8WD2QXKB4R7N9F1H3P5T0G"

message
string

Mensagem human-readable do enfileiramento.

Example:

"Export queued; consult status_url for progress."