Skip to main content
PATCH
Update job visibility

Authorizations

X-API-Key
string
header
required

API key issued by the Taste Engine. Create one in the dashboard at https://engine.tastelabs.com/app/api-keys.

Path Parameters

job_id
string
required

Brand-adherence job identifier, as returned by POST /judge/brand-adherence.

Body

application/json
is_public
boolean
required

Set to true to make the result publicly readable, false to make it private.

Response

The updated job status view.

Status view of a single brand-adherence job.

job_id
string
required
status
enum<string>
required

Lifecycle status of a brand-adherence job.

Available options:
accepted,
extracting,
judging,
completed,
failed
reference_url
string<uri>
required
source_url
string<uri>
required
accepted_at
string<date-time>
required
user_id
string
current_step
string | null

Name of the pipeline stage currently running, e.g. waiting_for_extractions, judging_scene.

step_started_at
string<date-time> | null
updated_at
string<date-time> | null
cache_hit
object

Per-side reuse at each pipeline layer. Reuse makes the job faster.

is_public
boolean
api_key_name
string | null

Name of the API key that created the job, when one was used. null for dashboard runs.

completed_at
string<date-time> | null

null while the job is still running.

error
string | null

Error message when status is failed.