Get Continuous Recording Segment
GET /api/v1/streams/{streamId}/archive/segments/{objectName}Access
Section titled “Access”Authentication options declared in the contract include user cookie session or bearer service token.
The shared authentication policy requires media:read. Resource access also depends on the caller’s role, organization, camera grants, and the operation’s validation.
Authentication and permissions explains tokens, cookies, CSRF, and workspace context.
Parameters
Section titled “Parameters”| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
streamId |
path | Yes | string (uuid) | |
objectName |
path | Yes | string | pattern ^segment-(?:[0-9]{10}|[0-9]{8}T[0-9]{6}Z-[0-9a-f]{32})\.mp4$ |
nodeId |
query | No | string or null | |
browserCompatible |
query | No | boolean | default false |
mediaTicket |
query | No | string or null | |
Range |
header | No | string or null | |
If-None-Match |
header | No | string or null | |
X-EyesOnIt-Session-Id |
header | No | string (uuid) | The sessionId the caller expects. Required when switching workspaces and for cookie requests after workspace rotation. A mismatched value returns 409 with X-EyesOnIt-Workspace-Changed: 1. Bootstrap with getCurrentPrincipal; never replay a mutation automatically after changing context. Bearer clients do not use this header. |
cURL request template
Section titled “cURL request template”Set the connection variables described in Get started. Replace each additional EOI_… variable with the parameter value for this request. This template sends the request when run.
curl --fail-with-body --silent --show-error \ --header "Authorization: Bearer ${EOI_SERVICE_TOKEN}" \ "${EOI_API_BASE_URL}/streams/${EOI_STREAMID}/archive/segments/${EOI_OBJECTNAME}"Contract responses
Section titled “Contract responses”The table records responses declared by the OpenAPI contract. See Errors and status codes for the runtime error envelope and shared failures.
| Status | Description | Media type | Body |
|---|---|---|---|
| 200 | Complete closed MP4 segment | application/json |
any |
| 206 | Requested byte range | — | Empty body |
| 304 | Entity tag is unchanged | — | Empty body |
| 416 | Requested range is not satisfiable | — | Empty body |
| 422 | Validation Error | application/json |
HTTPValidationError |
Operation identifier getContinuousRecordingSegment. Browse Recordings and playback.
