Skip to main content
GET
Get job status
Requires the job:read scope. Requests without this scope receive a 403 FORBIDDEN response. See authentication.
The response names the API key that submitted the job in api_key_id, with that key’s current name in api_key_name. Both are null for a job sent from the dashboard, and for any job created before key attribution shipped. api_key_name is resolved when you read the job, so a key you deleted resolves to null while api_key_id still identifies it.

Authorizations

Authorization
string
header
required

API key from the Omnifence dashboard

Path Parameters

id
string<uuid>
required

Response

200 - application/json

Default Response

job_id
string<uuid>
required
type
enum<string>
required
Available options:
pre,
post,
chat,
text,
image,
video,
audio,
generate
status
enum<string>
required
Available options:
queued,
processing,
completed,
failed
api_key_id
null | string
required

Id of the API key the job was submitted with. Null for jobs submitted from a dashboard session, and for jobs created before key attribution shipped.

api_key_name
null | string
required

Display name of that API key, resolved at read time. Null when the key was never named or has since been deleted. api_key_id still identifies it.

created_at
string<date-time>
required
completed_at
null | string<date-time>
required
is_prohibited
null | boolean

True when the content was rejected, false when it passed, null while the job is still pending.

reason
string

Why the content was rejected. Names the specific policy or custom category that tripped. Present only on a reject.

nsfw
boolean

Informational label: whether an image/video contains nudity or sexual content. Decoupled from is_prohibited, so NSFW content is not rejected on its own. Present only when the NSFW classifier ran.

output_image_url
string

Output image URL for a non-moderation generate job (presigned HTTPS when stored internally). Present only on those jobs once they complete.

error_code
string

Set when the job failed before reaching a moderation decision.