Skip to main content
POST
cURL

Documentation by X-Pilot

This request starts work that may consume workspace credits. Check credits and capacity before sending it.
Required scope: video_agents:write. A stable Idempotency-Key is required for exact retries. Manage API keys · Authentication and recovery
An application sends a scoped API key to the X-Pilot REST API and receives an HTTP status and JSON response.
REST requests use a scoped API key. Keys, credits and usage are managed in the App console.

Authorizations

Authorization
string
header
required

Scoped X-Pilot API key

Headers

Idempotency-Key
string
required

Stable key for exact retries only. Use a different key for a different operation or input.

Required string length: 8 - 128

Path Parameters

conversation_id
string
required

An owned video agent conversation ID.

Body

application/json
message_id
string

Message to export. Default: the latest message with a preview.

force
boolean
default:false

Re-export even when a completed export exists.

Response

Success