Get Image Generation Job
AI Studio
Get Image Generation Job
Retrieve the status and output of an AI image generation job
GET
Get Image Generation Job
Overview
This endpoint retrieves the current status and output of an AI image generation job using its unique job ID. While the generation is in progress, it returns the job status. Once the image generation completes, it returns the output including the image URL, dimensions, and AI credits consumed.A valid API key is required to use this endpoint. Obtain your API key from the API Access page in your Pictory dashboard.
API Endpoint
Request Parameters
Path Parameters
uuid
required
The unique identifier (UUID) of the image generation job. This is the
jobId returned by the Generate Image endpoint.Example: "4d82d040-4394-4371-867d-72ae1dd62b6d"Headers
string
required
API key for authentication (starts with
pictai_)Response
In-Progress Response
Returned while the image is being generated:string
The unique identifier of the image generation job
boolean
true while the job is processingCompleted Response
Returned when the image has been generated successfully:string
The unique identifier of the image generation job
boolean
true when the job has completed successfullyobject
Contains the image generation output.
string
"completed" when the image has been generated successfullystring
Direct download URL for the generated image file (PNG)
number
Width of the generated image in pixels
number
Height of the generated image in pixels
number
Number of AI credits consumed for this image generation
Failed Response
Returned when the image generation job has failed:string
The unique identifier of the image generation job
boolean
false when the job has failedobject
Response Examples
Status Codes
Completed Response Fields
Code Examples
Polling Best Practices
-
Use webhooks when possible. Configure a
webhookURL in the original generate image request to receive automatic notification when the job completes, rather than polling. - Implement timeouts. Set a reasonable maximum wait time. Image generation typically completes within a few minutes.
-
Handle failures gracefully. Inspect
error_codeanderror_messagein failed responses to determine the cause and whether the request can be retried.
