Skip to main content
API docs by Redocly

Lucidtech API (2024-02-02T13:36:49Z)

Download OpenAPI specification:Download

/appClients

Authorizations:
OAuth2
query Parameters
nextToken
string
maxResults
string

Responses

Response samples

Content type
application/json
{
  • "appClients": [
    ],
  • "nextToken": "string"
}

/appClients

Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/appClients

Authorizations:
OAuth2
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
callbackUrls
Array of strings[^http://localhost.*|^https://.*]
defaultLoginUrl
string^http://localhost.*|^https://.*
description
string or null <= 4096 characters
generateSecret
boolean
Default: true
loginUrls
Array of strings[^http://localhost.*|^https://.*]
logoutUrls
Array of strings[^http://localhost.*|^https://.*]
name
string or null <= 4096 characters
roleIds
Array of strings[^las:role:[0-9A-Za-z-_]{1,32}$]

Responses

Request samples

Content type
application/json
{
  • "callbackUrls": [
    ],
  • "defaultLoginUrl": "string",
  • "description": "string",
  • "generateSecret": true,
  • "loginUrls": [
    ],
  • "logoutUrls": [
    ],
  • "name": "string",
  • "roleIds": [
    ]
}

Response samples

Content type
application/json
{
  • "appClientId": "string",
  • "callbackUrls": [
    ],
  • "clientId": "string",
  • "clientSecret": "string",
  • "createdBy": "string",
  • "createdTime": "string",
  • "defaultLoginUrl": "string",
  • "description": "string",
  • "hasSecret": true,
  • "loginUrls": [
    ],
  • "logoutUrls": [
    ],
  • "name": "string",
  • "roleIds": [
    ],
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/appClients/{appClientId}

Authorizations:
OAuth2
path Parameters
appClientId
required
string

Responses

Response samples

Content type
application/json
{
  • "appClientId": "string",
  • "callbackUrls": [
    ],
  • "clientId": "string",
  • "clientSecret": "string",
  • "createdBy": "string",
  • "createdTime": "string",
  • "defaultLoginUrl": "string",
  • "description": "string",
  • "hasSecret": true,
  • "loginUrls": [
    ],
  • "logoutUrls": [
    ],
  • "name": "string",
  • "roleIds": [
    ],
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/appClients/{appClientId}

Authorizations:
OAuth2
path Parameters
appClientId
required
string

Responses

Response samples

Content type
application/json
{
  • "appClientId": "string",
  • "callbackUrls": [
    ],
  • "clientId": "string",
  • "clientSecret": "string",
  • "createdBy": "string",
  • "createdTime": "string",
  • "defaultLoginUrl": "string",
  • "description": "string",
  • "hasSecret": true,
  • "loginUrls": [
    ],
  • "logoutUrls": [
    ],
  • "name": "string",
  • "roleIds": [
    ],
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/appClients/{appClientId}

path Parameters
appClientId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/appClients/{appClientId}

Authorizations:
OAuth2
path Parameters
appClientId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
non-empty
defaultLoginUrl
string^http://localhost.*|^https://.*
description
string or null <= 4096 characters
loginUrls
Array of strings[^http://localhost.*|^https://.*]
name
string or null <= 4096 characters
roleIds
Array of strings[^las:role:[0-9A-Za-z-_]{1,32}$]

Responses

Request samples

Content type
application/json
{
  • "defaultLoginUrl": "string",
  • "description": "string",
  • "loginUrls": [
    ],
  • "name": "string",
  • "roleIds": [
    ]
}

Response samples

Content type
application/json
{
  • "appClientId": "string",
  • "callbackUrls": [
    ],
  • "clientId": "string",
  • "clientSecret": "string",
  • "createdBy": "string",
  • "createdTime": "string",
  • "defaultLoginUrl": "string",
  • "description": "string",
  • "hasSecret": true,
  • "loginUrls": [
    ],
  • "logoutUrls": [
    ],
  • "name": "string",
  • "roleIds": [
    ],
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/assets

Authorizations:
OAuth2
query Parameters
nextToken
string
maxResults
string

Responses

Response samples

Content type
application/json
{
  • "assets": [
    ],
  • "nextToken": "string"
}

/assets

Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/assets

Authorizations:
OAuth2
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
content
required
string [ 1 .. 6250000 ] characters
description
string or null <= 4096 characters
name
string or null <= 4096 characters

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "assetId": "string",
  • "content": "string",
  • "contentMD5": "string",
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "name": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/assets/{assetId}

Authorizations:
OAuth2
path Parameters
assetId
required
string

Responses

Response samples

Content type
application/json
{
  • "assetId": "string",
  • "content": "string",
  • "contentMD5": "string",
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "name": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/assets/{assetId}

Authorizations:
OAuth2
path Parameters
assetId
required
string

Responses

Response samples

Content type
application/json
{
  • "assetId": "string",
  • "content": "string",
  • "contentMD5": "string",
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "name": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/assets/{assetId}

path Parameters
assetId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/assets/{assetId}

Authorizations:
OAuth2
path Parameters
assetId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
non-empty
content
string non-empty
description
string or null <= 4096 characters
name
string or null <= 4096 characters

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "assetId": "string",
  • "content": "string",
  • "contentMD5": "string",
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "name": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/datasets

Authorizations:
OAuth2
query Parameters
nextToken
string
maxResults
string

Responses

Response samples

Content type
application/json
{
  • "datasets": [
    ],
  • "nextToken": "string"
}

/datasets

Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/datasets

Authorizations:
OAuth2
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
containsPersonallyIdentifiableInformation
boolean
description
string or null <= 4096 characters
metadata
object
name
string or null <= 4096 characters
retentionInDays
integer >= 1

Responses

Request samples

Content type
application/json
{
  • "containsPersonallyIdentifiableInformation": true,
  • "description": "string",
  • "metadata": { },
  • "name": "string",
  • "retentionInDays": 1
}

Response samples

Content type
application/json
{
  • "containsPersonallyIdentifiableInformation": true,
  • "createdBy": "string",
  • "createdTime": "string",
  • "datasetId": "string",
  • "description": "string",
  • "groundTruthSummary": { },
  • "metadata": { },
  • "name": "string",
  • "numberOfDocuments": 0,
  • "retentionInDays": 1825,
  • "storageLocation": "EU",
  • "updatedBy": "string",
  • "updatedTime": "string",
  • "version": 0
}

/datasets/{datasetId}

Authorizations:
OAuth2
path Parameters
datasetId
required
string

Responses

Response samples

Content type
application/json
{
  • "containsPersonallyIdentifiableInformation": true,
  • "createdBy": "string",
  • "createdTime": "string",
  • "datasetId": "string",
  • "description": "string",
  • "groundTruthSummary": { },
  • "metadata": { },
  • "name": "string",
  • "numberOfDocuments": 0,
  • "retentionInDays": 1825,
  • "storageLocation": "EU",
  • "updatedBy": "string",
  • "updatedTime": "string",
  • "version": 0
}

/datasets/{datasetId}

Authorizations:
OAuth2
path Parameters
datasetId
required
string

Responses

Response samples

Content type
application/json
{
  • "containsPersonallyIdentifiableInformation": true,
  • "createdBy": "string",
  • "createdTime": "string",
  • "datasetId": "string",
  • "description": "string",
  • "groundTruthSummary": { },
  • "metadata": { },
  • "name": "string",
  • "numberOfDocuments": 0,
  • "retentionInDays": 1825,
  • "storageLocation": "EU",
  • "updatedBy": "string",
  • "updatedTime": "string",
  • "version": 0
}

/datasets/{datasetId}

path Parameters
datasetId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/datasets/{datasetId}

Authorizations:
OAuth2
path Parameters
datasetId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
non-empty
containsPersonallyIdentifiableInformation
boolean
description
string or null <= 4096 characters
metadata
object
name
string or null <= 4096 characters
retentionInDays
integer >= 1

Responses

Request samples

Content type
application/json
{
  • "containsPersonallyIdentifiableInformation": true,
  • "description": "string",
  • "metadata": { },
  • "name": "string",
  • "retentionInDays": 1
}

Response samples

Content type
application/json
{
  • "containsPersonallyIdentifiableInformation": true,
  • "createdBy": "string",
  • "createdTime": "string",
  • "datasetId": "string",
  • "description": "string",
  • "groundTruthSummary": { },
  • "metadata": { },
  • "name": "string",
  • "numberOfDocuments": 0,
  • "retentionInDays": 1825,
  • "storageLocation": "EU",
  • "updatedBy": "string",
  • "updatedTime": "string",
  • "version": 0
}

/datasets/{datasetId}/transformations

Authorizations:
OAuth2
path Parameters
datasetId
required
string
query Parameters
status
string
nextToken
string
maxResults
string

Responses

Response samples

Content type
application/json
{
  • "nextToken": "string",
  • "status": [
    ],
  • "transformations": [
    ]
}

/datasets/{datasetId}/transformations

path Parameters
datasetId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/datasets/{datasetId}/transformations

Authorizations:
OAuth2
path Parameters
datasetId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
Array of objects
Array
options
object
type
required
string
Value: "remove-duplicates"

Responses

Request samples

Content type
application/json
{
  • "operations": [
    ]
}

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "datasetId": "string",
  • "operations": [
    ],
  • "status": "running",
  • "transformationId": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/datasets/{datasetId}/transformations/{transformationId}

path Parameters
datasetId
required
string
transformationId
required
string

Responses

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "datasetId": "string",
  • "operations": [
    ],
  • "status": "running",
  • "transformationId": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/datasets/{datasetId}/transformations/{transformationId}

path Parameters
datasetId
required
string
transformationId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/deploymentEnvironments

Authorizations:
OAuth2
query Parameters
owner
string
nextToken
string
maxResults
string

Responses

Response samples

Content type
application/json
{
  • "deploymentEnvironments": [
    ],
  • "nextToken": "string"
}

/deploymentEnvironments

Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/deploymentEnvironments/{deploymentEnvironmentId}

Authorizations:
OAuth2
path Parameters
deploymentEnvironmentId
required
string

Responses

Response samples

Content type
application/json
{
  • "deploymentEnvironmentId": "string",
  • "description": "string",
  • "modelDeploymentUnits": 0,
  • "name": "string",
  • "organizationId": "string",
  • "status": "available"
}

/deploymentEnvironments/{deploymentEnvironmentId}

path Parameters
deploymentEnvironmentId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/documents

Authorizations:
OAuth2
query Parameters
consentId
string
datasetId
string
nextToken
string
maxResults
string

Responses

Response samples

Content type
application/json
{
  • "consentId": [
    ],
  • "datasetId": [
    ],
  • "documents": [
    ],
  • "nextToken": "string",
  • "order": "ascending",
  • "sortBy": "createdTime"
}

/documents

Authorizations:
OAuth2
query Parameters
datasetId
string
nextToken
string
order
string
documentId
string
consentId
string
maxResults
string
sortBy
string

Responses

Response samples

Content type
application/json
{
  • "consentId": [
    ],
  • "datasetId": [
    ],
  • "documents": [
    ],
  • "nextToken": "string",
  • "order": "ascending",
  • "sortBy": "createdTime"
}

/documents

Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/documents

Authorizations:
OAuth2
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
consentId
string^las:consent:[a-f0-9]{32}$
content
string [ 1 .. 6250000 ] characters
contentType
string or null
Enum: "application/pdf" "image/jpeg" "image/png" "image/tiff"
datasetId
string^las:dataset:[a-f0-9]{32}$
description
string or null <= 4096 characters
Array of objects
metadata
object
name
string or null <= 4096 characters
retentionInDays
integer >= 1

Responses

Request samples

Content type
application/json
{
  • "consentId": "string",
  • "content": "string",
  • "contentType": "application/pdf",
  • "datasetId": "string",
  • "description": "string",
  • "groundTruth": [
    ],
  • "metadata": { },
  • "name": "string",
  • "retentionInDays": 1
}

Response samples

Content type
application/json
{
  • "consentId": "string",
  • "content": "string",
  • "contentMD5": "string",
  • "contentType": "application/pdf",
  • "createdBy": "string",
  • "createdTime": "string",
  • "datasetId": "string",
  • "description": "string",
  • "documentId": "string",
  • "fileUrl": "string",
  • "groundTruth": [
    ],
  • "metadata": { },
  • "name": "string",
  • "retentionInDays": 1,
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/documents/{documentId}

Authorizations:
OAuth2
path Parameters
documentId
required
string

Responses

Response samples

Content type
application/json
{
  • "consentId": "string",
  • "content": "string",
  • "contentMD5": "string",
  • "contentType": "application/pdf",
  • "createdBy": "string",
  • "createdTime": "string",
  • "datasetId": "string",
  • "description": "string",
  • "documentId": "string",
  • "fileUrl": "string",
  • "groundTruth": [
    ],
  • "metadata": { },
  • "name": "string",
  • "retentionInDays": 1,
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/documents/{documentId}

Authorizations:
OAuth2
path Parameters
documentId
required
string

Responses

Response samples

Content type
application/json
{
  • "consentId": "string",
  • "content": "string",
  • "contentMD5": "string",
  • "contentType": "application/pdf",
  • "createdBy": "string",
  • "createdTime": "string",
  • "datasetId": "string",
  • "description": "string",
  • "documentId": "string",
  • "fileUrl": "string",
  • "groundTruth": [
    ],
  • "metadata": { },
  • "name": "string",
  • "retentionInDays": 1,
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/documents/{documentId}

path Parameters
documentId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/documents/{documentId}

Authorizations:
OAuth2
path Parameters
documentId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
non-empty
datasetId
string^las:dataset:[a-f0-9]{32}$
description
string or null <= 4096 characters
Array of objects or null
metadata
object
name
string or null <= 4096 characters
retentionInDays
integer >= 1

Responses

Request samples

Content type
application/json
{
  • "datasetId": "string",
  • "description": "string",
  • "groundTruth": [
    ],
  • "metadata": { },
  • "name": "string",
  • "retentionInDays": 1
}

Response samples

Content type
application/json
{
  • "consentId": "string",
  • "content": "string",
  • "contentMD5": "string",
  • "contentType": "application/pdf",
  • "createdBy": "string",
  • "createdTime": "string",
  • "datasetId": "string",
  • "description": "string",
  • "documentId": "string",
  • "fileUrl": "string",
  • "groundTruth": [
    ],
  • "metadata": { },
  • "name": "string",
  • "retentionInDays": 1,
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/logs

Authorizations:
OAuth2
query Parameters
workflowId
string
nextToken
string
order
string
transitionExecutionId
string
transitionId
string
maxResults
string
workflowExecutionId
string

Responses

Response samples

Content type
application/json
{
  • "logs": [
    ],
  • "nextToken": "string",
  • "order": "ascending",
  • "transitionExecutionId": "string",
  • "transitionId": "string",
  • "workflowExecutionId": "string",
  • "workflowId": "string"
}

/logs

Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/logs/{logId}

Authorizations:
OAuth2
path Parameters
logId
required
string

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "logId": "string",
  • "startTime": "string",
  • "transitionExecutionId": "string",
  • "transitionId": "string",
  • "workflowExecutionId": "string",
  • "workflowId": "string"
}

/logs/{logId}

path Parameters
logId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/models

Authorizations:
OAuth2
query Parameters
owner
string
nextToken
string
maxResults
string

Responses

Response samples

Content type
application/json
{
  • "models": [
    ],
  • "nextToken": "string"
}

/models

Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/models

Authorizations:
OAuth2
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
description
string or null <= 4096 characters
required
object
metadata
object
name
string or null <= 4096 characters
object or object
object non-empty

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "fieldConfig": { },
  • "metadata": { },
  • "name": "string",
  • "postprocessConfig": {
    },
  • "preprocessConfig": {
    }
}

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "fieldConfig": { },
  • "metadata": { },
  • "modelId": "string",
  • "name": "string",
  • "numberOfDataBundles": 0,
  • "numberOfRunningTrainings": 0,
  • "organizationId": "string",
  • "postprocessConfig": {
    },
  • "preprocessConfig": {
    },
  • "statistics": { },
  • "status": "active",
  • "trainingId": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/models/{modelId}

Authorizations:
OAuth2
path Parameters
modelId
required
string

Responses

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "fieldConfig": { },
  • "metadata": { },
  • "modelId": "string",
  • "name": "string",
  • "numberOfDataBundles": 0,
  • "numberOfRunningTrainings": 0,
  • "organizationId": "string",
  • "postprocessConfig": {
    },
  • "preprocessConfig": {
    },
  • "statistics": { },
  • "status": "active",
  • "trainingId": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/models/{modelId}

Authorizations:
OAuth2
path Parameters
modelId
required
string
query Parameters
statisticsLastNDays
string

Responses

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "fieldConfig": { },
  • "metadata": { },
  • "modelId": "string",
  • "name": "string",
  • "numberOfDataBundles": 0,
  • "numberOfRunningTrainings": 0,
  • "organizationId": "string",
  • "postprocessConfig": {
    },
  • "preprocessConfig": {
    },
  • "statistics": { },
  • "status": "active",
  • "trainingId": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/models/{modelId}

path Parameters
modelId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/models/{modelId}

Authorizations:
OAuth2
path Parameters
modelId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
non-empty
description
string or null <= 4096 characters
object
metadata
object
name
string or null <= 4096 characters
object or object
object non-empty
trainingId
string or null^las:model-training:[a-f0-9]{32}$

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "fieldConfig": { },
  • "metadata": { },
  • "name": "string",
  • "postprocessConfig": {
    },
  • "preprocessConfig": {
    },
  • "trainingId": "string"
}

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "fieldConfig": { },
  • "metadata": { },
  • "modelId": "string",
  • "name": "string",
  • "numberOfDataBundles": 0,
  • "numberOfRunningTrainings": 0,
  • "organizationId": "string",
  • "postprocessConfig": {
    },
  • "preprocessConfig": {
    },
  • "statistics": { },
  • "status": "active",
  • "trainingId": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/models/{modelId}/dataBundles

Authorizations:
OAuth2
path Parameters
modelId
required
string
query Parameters
status
string
nextToken
string
maxResults
string

Responses

Response samples

Content type
application/json
{
  • "dataBundles": [
    ],
  • "nextToken": "string",
  • "status": [
    ]
}

/models/{modelId}/dataBundles

path Parameters
modelId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/models/{modelId}/dataBundles

Authorizations:
OAuth2
path Parameters
modelId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
datasetIds
Array of strings non-empty [^las:dataset:[a-f0-9]{32}$]
description
string or null <= 4096 characters
name
string or null <= 4096 characters

Responses

Request samples

Content type
application/json
{
  • "datasetIds": [
    ],
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "dataBundleId": "string",
  • "datasets": [
    ],
  • "description": "string",
  • "modelId": "string",
  • "name": "string",
  • "retentionInDays": 1,
  • "status": "running",
  • "summary": { },
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/models/{modelId}/dataBundles/{dataBundleId}

Authorizations:
OAuth2
path Parameters
dataBundleId
required
string
modelId
required
string

Responses

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "dataBundleId": "string",
  • "datasets": [
    ],
  • "description": "string",
  • "modelId": "string",
  • "name": "string",
  • "retentionInDays": 1,
  • "status": "running",
  • "summary": { },
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/models/{modelId}/dataBundles/{dataBundleId}

Authorizations:
OAuth2
path Parameters
dataBundleId
required
string
modelId
required
string

Responses

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "dataBundleId": "string",
  • "datasets": [
    ],
  • "description": "string",
  • "modelId": "string",
  • "name": "string",
  • "retentionInDays": 1,
  • "status": "running",
  • "summary": { },
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/models/{modelId}/dataBundles/{dataBundleId}

path Parameters
dataBundleId
required
string
modelId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/models/{modelId}/dataBundles/{dataBundleId}

Authorizations:
OAuth2
path Parameters
dataBundleId
required
string
modelId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
non-empty
description
string or null <= 4096 characters
name
string or null <= 4096 characters

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "dataBundleId": "string",
  • "datasets": [
    ],
  • "description": "string",
  • "modelId": "string",
  • "name": "string",
  • "retentionInDays": 1,
  • "status": "running",
  • "summary": { },
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/models/{modelId}/trainings

Authorizations:
OAuth2
path Parameters
modelId
required
string
query Parameters
status
string
nextToken
string
maxResults
string

Responses

Response samples

Content type
application/json
{
  • "nextToken": "string",
  • "status": [
    ],
  • "trainings": [
    ]
}

/models/{modelId}/trainings

path Parameters
modelId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/models/{modelId}/trainings

Authorizations:
OAuth2
path Parameters
modelId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
dataBundleIds
Array of strings non-empty [^las:model-data-bundle:[a-f0-9]{32}$]
dataScientistAssistance
boolean
description
string or null <= 4096 characters
instanceType
string or null
Enum: "small-gpu" "medium-gpu" "large-gpu"
metadata
object
name
string or null <= 4096 characters
object

Responses

Request samples

Content type
application/json
{
  • "dataBundleIds": [
    ],
  • "dataScientistAssistance": true,
  • "description": "string",
  • "instanceType": "small-gpu",
  • "metadata": { },
  • "name": "string",
  • "warmStartConfig": {
    }
}

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "dataBundleIds": [
    ],
  • "dataScientistAssistance": true,
  • "deploymentEnvironmentId": "string",
  • "description": "string",
  • "evaluation": { },
  • "gpuHours": 0,
  • "instanceType": "small-gpu",
  • "metadata": { },
  • "modelId": "string",
  • "name": "string",
  • "status": "waiting-for-approval",
  • "trainingId": "string",
  • "updatedBy": "string",
  • "updatedTime": "string",
  • "warmStartConfig": {
    }
}

/models/{modelId}/trainings/{trainingId}

Authorizations:
OAuth2
path Parameters
modelId
required
string
trainingId
required
string

Responses

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "dataBundleIds": [
    ],
  • "dataScientistAssistance": true,
  • "deploymentEnvironmentId": "string",
  • "description": "string",
  • "evaluation": { },
  • "gpuHours": 0,
  • "instanceType": "small-gpu",
  • "metadata": { },
  • "modelId": "string",
  • "name": "string",
  • "status": "waiting-for-approval",
  • "trainingId": "string",
  • "updatedBy": "string",
  • "updatedTime": "string",
  • "warmStartConfig": {
    }
}

/models/{modelId}/trainings/{trainingId}

path Parameters
modelId
required
string
trainingId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/models/{modelId}/trainings/{trainingId}

Authorizations:
OAuth2
path Parameters
modelId
required
string
trainingId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
non-empty
deploymentEnvironmentId
string or null^(|las:organization:[a-z0-9-_]+/)las:deployme...
description
string or null <= 4096 characters
metadata
object
name
string or null <= 4096 characters
status
string
Value: "cancelled"

Responses

Request samples

Content type
application/json
{
  • "deploymentEnvironmentId": "string",
  • "description": "string",
  • "metadata": { },
  • "name": "string",
  • "status": "cancelled"
}

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "dataBundleIds": [
    ],
  • "dataScientistAssistance": true,
  • "deploymentEnvironmentId": "string",
  • "description": "string",
  • "evaluation": { },
  • "gpuHours": 0,
  • "instanceType": "small-gpu",
  • "metadata": { },
  • "modelId": "string",
  • "name": "string",
  • "status": "waiting-for-approval",
  • "trainingId": "string",
  • "updatedBy": "string",
  • "updatedTime": "string",
  • "warmStartConfig": {
    }
}

/organizations

Authorizations:
OAuth2
query Parameters
nextToken
string
maxResults
string

Responses

Response samples

Content type
application/json
{
  • "nextToken": "string",
  • "organizations": [
    ]
}

/organizations

Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/organizations

Authorizations:
OAuth2
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
name
string or null <= 4096 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "clientId": "string",
  • "deploymentsAllowed": { },
  • "deploymentsCreated": { },
  • "description": "string",
  • "documentRetentionInDays": 1,
  • "monthlyNumberOfActiveModelsUsed": 0,
  • "monthlyNumberOfDataBundlesAllowed": 0,
  • "monthlyNumberOfDataBundlesCreated": 0,
  • "monthlyNumberOfDocumentsAllowed": 0,
  • "monthlyNumberOfDocumentsCreated": 0,
  • "monthlyNumberOfFieldPredictionsAllowed": 0,
  • "monthlyNumberOfFieldPredictionsUsed": 0,
  • "monthlyNumberOfGpuHoursUsed": 0,
  • "monthlyNumberOfModelDeploymentUnitsUsed": 0,
  • "monthlyNumberOfPagePredictionsAllowed": 0,
  • "monthlyNumberOfPagePredictionsUsed": 0,
  • "monthlyNumberOfPredictionsAllowed": 0,
  • "monthlyNumberOfPredictionsCreated": 0,
  • "monthlyNumberOfProductionWorkflowMinutesUsed": 0,
  • "monthlyNumberOfTrainingsAllowed": 0,
  • "monthlyNumberOfTrainingsCreated": 0,
  • "monthlyNumberOfTransformationsAllowed": 0,
  • "monthlyNumberOfTransformationsCreated": 0,
  • "monthlyNumberOfTransitionExecutionsAllowed": 0,
  • "monthlyNumberOfTransitionExecutionsCreated": 0,
  • "monthlyNumberOfUserMinutesUsed": 0,
  • "monthlyNumberOfWorkflowExecutionsAllowed": 0,
  • "monthlyNumberOfWorkflowExecutionsCreated": 0,
  • "monthlyUsageSummary": { },
  • "name": "string",
  • "numberOfAppClientsAllowed": 0,
  • "numberOfAppClientsCreated": 0,
  • "numberOfAssetsAllowed": 0,
  • "numberOfAssetsCreated": 0,
  • "numberOfDatasetsAllowed": 0,
  • "numberOfDatasetsCreated": 0,
  • "numberOfModelsAllowed": 0,
  • "numberOfModelsCreated": 0,
  • "numberOfSecretsAllowed": 0,
  • "numberOfSecretsCreated": 0,
  • "numberOfTransitionsAllowed": 0,
  • "numberOfTransitionsCreated": 0,
  • "numberOfUsersAllowed": 0,
  • "numberOfUsersCreated": 0,
  • "numberOfWorkflowsAllowed": 0,
  • "numberOfWorkflowsCreated": 0,
  • "organizationId": "string",
  • "paymentMethodId": "string",
  • "planId": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/organizations/{organizationId}

Authorizations:
OAuth2
path Parameters
organizationId
required
string

Responses

Response samples

Content type
application/json
{
  • "clientId": "string",
  • "deploymentsAllowed": { },
  • "deploymentsCreated": { },
  • "description": "string",
  • "documentRetentionInDays": 1,
  • "monthlyNumberOfActiveModelsUsed": 0,
  • "monthlyNumberOfDataBundlesAllowed": 0,
  • "monthlyNumberOfDataBundlesCreated": 0,
  • "monthlyNumberOfDocumentsAllowed": 0,
  • "monthlyNumberOfDocumentsCreated": 0,
  • "monthlyNumberOfFieldPredictionsAllowed": 0,
  • "monthlyNumberOfFieldPredictionsUsed": 0,
  • "monthlyNumberOfGpuHoursUsed": 0,
  • "monthlyNumberOfModelDeploymentUnitsUsed": 0,
  • "monthlyNumberOfPagePredictionsAllowed": 0,
  • "monthlyNumberOfPagePredictionsUsed": 0,
  • "monthlyNumberOfPredictionsAllowed": 0,
  • "monthlyNumberOfPredictionsCreated": 0,
  • "monthlyNumberOfProductionWorkflowMinutesUsed": 0,
  • "monthlyNumberOfTrainingsAllowed": 0,
  • "monthlyNumberOfTrainingsCreated": 0,
  • "monthlyNumberOfTransformationsAllowed": 0,
  • "monthlyNumberOfTransformationsCreated": 0,
  • "monthlyNumberOfTransitionExecutionsAllowed": 0,
  • "monthlyNumberOfTransitionExecutionsCreated": 0,
  • "monthlyNumberOfUserMinutesUsed": 0,
  • "monthlyNumberOfWorkflowExecutionsAllowed": 0,
  • "monthlyNumberOfWorkflowExecutionsCreated": 0,
  • "monthlyUsageSummary": { },
  • "name": "string",
  • "numberOfAppClientsAllowed": 0,
  • "numberOfAppClientsCreated": 0,
  • "numberOfAssetsAllowed": 0,
  • "numberOfAssetsCreated": 0,
  • "numberOfDatasetsAllowed": 0,
  • "numberOfDatasetsCreated": 0,
  • "numberOfModelsAllowed": 0,
  • "numberOfModelsCreated": 0,
  • "numberOfSecretsAllowed": 0,
  • "numberOfSecretsCreated": 0,
  • "numberOfTransitionsAllowed": 0,
  • "numberOfTransitionsCreated": 0,
  • "numberOfUsersAllowed": 0,
  • "numberOfUsersCreated": 0,
  • "numberOfWorkflowsAllowed": 0,
  • "numberOfWorkflowsCreated": 0,
  • "organizationId": "string",
  • "paymentMethodId": "string",
  • "planId": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/organizations/{organizationId}

path Parameters
organizationId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/organizations/{organizationId}

Authorizations:
OAuth2
path Parameters
organizationId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
non-empty
description
string or null <= 4096 characters
name
string or null <= 4096 characters
paymentMethodId
string or null^las:payment-method:[a-f0-9]{32}$
planId
string^(|las:organization:[a-z0-9-_]+/)las:plan:[a-...

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "paymentMethodId": "string",
  • "planId": "string"
}

Response samples

Content type
application/json
{
  • "clientId": "string",
  • "deploymentsAllowed": { },
  • "deploymentsCreated": { },
  • "description": "string",
  • "documentRetentionInDays": 1,
  • "monthlyNumberOfActiveModelsUsed": 0,
  • "monthlyNumberOfDataBundlesAllowed": 0,
  • "monthlyNumberOfDataBundlesCreated": 0,
  • "monthlyNumberOfDocumentsAllowed": 0,
  • "monthlyNumberOfDocumentsCreated": 0,
  • "monthlyNumberOfFieldPredictionsAllowed": 0,
  • "monthlyNumberOfFieldPredictionsUsed": 0,
  • "monthlyNumberOfGpuHoursUsed": 0,
  • "monthlyNumberOfModelDeploymentUnitsUsed": 0,
  • "monthlyNumberOfPagePredictionsAllowed": 0,
  • "monthlyNumberOfPagePredictionsUsed": 0,
  • "monthlyNumberOfPredictionsAllowed": 0,
  • "monthlyNumberOfPredictionsCreated": 0,
  • "monthlyNumberOfProductionWorkflowMinutesUsed": 0,
  • "monthlyNumberOfTrainingsAllowed": 0,
  • "monthlyNumberOfTrainingsCreated": 0,
  • "monthlyNumberOfTransformationsAllowed": 0,
  • "monthlyNumberOfTransformationsCreated": 0,
  • "monthlyNumberOfTransitionExecutionsAllowed": 0,
  • "monthlyNumberOfTransitionExecutionsCreated": 0,
  • "monthlyNumberOfUserMinutesUsed": 0,
  • "monthlyNumberOfWorkflowExecutionsAllowed": 0,
  • "monthlyNumberOfWorkflowExecutionsCreated": 0,
  • "monthlyUsageSummary": { },
  • "name": "string",
  • "numberOfAppClientsAllowed": 0,
  • "numberOfAppClientsCreated": 0,
  • "numberOfAssetsAllowed": 0,
  • "numberOfAssetsCreated": 0,
  • "numberOfDatasetsAllowed": 0,
  • "numberOfDatasetsCreated": 0,
  • "numberOfModelsAllowed": 0,
  • "numberOfModelsCreated": 0,
  • "numberOfSecretsAllowed": 0,
  • "numberOfSecretsCreated": 0,
  • "numberOfTransitionsAllowed": 0,
  • "numberOfTransitionsCreated": 0,
  • "numberOfUsersAllowed": 0,
  • "numberOfUsersCreated": 0,
  • "numberOfWorkflowsAllowed": 0,
  • "numberOfWorkflowsCreated": 0,
  • "organizationId": "string",
  • "paymentMethodId": "string",
  • "planId": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/paymentMethods

Authorizations:
OAuth2
query Parameters
nextToken
string
maxResults
string

Responses

Response samples

Content type
application/json
{
  • "nextToken": "string",
  • "paymentMethods": [
    ]
}

/paymentMethods

Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/paymentMethods

Authorizations:
OAuth2
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
description
string or null <= 4096 characters
name
string or null <= 4096 characters

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "details": { },
  • "name": "string",
  • "paymentMethodId": "string",
  • "stripePublishableKey": "string",
  • "stripeSetupIntentSecret": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/paymentMethods/{paymentMethodId}

Authorizations:
OAuth2
path Parameters
paymentMethodId
required
string

Responses

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "details": { },
  • "name": "string",
  • "paymentMethodId": "string",
  • "stripePublishableKey": "string",
  • "stripeSetupIntentSecret": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/paymentMethods/{paymentMethodId}

Authorizations:
OAuth2
path Parameters
paymentMethodId
required
string

Responses

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "details": { },
  • "name": "string",
  • "paymentMethodId": "string",
  • "stripePublishableKey": "string",
  • "stripeSetupIntentSecret": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/paymentMethods/{paymentMethodId}

path Parameters
paymentMethodId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/paymentMethods/{paymentMethodId}

Authorizations:
OAuth2
path Parameters
paymentMethodId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
non-empty
description
string or null <= 4096 characters
name
string or null <= 4096 characters
stripeSetupIntentSecret
string non-empty

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "stripeSetupIntentSecret": "string"
}

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "details": { },
  • "name": "string",
  • "paymentMethodId": "string",
  • "stripePublishableKey": "string",
  • "stripeSetupIntentSecret": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/plans

Authorizations:
OAuth2
query Parameters
owner
string
nextToken
string
maxResults
string

Responses

Response samples

Content type
application/json
{
  • "nextToken": "string",
  • "plans": [
    ]
}

/plans

Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/plans/{planId}

Authorizations:
OAuth2
path Parameters
planId
required
string

Responses

Response samples

Content type
application/json
{
  • "activeModels": { },
  • "available": true,
  • "currency": "USD",
  • "description": "string",
  • "fieldPredictions": { },
  • "flows": { },
  • "gpuHours": { },
  • "latest": 1,
  • "license": { },
  • "modelDeploymentUnits": { },
  • "name": "string",
  • "organizationId": "string",
  • "pagePredictions": { },
  • "planId": "string",
  • "productionWorkflowMinutes": { },
  • "userMinutes": { },
  • "users": { }
}

/plans/{planId}

path Parameters
planId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/predictions

Authorizations:
OAuth2
query Parameters
nextToken
string
maxResults
string
sortBy
string
order
string
modelId
string

Responses

Response samples

Content type
application/json
{
  • "modelId": "string",
  • "nextToken": "string",
  • "order": "ascending",
  • "predictions": [
    ],
  • "sortBy": "createdTime"
}

/predictions

Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/predictions

Authorizations:
OAuth2
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
autoRotate
boolean
documentId
required
string^las:document:[a-f0-9]{32}$
imageQuality
string
Enum: "LOW" "HIGH"
maxPages
integer [ 1 .. 3 ]
modelId
required
string^(|las:organization:[a-z0-9-_]+/)las:model:[a...
object or object
object non-empty
rotation
integer
Enum: 0 90 180 270
trainingId
string^las:model-training:[a-f0-9]{32}$

Responses

Request samples

Content type
application/json
{
  • "autoRotate": true,
  • "documentId": "string",
  • "imageQuality": "LOW",
  • "maxPages": 1,
  • "modelId": "string",
  • "postprocessConfig": {
    },
  • "preprocessConfig": {
    },
  • "rotation": 0,
  • "trainingId": "string"
}

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "documentId": "string",
  • "inferenceTime": 0,
  • "modelId": "string",
  • "nextPage": 0,
  • "postprocessConfig": {
    },
  • "predictionId": "string",
  • "predictions": [
    ],
  • "preprocessConfig": {
    },
  • "trainingId": "string"
}

/profiles/{profileId}

Authorizations:
OAuth2
path Parameters
profileId
required
string

Responses

Response samples

Content type
application/json
{
  • "createdTime": "string",
  • "email": "string",
  • "familyName": "string",
  • "givenName": "string",
  • "locale": "string",
  • "metadata": { },
  • "name": "string",
  • "numberOfOrganizationsAllowed": 0,
  • "numberOfOrganizationsCreated": 0,
  • "picture": "string",
  • "profileId": "string",
  • "updatedTime": "string"
}

/profiles/{profileId}

path Parameters
profileId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/profiles/{profileId}

Authorizations:
OAuth2
path Parameters
profileId
required
string

Responses

Response samples

Content type
application/json
{
  • "createdTime": "string",
  • "email": "string",
  • "familyName": "string",
  • "givenName": "string",
  • "locale": "string",
  • "metadata": { },
  • "name": "string",
  • "numberOfOrganizationsAllowed": 0,
  • "numberOfOrganizationsCreated": 0,
  • "picture": "string",
  • "profileId": "string",
  • "updatedTime": "string"
}

/roles

query Parameters
nextToken
string
maxResults
string

Responses

Response samples

Content type
application/json
{
  • "nextToken": "string",
  • "roles": [
    ]
}

/roles

Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/roles/{roleId}

Authorizations:
OAuth2
path Parameters
roleId
required
string

Responses

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "name": "string",
  • "permissions": [
    ],
  • "roleId": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/roles/{roleId}

path Parameters
roleId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/secrets

Authorizations:
OAuth2
query Parameters
nextToken
string
maxResults
string

Responses

Response samples

Content type
application/json
{
  • "nextToken": "string",
  • "secrets": [
    ]
}

/secrets

Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/secrets

Authorizations:
OAuth2
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
data
required
object
description
string or null <= 4096 characters
name
string or null <= 4096 characters

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "name": "string",
  • "secretId": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/secrets/{secretId}

path Parameters
secretId
required
string

Responses

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "name": "string",
  • "secretId": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/secrets/{secretId}

path Parameters
secretId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/secrets/{secretId}

Authorizations:
OAuth2
path Parameters
secretId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
non-empty
data
object
description
string or null <= 4096 characters
name
string or null <= 4096 characters

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "name": "string",
  • "secretId": "string",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/transitions

Authorizations:
OAuth2
query Parameters
transitionType
string
nextToken
string
maxResults
string

Responses

Response samples

Content type
application/json
{
  • "nextToken": "string",
  • "transitionType": [
    ],
  • "transitions": [
    ]
}

/transitions

Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/transitions

Authorizations:
OAuth2
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
description
string or null <= 4096 characters
inputJsonSchema
object
name
string or null <= 4096 characters
outputJsonSchema
object
object or object
timeoutInSeconds
integer [ 60 .. 3600 ]
transitionType
required
string
Enum: "docker" "manual"

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "inputJsonSchema": { },
  • "name": "string",
  • "outputJsonSchema": { },
  • "parameters": {
    },
  • "timeoutInSeconds": 60,
  • "transitionType": "docker"
}

Response samples

Content type
application/json
{
  • "assets": {
    },
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "inputJsonSchema": { },
  • "name": "string",
  • "outputJsonSchema": { },
  • "parameters": { },
  • "timeoutInSeconds": 60,
  • "transitionId": "string",
  • "transitionType": "docker",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/transitions/{transitionId}

Authorizations:
OAuth2
path Parameters
transitionId
required
string

Responses

Response samples

Content type
application/json
{
  • "assets": {
    },
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "inputJsonSchema": { },
  • "name": "string",
  • "outputJsonSchema": { },
  • "parameters": { },
  • "timeoutInSeconds": 60,
  • "transitionId": "string",
  • "transitionType": "docker",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/transitions/{transitionId}

Authorizations:
OAuth2
path Parameters
transitionId
required
string

Responses

Response samples

Content type
application/json
{
  • "assets": {
    },
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "inputJsonSchema": { },
  • "name": "string",
  • "outputJsonSchema": { },
  • "parameters": { },
  • "timeoutInSeconds": 60,
  • "transitionId": "string",
  • "transitionType": "docker",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/transitions/{transitionId}

path Parameters
transitionId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/transitions/{transitionId}

Authorizations:
OAuth2
path Parameters
transitionId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
non-empty
object
description
string or null <= 4096 characters
object
environmentSecrets
Array of strings[^las:secret:[a-f0-9]{32}$]
inputJsonSchema
object
name
string or null <= 4096 characters
outputJsonSchema
object
object or object

Responses

Request samples

Content type
application/json
{
  • "assets": {
    },
  • "description": "string",
  • "environment": {
    },
  • "environmentSecrets": [
    ],
  • "inputJsonSchema": { },
  • "name": "string",
  • "outputJsonSchema": { },
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "assets": {
    },
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "inputJsonSchema": { },
  • "name": "string",
  • "outputJsonSchema": { },
  • "parameters": { },
  • "timeoutInSeconds": 60,
  • "transitionId": "string",
  • "transitionType": "docker",
  • "updatedBy": "string",
  • "updatedTime": "string"
}

/transitions/{transitionId}/executions

Authorizations:
OAuth2
path Parameters
transitionId
required
string
query Parameters
nextToken
string
order
string
executionId
string
status
string
maxResults
string
sortBy
string

Responses

Response samples

Content type
application/json
{
  • "executions": [
    ],
  • "nextToken": "string",
  • "status": [
    ],
  • "transitionId": "string"
}

/transitions/{transitionId}/executions

path Parameters
transitionId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/transitions/{transitionId}/executions

Authorizations:
OAuth2
path Parameters
transitionId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
object (POST /transitions/{transitionId}/executions)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "completedBy": "string",
  • "endTime": "string",
  • "executionId": "string",
  • "input": { },
  • "logId": "string",
  • "startTime": "string",
  • "status": "running",
  • "transitionId": "string"
}

/transitions/{transitionId}/executions/{executionId}

Authorizations:
OAuth2
path Parameters
transitionId
required
string
executionId
required
string

Responses

Response samples

Content type
application/json
{
  • "completedBy": "string",
  • "endTime": "string",
  • "executionId": "string",
  • "input": { },
  • "logId": "string",
  • "startTime": "string",
  • "status": "running",
  • "transitionId": "string"
}

/transitions/{transitionId}/executions/{executionId}

path Parameters
transitionId
required
string
executionId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/transitions/{transitionId}/executions/{executionId}

Authorizations:
OAuth2
path Parameters
transitionId
required
string
executionId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
Any of
status
string
Value: "succeeded"
object
output
object
startTime
string or null^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?...

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "error": {
    },
  • "output": { },
  • "startTime": "string"
}

Response samples

Content type
application/json
{
  • "completedBy": "string",
  • "endTime": "string",
  • "executionId": "string",
  • "input": { },
  • "logId": "string",
  • "startTime": "string",
  • "status": "running",
  • "transitionId": "string"
}

/transitions/{transitionId}/executions/{executionId}/heartbeats

path Parameters
transitionId
required
string
executionId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/transitions/{transitionId}/executions/{executionId}/heartbeats

Authorizations:
OAuth2
path Parameters
transitionId
required
string
executionId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
object (POST /transitions/{transitionId}/executions/{executionId}/heartbeats)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/users

Authorizations:
OAuth2
query Parameters
nextToken
string
maxResults
string

Responses

Response samples

Content type
application/json
{
  • "nextToken": "string",
  • "users": [
    ]
}

/users

Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/users

Authorizations:
OAuth2
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
appClientId
string^las:app-client:[a-z0-9-_]+$
email
required
string^[A-Za-z0-9][-+._A-Za-z0-9]*@([-_.A-Za-z0-9]+...
metadata
object
roleIds
Array of strings[^las:role:[0-9A-Za-z-_]{1,32}$]

Responses

Request samples

Content type
application/json
{
  • "appClientId": "string",
  • "email": "string",
  • "metadata": { },
  • "roleIds": [
    ]
}

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "metadata": { },
  • "profileId": "string",
  • "roleIds": [
    ],
  • "status": "inactive",
  • "updatedBy": "string",
  • "updatedTime": "string",
  • "userId": "string"
}

/users/{userId}

Authorizations:
OAuth2
path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "metadata": { },
  • "profileId": "string",
  • "roleIds": [
    ],
  • "status": "inactive",
  • "updatedBy": "string",
  • "updatedTime": "string",
  • "userId": "string"
}

/users/{userId}

Authorizations:
OAuth2
path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "metadata": { },
  • "profileId": "string",
  • "roleIds": [
    ],
  • "status": "inactive",
  • "updatedBy": "string",
  • "updatedTime": "string",
  • "userId": "string"
}

/users/{userId}

path Parameters
userId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/users/{userId}

Authorizations:
OAuth2
path Parameters
userId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
non-empty
metadata
object
roleIds
Array of strings[^las:role:[0-9A-Za-z-_]{1,32}$]

Responses

Request samples

Content type
application/json
{
  • "metadata": { },
  • "roleIds": [
    ]
}

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdTime": "string",
  • "metadata": { },
  • "profileId": "string",
  • "roleIds": [
    ],
  • "status": "inactive",
  • "updatedBy": "string",
  • "updatedTime": "string",
  • "userId": "string"
}

/workflows

Authorizations:
OAuth2
query Parameters
nextToken
string
maxResults
string

Responses

Response samples

Content type
application/json
{
  • "nextToken": "string",
  • "workflows": [
    ]
}

/workflows

Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/workflows

Authorizations:
OAuth2
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
object
description
string or null <= 4096 characters
object
object
metadata
object
name
string or null <= 4096 characters
required
object
status
string
Enum: "development" "production"

Responses

Request samples

Content type
application/json
{
  • "completedConfig": {
    },
  • "description": "string",
  • "emailConfig": {
    },
  • "errorConfig": {
    },
  • "metadata": { },
  • "name": "string",
  • "specification": {
    },
  • "status": "development"
}

Response samples

Content type
application/json
{
  • "completedConfig": {
    },
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "emailConfig": {
    },
  • "errorConfig": {
    },
  • "metadata": { },
  • "monthlyNumberOfWorkflowExecutionsAllowed": 0,
  • "monthlyNumberOfWorkflowExecutionsCreated": 0,
  • "name": "string",
  • "numberOfRunningExecutions": 0,
  • "status": "development",
  • "updatedBy": "string",
  • "updatedTime": "string",
  • "workflowId": "string"
}

/workflows/{workflowId}

Authorizations:
OAuth2
path Parameters
workflowId
required
string

Responses

Response samples

Content type
application/json
{
  • "completedConfig": {
    },
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "emailConfig": {
    },
  • "errorConfig": {
    },
  • "metadata": { },
  • "monthlyNumberOfWorkflowExecutionsAllowed": 0,
  • "monthlyNumberOfWorkflowExecutionsCreated": 0,
  • "name": "string",
  • "numberOfRunningExecutions": 0,
  • "status": "development",
  • "updatedBy": "string",
  • "updatedTime": "string",
  • "workflowId": "string"
}

/workflows/{workflowId}

Authorizations:
OAuth2
path Parameters
workflowId
required
string

Responses

Response samples

Content type
application/json
{
  • "completedConfig": {
    },
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "emailConfig": {
    },
  • "errorConfig": {
    },
  • "metadata": { },
  • "monthlyNumberOfWorkflowExecutionsAllowed": 0,
  • "monthlyNumberOfWorkflowExecutionsCreated": 0,
  • "name": "string",
  • "numberOfRunningExecutions": 0,
  • "status": "development",
  • "updatedBy": "string",
  • "updatedTime": "string",
  • "workflowId": "string"
}

/workflows/{workflowId}

path Parameters
workflowId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/workflows/{workflowId}

Authorizations:
OAuth2
path Parameters
workflowId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
non-empty
object
description
string or null <= 4096 characters
object or null
object
metadata
object
name
string or null <= 4096 characters
status
string
Enum: "development" "production"

Responses

Request samples

Content type
application/json
{
  • "completedConfig": {
    },
  • "description": "string",
  • "emailConfig": {
    },
  • "errorConfig": {
    },
  • "metadata": { },
  • "name": "string",
  • "status": "development"
}

Response samples

Content type
application/json
{
  • "completedConfig": {
    },
  • "createdBy": "string",
  • "createdTime": "string",
  • "description": "string",
  • "emailConfig": {
    },
  • "errorConfig": {
    },
  • "metadata": { },
  • "monthlyNumberOfWorkflowExecutionsAllowed": 0,
  • "monthlyNumberOfWorkflowExecutionsCreated": 0,
  • "name": "string",
  • "numberOfRunningExecutions": 0,
  • "status": "development",
  • "updatedBy": "string",
  • "updatedTime": "string",
  • "workflowId": "string"
}

/workflows/{workflowId}/executions

Authorizations:
OAuth2
path Parameters
workflowId
required
string
query Parameters
fromStartTime
string
toStartTime
string
nextToken
string
order
string
status
string
maxResults
string
sortBy
string

Responses

Response samples

Content type
application/json
{
  • "executions": [
    ],
  • "nextToken": "string",
  • "order": "ascending",
  • "sortBy": "startTime",
  • "status": [
    ],
  • "workflowId": "string"
}

/workflows/{workflowId}/executions

path Parameters
workflowId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/workflows/{workflowId}/executions

Authorizations:
OAuth2
path Parameters
workflowId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
input
required
object

Responses

Request samples

Content type
application/json
{
  • "input": { }
}

Response samples

Content type
application/json
{
  • "completedBy": [
    ],
  • "completedTaskLogId": "string",
  • "createdBy": "string",
  • "endTime": "string",
  • "events": [
    ],
  • "executionId": "string",
  • "input": { },
  • "logId": "string",
  • "output": { },
  • "startTime": "string",
  • "status": "running",
  • "transitionExecutions": { },
  • "workflowId": "string"
}

/workflows/{workflowId}/executions/{executionId}

Authorizations:
OAuth2
path Parameters
executionId
required
string
workflowId
required
string

Responses

Response samples

Content type
application/json
{
  • "completedBy": [
    ],
  • "completedTaskLogId": "string",
  • "createdBy": "string",
  • "endTime": "string",
  • "events": [
    ],
  • "executionId": "string",
  • "input": { },
  • "logId": "string",
  • "output": { },
  • "startTime": "string",
  • "status": "running",
  • "transitionExecutions": { },
  • "workflowId": "string"
}

/workflows/{workflowId}/executions/{executionId}

Authorizations:
OAuth2
path Parameters
executionId
required
string
workflowId
required
string

Responses

Response samples

Content type
application/json
{
  • "completedBy": [
    ],
  • "completedTaskLogId": "string",
  • "createdBy": "string",
  • "endTime": "string",
  • "events": [
    ],
  • "executionId": "string",
  • "input": { },
  • "logId": "string",
  • "output": { },
  • "startTime": "string",
  • "status": "running",
  • "transitionExecutions": { },
  • "workflowId": "string"
}

/workflows/{workflowId}/executions/{executionId}

path Parameters
executionId
required
string
workflowId
required
string
Request Body schema: application/json
required
object (Empty Schema)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/workflows/{workflowId}/executions/{executionId}

Authorizations:
OAuth2
path Parameters
executionId
required
string
workflowId
required
string
header Parameters
Content-Type
required
string
Request Body schema: application/json
required
string or string
status
string
Enum: "succeeded" "completed"

Responses

Request samples

Content type
application/json
{
  • "nextTransitionId": "string",
  • "status": "succeeded"
}

Response samples

Content type
application/json
{
  • "completedBy": [
    ],
  • "completedTaskLogId": "string",
  • "createdBy": "string",
  • "endTime": "string",
  • "events": [
    ],
  • "executionId": "string",
  • "input": { },
  • "logId": "string",
  • "output": { },
  • "startTime": "string",
  • "status": "running",
  • "transitionExecutions": { },
  • "workflowId": "string"
}