Skip to content

Get Recording Artifact

GET /api/v1/recordings/{recordingId}/artifacts/{objectName}

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.

Name Location Required Type Description and constraints
recordingId path Yes string (uuid)
objectName path Yes string pattern ^(manifest\.json|detection-metadata\.json|clip\.mp4|segment-[0-9]{1,10}\.mp4)$
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.

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.

Terminal window
curl --fail-with-body --silent --show-error \
--header "Authorization: Bearer ${EOI_SERVICE_TOKEN}" \
"${EOI_API_BASE_URL}/recordings/${EOI_RECORDINGID}/artifacts/${EOI_OBJECTNAME}"

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 immutable recording object application/json any
200 Complete immutable recording object application/octet-stream string (binary)
206 Requested byte range application/octet-stream string (binary)
304 Entity tag is unchanged — Empty body
416 Requested range is not satisfiable — Empty body
422 Validation Error application/json HTTPValidationError

Operation identifier getRecordingArtifact. Browse Recordings and playback.

Image preview