Skip to content
EyesOnItDocumentation6.1

Create Image Analysis

POST /api/v1/image-analyses

Access

Section titled “Access”

Authentication options declared in the contract include user cookie session or bearer service token.

The shared authentication policy requires searches:execute. 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
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.
X-CSRF-Token header No string Required for unsafe requests authenticated by CookieSession; ignored for bearer clients. minimum length 32. maximum length 256

Request body

Section titled “Request body”

Required.

application/json — CreateImageAnalysisBody.

Field Type Required Description and constraints
image EncodedImageBody Yes
naturalLanguageQueries array of string No maximum items 8. default []
similarityReference EncodedImageBody or null No
recognizeFaces boolean No default false
faceMinimumScore number No minimum -1.0. maximum 1.0. default 0.4
faceMatchesPerFace integer No minimum 1.0. maximum 10.0. default 1
maximumObjects integer No minimum 1.0. maximum 64.0. default 16
maximumFaces integer No minimum 1.0. maximum 32.0. default 8

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. Prepare the body file using the request schema above. This template sends the request when run.

Terminal window
curl --fail-with-body --silent --show-error \
  --request POST \
  --header "Authorization: Bearer ${EOI_SERVICE_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json \
  "${EOI_API_BASE_URL}/image-analyses"

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
202 Successful Response application/json ImageAnalysisJobResponse
422 Validation Error application/json HTTPValidationError

Operation identifier createImageAnalysis. Browse Image analysis.

Image preview