Skip to main content

Overview

Triggers AI processing for imported photos — watermarking, BIB number detection, and face indexing depending on the event configuration. This is pipeline step 2, after Import. For API-key requests, the job is asynchronous: this endpoint only queues work. The response returns status: "processing" and a run_id; track completion with Pipeline Status via stages.process.status (processed, partially_processed, or failed).
Credits are deducted immediately when the job is queued. If AI features (selfie search or BIB search) are enabled, each image consumes one credit. Ensure your account has sufficient credits before calling this endpoint.

Endpoint

Path Parameters

Request Body

Example Request

Example Response

credits_consumed is 0 when neither selfie search nor BIB search is enabled for the event. effective_count is the number actually queued (may be lower than requested_count when fewer unprocessed images remain).

Error Responses

See Errors for canonical descriptions and retry guidance.

OAuth Reviewed Request

OAuth only. Read calls require events:read. Writes require both events:read and events:write, plus an accepted organiser admin membership. Send a bearer token without X-API-Key. The API-key request and response above remain unchanged. For OAuth, use the same path with the guarded JSON body below. Processing is the only reviewed OAuth write because it spends credits. Send mode: "preview" first and show the user proposed.effective_count (photos that will be processed) and proposed.credits_consumed (credits that will be used). After the user confirms, repeat the same fields with mode: "execute", the returned review_token, idempotency_key, and confirmed: true. Reviews expire after 15 minutes. See Operations for expiry, retry rules and status tracking. count is mandatory and positive for OAuth; execution reserves the reviewed credits atomically. The default count in the API-key contract does not apply.

Execute After Confirmation

Example Request

Example Response

OAuth Response Models

GuardedOperationData replaces the API-key stage-start response. Track operation_id through Operations, alongside Pipeline Status. pending or queued means the work was accepted, not completed; uncertain dispatch is dispatch_unknown.