Jobs

get

Latest job

Authorizations

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

engine_idstringRequired

Query parameters

job_typestringRequired

Responses

200

Success: Job details

application/json

idstring · uuidRequired

engine_idstring · uuid · nullableOptionalDefault: null

typestring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

createdstring · date-time · nullableOptionalDefault: null

last_updatedstring · date-time · nullableOptionalDefault: null

nowstring · date-time · nullableOptionalDefault: null

204

No content

422

Validation error

application/json

503

Message: unable to fetch engine from external service

get/api/v1/jobs/{engine_id}/latest/

GET /api/v1/jobs/{engine_id}/latest/?job_type=text HTTP/1.1
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "engine_id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "synthesize",
  "status": "CREATED",
  "created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z",
  "now": "2026-01-01T00:00:00.000Z",
  "attachment_types": [
    "LOG"
  ]
}

get

List jobs

Authorizations

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

engine_idstringRequired

Query parameters

job_typestring · enumOptionalPossible values:

Responses

200

Success: Jobs list

application/json

422

Validation error

application/json

503

Message: unable to fetch engine from external service

get/api/v1/jobs/{engine_id}/list/

GET /api/v1/jobs/{engine_id}/list/ HTTP/1.1
Accept: */*

{
  "jobs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "engine_id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "synthesize",
      "status": "CREATED",
      "created": "2026-01-01T00:00:00.000Z",
      "last_updated": "2026-01-01T00:00:00.000Z",
      "now": "2026-01-01T00:00:00.000Z",
      "attachment_types": [
        "LOG"
      ]
    }
  ]
}

get

Get Job

Authorizations

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

job_idstringRequired

Responses

200

Success: Job details

application/json

idstring · uuidRequired

engine_idstring · uuid · nullableOptionalDefault: null

typestring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

createdstring · date-time · nullableOptionalDefault: null

last_updatedstring · date-time · nullableOptionalDefault: null

nowstring · date-time · nullableOptionalDefault: null

422

Validation error

application/json

503

Message: unable to fetch engine from external service

get/api/v1/jobs/{job_id}/

GET /api/v1/jobs/{job_id}/ HTTP/1.1
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "engine_id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "synthesize",
  "status": "CREATED",
  "created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z",
  "now": "2026-01-01T00:00:00.000Z",
  "attachment_types": [
    "LOG"
  ]
}

put

Cancel job

Authorizations

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

job_idstringRequired

Responses

200

Success: Job status

application/json

idstring · nullableOptionalDefault: null

codestringRequired

titlestringRequired

bodystring[]Required

durabilitystring · enum · nullableOptionalDefault: temporaryPossible values:

durationinteger · nullableOptionalDefault: 5000

kindstring · enum · nullableOptionalDefault: infoPossible values:

payloadanyOptionalDefault: null

actionobject · Action · nullableOptionalDefault: null

displaystring · enum · nullableOptionalDefault: notificationPossible values:

created_atstring · nullableOptionalDefault: null

422

Validation error

application/json

503

Message: unable to fetch engine from external service

put/api/v1/jobs/{job_id}/cancel/

PUT /api/v1/jobs/{job_id}/cancel/ HTTP/1.1
Accept: */*

{
  "id": "text",
  "code": "text",
  "title": "text",
  "body": [
    "text"
  ],
  "durability": "temporary",
  "duration": 5000,
  "kind": "info",
  "details": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "payload": null,
  "action": {},
  "display": "notification",
  "created_at": "text"
}

delete

Delete job

Authorizations

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

job_idstringRequired

Responses

200

Success: Job status

application/json

idstring · nullableOptionalDefault: null

codestringRequired

titlestringRequired

bodystring[]Required

durabilitystring · enum · nullableOptionalDefault: temporaryPossible values:

durationinteger · nullableOptionalDefault: 5000

kindstring · enum · nullableOptionalDefault: infoPossible values:

payloadanyOptionalDefault: null

actionobject · Action · nullableOptionalDefault: null

displaystring · enum · nullableOptionalDefault: notificationPossible values:

created_atstring · nullableOptionalDefault: null

422

Validation error

application/json

503

Message: unable to fetch engine from external service

delete/api/v1/jobs/{job_id}/delete/

DELETE /api/v1/jobs/{job_id}/delete/ HTTP/1.1
Accept: */*

{
  "id": "text",
  "code": "text",
  "title": "text",
  "body": [
    "text"
  ],
  "durability": "temporary",
  "duration": 5000,
  "kind": "info",
  "details": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "payload": null,
  "action": {},
  "display": "notification",
  "created_at": "text"
}