VEverdun
post-action captures (ingestor)

Complete Capture

Report captured / unavailable / failed. An identical replay by the holder is an idempotent 200; a non-holder or a different outcome is 409.

post/ingestor/post-action-captures/{capture_id}/complete

Request

  • Base URL
    https://api.verdun.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.verdun.ai/ingestor/post-action-captures/{capture_id}/complete
  • Auth
    API key in header X-API-Key

Path parameters

capture_idstring required

Request body

claimed_bystring required

The claim holder.

claim_keystring required

The s3_key returned by this exact claim, required for every outcome as its attempt identifier.

outcome'captured' | 'unavailable' | 'failed' required

captured | unavailable | failed.

reason'buffer_expired' | 'stream_retention_expired' | 'no_footage' | 'codec_unsupported' | 'camera_off_schedule' | 'camera_offline' | 'camera_retired' | 'assemble_failed' | 'upload_failed' | 'kvs_error' | 'lease_expired' | 'shutdown' | 'internal_error' | 'ingestor_lost' nullable

Required for unavailable/failed; null for captured.

detailstring nullable

Diagnostics only. Stored server-side, NEVER returned to any client. Never URLs or credentials.

s3_keystring nullable

Required for captured and must equal the server-assigned key; null otherwise.

size_bytesinteger nullable

Uploaded object size (captured).

captured_msinteger nullable

Milliseconds of footage inside the window (captured; nullable only for continuous cameras).

start_offset_msinteger nullable

Milliseconds after window_start where footage begins (captured; nullable only for continuous cameras).

Response

Successful Response

capture_idstring uuid required

Capture id.

statusstring required

Terminal status recorded.

Changes

No recorded changes to this operation across all 2 revisions of this API.