Skip to main content
POST
Create capture session

Authorizations

x-access-token
string
header
required

API key for authentication (sk-xxx format)

Path Parameters

collection_id
string
required
Example:

"default"

Body

application/json
end_user_id
string
required
Example:

"user-123"

callback_url
string
Example:

"https://webhook.example.com/callback"

ws_connection_id
string
Example:

"conn-123"

metadata
object

Response

Capture session created

success
boolean
Example:

true

data
object