Sign in

v5

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-0112516159.5 KB
Capture

Create capture session

post/collection/{collection_id}/capture/session

Path parameters

collection_idstring required
Example:default

Request body

end_user_idstring required
callback_urlstring
ws_connection_idstring
metadataobject

Example request

{
  "end_user_id": "user-123",
  "callback_url": "https://webhook.example.com/callback",
  "ws_connection_id": "conn-123"
}

Response

Capture session created

successboolean

Example response

{
  "success": true,
  "data": {
    "session_id": "capture-12345",
    "end_user_id": "user-123",
    "status": "created",
    "collection_id": "default",
    "ws_connection_id": "conn-123"
  }
}