Create Visual Reference

POST /api/v1/visual-references

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

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

Required.

application/json — CreateVisualReferenceBody.

Field	Type	Required	Description and constraints
name	string	Yes	minimum length 1. maximum length 128
className	string	Yes	minimum length 1. maximum length 128
image	EncodedImageBody	Yes

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.

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}/visual-references"

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

Operation identifier createVisualReference. Browse Visual references.