Skip to main content
GET
/
api
/
v1
/
job
/
{id}
Get job status
curl --request GET \
  --url http://localhost:3051/api/v1/job/{id} \
  --header 'Authorization: Bearer <token>'
{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_prohibited": true,
  "categories": {
    "custom": {},
    "ai_adult_general": true,
    "underage": true,
    "nsfw": true
  },
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "reason": "<string>",
  "error_code": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.omnifence.ai/llms.txt

Use this file to discover all available pages before exploring further.

Requires the job:read scope. Requests without this scope receive a 403 FORBIDDEN response. See authentication.

Authorizations

​
Authorization
string
header
required

API key from the Stars 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,
prompt,
image,
video
​
status
enum<string>
required
Available options:
queued,
processing,
completed,
failed
​
is_prohibited
null | boolean
required

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

​
categories
object
required

Categories tripped by the most recent moderation log for this job. Built-in categories are present only when the client has them enabled; custom is always present (an empty object means no custom categories ran).

​
created_at
string<date-time>
required
​
completed_at
null | string<date-time>
required
​
reason
string

Why a prompt job was rejected by the prohibition check.

​
error_code
string

Set when the job failed before reaching a moderation decision.