Synthesize

post

Start Synthesize

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

engine_idstringRequired

Body

application/json

functionalitiesany · nullableOptional

write_batch_sizeintegerOptionalDefault: 10000

generate_batch_sizeintegerOptionalDefault: 10000

n_connectionsintegerOptionalDefault: 1

Responses

200

Success: Job status

application/json

idany ofOptionalDefault: null

string · uuidOptional

or

nullOptional

statusany ofOptionalDefault: null

string · enumOptionalPossible values:

or

nullOptional

reasonany ofOptionalDefault: null

stringOptional

or

nullOptional

400

Connection validation error

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
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "functionalities": null,
  "write_batch_size": 10000,
  "generate_batch_size": 10000,
  "n_connections": 1
}

{
  "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

idany ofOptionalDefault: null

string · uuidOptional

or

nullOptional

engine_idany ofOptionalDefault: null

string · uuidOptional

or

nullOptional

statusany ofOptionalDefault: null

stringOptional

or

nullOptional

summaryany ofOptionalDefault: null

stringOptional

or

objectOptional

or

nullOptional

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

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