Retrieve a Spark Images batch
Poll for the result of a previously requested Spark Images batch.
/v1/images/{image_id}/spark/images/{batch_id}Returns the current state of a Spark Images batch. Poll until status
moves from PROCESSING to COMPLETED or ERROR.
data is empty until status is COMPLETED. The batch only completes
once every prompt is terminal and Spark Cull has resolved every child
image; while cull is settling it stays PROCESSING with empty data.
Once COMPLETED, data holds the visible children only — each with a
short-lived pre-signed download URL that a fresh request refreshes, plus
that child's score (score_status, vizit_score, vizit_certified, and
score_error_code when Vizit does not score the image). One call is
therefore enough to get the images and their scores;
Retrieve an image score remains available for
a single child and adds the hero GS1 component detail.
A batch that has been non-terminal for longer than the 5-minute timeout
is reported as ERROR here even when the database rows still read as
in-flight.
Authorization
bearerAuth Short-lived access token issued by Create a token.
Send it on every request as Authorization: Bearer <token>.
In: header
Path Parameters
Root image the batch was requested for.
uuidThe batch_id returned by Request a Spark Images batch.
uuidResponse Body
application/json
application/json
application/json
curl -X GET "https://ext.vizit.com/v1/images/497f6eca-6276-4993-bfeb-53cbbbba6f08/spark/images/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20", "image_id": "84c230fd-5520-4984-8119-37365b66fd80", "status": "PROCESSING", "error_code": "SPARK_GENERATION_FAILED", "data": [ { "image_id": "84c230fd-5520-4984-8119-37365b66fd80", "url": "http://example.com", "url_expires_at": "2019-08-24T14:15:22Z", "score_status": "COMPLETED", "score_error_code": "IMAGE_OMITTED_FROM_SCORING", "vizit_score": 84.2, "vizit_certified": true } ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}{ "detail": "string", "status_code": 0, "error_code": "IMAGE_DOWNLOAD_FAILED", "request_id": "266ea41d-adf5-480b-af50-15b940c2b846", "extra": { "failed_urls": [ { "url": "https://cdn.example.com/broken.jpg", "reason": "IMAGE_DOWNLOAD_TIMEOUT" }, { "url": "https://cdn.example.com/icon.svg", "reason": "UNSUPPORTED_IMAGE_FORMAT" } ] }, "timestamp": "2019-08-24T14:15:22Z"}{ "detail": "string", "status_code": 0, "error_code": "IMAGE_DOWNLOAD_FAILED", "request_id": "266ea41d-adf5-480b-af50-15b940c2b846", "extra": { "failed_urls": [ { "url": "https://cdn.example.com/broken.jpg", "reason": "IMAGE_DOWNLOAD_TIMEOUT" }, { "url": "https://cdn.example.com/icon.svg", "reason": "UNSUPPORTED_IMAGE_FORMAT" } ] }, "timestamp": "2019-08-24T14:15:22Z"}