Analyse

Get analyse job status

Returns the current status and per-item progress of an analysis job. Poll this endpoint until status is done, partial, or failed. Once done, use job_uid to call GET /api/analyse/result/{job_uid} with the same X-Api-Key to retrieve results. Authentication: X-Api-Key header required.

get/api/analyse/job/{uid}

Request

  • Base URL: https://snapwonders.com
  • URL: https://snapwonders.com/api/analyse/job/{uid}
  • Auth: API key in header X-Api-Key

Path parameters

uidstring uuid required

Either the upload_uid returned by POST /api/analyse/session or the job_uid returned by POST /api/analyse/job. Both identify the job.

Response

Job status

upload_uidstring uuid
job_uidstring uuid

Pass to GET /api/analyse/result/{job_uid} with the same X-Api-Key to retrieve full results once done.

status'queued' | 'processing' | 'completed' | 'partial' | 'failed' | 'terminated'
total_itemsinteger

Total number of files in this job

completedinteger

Number of items successfully analysed

failedinteger

Number of items that failed

queued_atstring date-time nullable
started_atstring date-time nullable
completed_atstring date-time nullable

Example response

{
  "items": [
    {
      "name": "photo.jpg"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.