Jobs | Syntho Documentation

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

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
Host: /
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "engine_id": "123e4567-e89b-12d3-a456-426614174000",
  "workflow_id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "synthesize",
  "status": "STARTED",
  "created": "2025-11-28T15:56:03.053Z",
  "last_updated": "2025-11-28T15:56:03.053Z",
  "settings": "text",
  "now": "2025-11-28T15:56:03.053Z"
}

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
Host: /
Accept: */*

{
  "jobs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "engine_id": "123e4567-e89b-12d3-a456-426614174000",
      "workflow_id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "synthesize",
      "status": "STARTED",
      "created": "2025-11-28T15:56:03.053Z",
      "last_updated": "2025-11-28T15:56:03.053Z",
      "settings": "text",
      "now": "2025-11-28T15:56:03.053Z"
    }
  ]
}

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

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
Host: /
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "engine_id": "123e4567-e89b-12d3-a456-426614174000",
  "workflow_id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "synthesize",
  "status": "STARTED",
  "created": "2025-11-28T15:56:03.053Z",
  "last_updated": "2025-11-28T15:56:03.053Z",
  "settings": "text",
  "now": "2025-11-28T15:56:03.053Z"
}

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

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
Host: /
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "STARTED",
  "reason": "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

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
Host: /
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "STARTED",
  "reason": "text"
}

get

Job logs

Authorizations

sessionidstringRequired

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

Path parameters

job_idstringRequired

Responses

200

Success: Job log

application/json

422

Validation error

application/json

503

Message: unable to fetch engine from external service

get

/api/v1/jobs/{job_id}/download_log/

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "log": "text"
}

Good afternoon