Synthesize

post

Start Synthesize

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

engine_idstringRequired

Query parameters

generate_batch_sizeintegerOptionalDefault: 10000

n_connectionsintegerOptionalDefault: 1

write_batch_sizeintegerOptionalDefault: 10000

Responses

200

Success: Job status

application/json

422

Validation error

application/json

503

Message: unable to fetch engine from external service

post

/api/v1/synthesize/{engine_id}/start/

HTTPcURLJavaScriptPython

POST /api/v1/synthesize/{engine_id}/start/ HTTP/1.1
Host: /
Accept: */*

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

get

Get Job Summary

Authorizations

authenticationOIDC

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

get

/api/v1/synthesize/{job_id}/summary/

HTTPcURLJavaScriptPython

GET /api/v1/synthesize/{job_id}/summary/ HTTP/1.1
Host: /
Accept: */*

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