Critterflow logo
Critterflow
The underwater photographer's platform
Help Center

Public Identify Workflow

Upload, enqueue, and poll for results using an API key.

Back to Help Center

Public Identify Workflow

The public identify workflow lets desktop plugins and other clients submit images with an API key.

Summary

The flow uses three API calls and one direct S3 upload:

  1. POST /v1/public/upload-url
  2. Upload the image to S3 with the presigned URL
  3. POST /v1/public/identify
  4. GET /v1/public/identify/{jobId} until complete

Required fields

  • uploadId
  • diveLocation
  • traitHint

Optional fields include tags, notes, diveSite, and visibility.

Correlation IDs

POST /v1/public/upload-url returns a correlationId. When uploading via PUT, send x-amz-meta-correlation-id with that value so uploads stay traceable end-to-end.

Polling guidance

Start at 2 seconds, back off to 10 seconds, and stop after 90 seconds. If the job fails, surface the error and stop polling.