Skip to main content
GET
/
collection
/
{collection_id}
/
capture
/
session
List capture sessions
curl --request GET \
  --url https://api.videodb.io/collection/{collection_id}/capture/session \
  --header 'x-access-token: <api-key>'
{
  "success": true,
  "data": {
    "sessions": [
      {
        "session_id": "capture-12345",
        "end_user_id": "user-123",
        "status": "created",
        "collection_id": "default",
        "ws_connection_id": "conn-123",
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "next_page": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.videodb.io/llms.txt

Use this file to discover all available pages before exploring further.

List all capture sessions in a collection, with optional filtering by status.
  • Filter by status: created, starting, active, stopped, failed
  • Results are paginated; use next_page for additional results

Authorizations

​
x-access-token
string
header
required

API key for authentication (sk-xxx format)

Path Parameters

​
collection_id
string
required
Example:

"default"

Query Parameters

​
status
enum<string>
Available options:
created,
starting,
active,
stopped,
failed
Example:

"active"

Response

200 - application/json

List of capture sessions

​
success
boolean
Example:

true

​
data
object