AI

Read an image generation job

Requires the ai.generate permission.

get/ai/images/{jobId}

Request

  • Base URL: https://post.adaptlypost.com/post/api/v1
  • URL: https://post.adaptlypost.com/post/api/v1/ai/images/{jobId}
  • Auth: HTTP bearer

Path parameters

jobIdstring required

Job ID returned by POST /ai/images

Headers

X-Workspace-Idstring

The workspace to act in, for OAuth sign-ins that reach several workspaces. Take the id from GET /workspaces. Without it the call lands in the default workspace. A workspace the caller cannot reach answers 403 with code: workspace_access_denied. An API key belongs to one workspace: send its own id or leave the header out

Response

Image job state

jobIdstring
sessionIdstring uuid
status'queued' | 'processing' | 'generating' | 'completed' | 'failed'
imageUrlstring nullable
imageIdstring uuid nullable
errorstring nullable

Changes

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