Capture Sessions

Complete a capture session

Stop recording and finalize the capture session.

Completion is asynchronous: the browser uploads its recording and the session then transitions to completed. Poll retrieveCaptureSession to observe the transition.

post/v1beta/capture_sessions/{id}/complete

Request

  • Base URL: https://api.indices.io
  • URL: https://api.indices.io/v1beta/capture_sessions/{id}/complete
  • Auth: HTTP bearer

Path parameters

idstring required

The ID of the capture session to complete.

Response

Successful response

idstring required

Unique identifier for the capture session.

state'active' | 'completing' | 'completed' | 'abandoned' | 'failed' required
browser_session_idstring nullable required

Opaque identifier for the spawned browser session. Null once the browser is gone.

iframe_urlstring nullable required

URL to embed in an iframe to control the browser. Only usable while the session is active.

created_atstring date-time required

Timestamp when the object was created.

updated_atstring date-time required

Timestamp when the object was last updated.

Example response

{
  "id": "cap_0R3kPq8mWxYz1aBcDeFgHi",
  "created_at": "2026-01-01T12:00:00Z",
  "updated_at": "2026-01-06T12:05:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.