Lucidtech API (2024-11-29T08:05:46Z)

Download OpenAPI specification:Download

/appClients

Authorizations:

OAuth2

query Parameters

nextToken	string
maxResults	string

Responses

Response samples

Content type

application/json

{"appClients": [{"appClientId": "string",
"callbackUrls": ["string"
],
"clientId": "string",
"clientSecret": "string",
"createdBy": "string",
"createdTime": "string",
"defaultLoginUrl": "string",
"description": "string",
"hasSecret": true,
"loginUrls": ["string"
],
"logoutUrls": ["string"
],
"name": "string",
"roleIds": ["string"
],
"updatedBy": "string",
"updatedTime": "string"
}
],
"nextToken": "string"
}

/appClients

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{"callbackUrls": ["string"
],
"defaultLoginUrl": "string",
"description": "string",
"generateSecret": true,
"loginUrls": ["string"
],
"logoutUrls": ["string"
],
"name": "string",
"roleIds": ["string"
]
}

Response samples

Content type

application/json

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

/appClients/{appClientId}

Authorizations:

OAuth2

path Parameters

appClientId

required

string

Responses

Response samples

Content type

application/json

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

/appClients/{appClientId}

Authorizations:

OAuth2

path Parameters

appClientId

required

string

Responses

Response samples

Content type

application/json

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

/appClients/{appClientId}

path Parameters

appClientId

required

string

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{"defaultLoginUrl": "string",
"description": "string",
"loginUrls": ["string"
],
"name": "string",
"roleIds": ["string"
]
}

Response samples

Content type

application/json

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

/assets

Authorizations:

OAuth2

query Parameters

nextToken	string
maxResults	string

Responses

Response samples

Content type

application/json

{"assets": [{"assetId": "string",
"content": "string",
"contentMD5": "string",
"createdBy": "string",
"createdTime": "string",
"description": "string",
"name": "string",
"updatedBy": "string",
"updatedTime": "string"
}
],
"nextToken": "string"
}

/assets

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

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

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

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": [{"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
}
],
"nextToken": "string"
}

/datasets

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

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

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

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": ["running"
],
"transformations": [{"createdBy": "string",
"createdTime": "string",
"datasetId": "string",
"operations": [{"options": { },
"type": "remove-duplicates"
}
],
"status": "running",
"transformationId": "string",
"updatedBy": "string",
"updatedTime": "string"
}
]
}

/datasets/{datasetId}/transformations

path Parameters

datasetId

required

string

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{"operations": [{"options": { },
"type": "remove-duplicates"
}
]
}

Response samples

Content type

application/json

{"createdBy": "string",
"createdTime": "string",
"datasetId": "string",
"operations": [{"options": { },
"type": "remove-duplicates"
}
],
"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": [{"options": { },
"type": "remove-duplicates"
}
],
"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

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{ }

/deploymentEnvironments

Authorizations:

OAuth2

query Parameters

owner	string
nextToken	string
maxResults	string

Responses

Response samples

Content type

application/json

{"deploymentEnvironments": [{"deploymentEnvironmentId": "string",
"description": "string",
"modelDeploymentUnits": 0,
"name": "string",
"organizationId": "string",
"status": "available"
}
],
"nextToken": "string"
}

/deploymentEnvironments

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{ }

Response samples

200

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": ["string"
],
"datasetId": ["string"
],
"documents": [{"consentId": "string",
"content": "string",
"contentMD5": "string",
"contentType": "application/pdf",
"createdBy": "string",
"createdTime": "string",
"datasetId": "string",
"description": "string",
"documentId": "string",
"fileUrl": "string",
"groundTruth": [{"confidence": 1,
"label": "string",
"pages": [0
],
"value": "string"
}
],
"metadata": { },
"name": "string",
"retentionInDays": 1,
"updatedBy": "string",
"updatedTime": "string"
}
],
"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": ["string"
],
"datasetId": ["string"
],
"documents": [{"consentId": "string",
"content": "string",
"contentMD5": "string",
"contentType": "application/pdf",
"createdBy": "string",
"createdTime": "string",
"datasetId": "string",
"description": "string",
"documentId": "string",
"fileUrl": "string",
"groundTruth": [{"confidence": 1,
"label": "string",
"pages": [0
],
"value": "string"
}
],
"metadata": { },
"name": "string",
"retentionInDays": 1,
"updatedBy": "string",
"updatedTime": "string"
}
],
"nextToken": "string",
"order": "ascending",
"sortBy": "createdTime"
}

/documents

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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" "image/webp"
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

Payload

Content type

application/json

{"consentId": "string",
"content": "string",
"contentType": "application/pdf",
"datasetId": "string",
"description": "string",
"groundTruth": [{"confidence": 1,
"label": "string",
"pages": [0
],
"value": "string"
}
],
"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": [{"confidence": 1,
"label": "string",
"pages": [0
],
"value": "string"
}
],
"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": [{"confidence": 1,
"label": "string",
"pages": [0
],
"value": "string"
}
],
"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": [{"confidence": 1,
"label": "string",
"pages": [0
],
"value": "string"
}
],
"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

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{"datasetId": "string",
"description": "string",
"groundTruth": [{"confidence": 1,
"label": "string",
"pages": [0
],
"value": "string"
}
],
"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": [{"confidence": 1,
"label": "string",
"pages": [0
],
"value": "string"
}
],
"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": [{"events": [{ }
],
"logId": "string",
"startTime": "string",
"transitionExecutionId": "string",
"transitionId": "string",
"workflowExecutionId": "string",
"workflowId": "string"
}
],
"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

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{ }

/models

Authorizations:

OAuth2

query Parameters

owner	string
nextToken	string
maxResults	string

Responses

Response samples

Content type

application/json

{"models": [{"createdBy": "string",
"createdTime": "string",
"description": "string",
"fieldConfig": { },
"metadata": { },
"modelId": "string",
"name": "string",
"numberOfDataBundles": 0,
"numberOfRunningTrainings": 0,
"organizationId": "string",
"postprocessConfig": {"outputFormat": "v1",
"strategy": "BEST_FIRST"
},
"preprocessConfig": {"autoRotate": true,
"imageQuality": "LOW",
"maxPages": 1,
"pages": [0
],
"rotation": 0,
"startPage": 0
},
"statistics": { },
"status": "active",
"trainingId": "string",
"updatedBy": "string",
"updatedTime": "string",
"version": 0
}
],
"nextToken": "string"
}

/models

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{"description": "string",
"fieldConfig": { },
"metadata": { },
"name": "string",
"postprocessConfig": {"outputFormat": "v1",
"strategy": "BEST_FIRST"
},
"preprocessConfig": {"autoRotate": true,
"imageQuality": "LOW",
"maxPages": 1,
"pages": [0
],
"rotation": 0,
"startPage": 0
}
}

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": {"outputFormat": "v1",
"strategy": "BEST_FIRST"
},
"preprocessConfig": {"autoRotate": true,
"imageQuality": "LOW",
"maxPages": 1,
"pages": [0
],
"rotation": 0,
"startPage": 0
},
"statistics": { },
"status": "active",
"trainingId": "string",
"updatedBy": "string",
"updatedTime": "string",
"version": 0
}

/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": {"outputFormat": "v1",
"strategy": "BEST_FIRST"
},
"preprocessConfig": {"autoRotate": true,
"imageQuality": "LOW",
"maxPages": 1,
"pages": [0
],
"rotation": 0,
"startPage": 0
},
"statistics": { },
"status": "active",
"trainingId": "string",
"updatedBy": "string",
"updatedTime": "string",
"version": 0
}

/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": {"outputFormat": "v1",
"strategy": "BEST_FIRST"
},
"preprocessConfig": {"autoRotate": true,
"imageQuality": "LOW",
"maxPages": 1,
"pages": [0
],
"rotation": 0,
"startPage": 0
},
"statistics": { },
"status": "active",
"trainingId": "string",
"updatedBy": "string",
"updatedTime": "string",
"version": 0
}

/models/{modelId}

path Parameters

modelId

required

string

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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-z0-9-_]+$

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"fieldConfig": { },
"metadata": { },
"name": "string",
"postprocessConfig": {"outputFormat": "v1",
"strategy": "BEST_FIRST"
},
"preprocessConfig": {"autoRotate": true,
"imageQuality": "LOW",
"maxPages": 1,
"pages": [0
],
"rotation": 0,
"startPage": 0
},
"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": {"outputFormat": "v1",
"strategy": "BEST_FIRST"
},
"preprocessConfig": {"autoRotate": true,
"imageQuality": "LOW",
"maxPages": 1,
"pages": [0
],
"rotation": 0,
"startPage": 0
},
"statistics": { },
"status": "active",
"trainingId": "string",
"updatedBy": "string",
"updatedTime": "string",
"version": 0
}

/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": [{"createdBy": "string",
"createdTime": "string",
"dataBundleId": "string",
"datasets": [{"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
}
],
"description": "string",
"modelId": "string",
"name": "string",
"retentionInDays": 1,
"status": "running",
"summary": { },
"updatedBy": "string",
"updatedTime": "string"
}
],
"nextToken": "string",
"status": ["running"
]
}

/models/{modelId}/dataBundles

path Parameters

modelId

required

string

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{"datasetIds": ["string"
],
"description": "string",
"name": "string"
}

Response samples

Content type

application/json

{"createdBy": "string",
"createdTime": "string",
"dataBundleId": "string",
"datasets": [{"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
}
],
"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": [{"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
}
],
"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": [{"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
}
],
"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

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{"description": "string",
"name": "string"
}

Response samples

Content type

application/json

{"createdBy": "string",
"createdTime": "string",
"dataBundleId": "string",
"datasets": [{"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
}
],
"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": ["waiting-for-approval"
],
"trainings": [{"createdBy": "string",
"createdTime": "string",
"dataBundleIds": ["string"
],
"dataScientistAssistance": true,
"deploymentEnvironmentId": "string",
"description": "string",
"evaluation": { },
"gpuHours": 0,
"instanceType": "small-gpu",
"metadata": { },
"modelId": "string",
"name": "string",
"statistics": { },
"status": "waiting-for-approval",
"trainingId": "string",
"updatedBy": "string",
"updatedTime": "string",
"warmStartConfig": {"trainingId": "string"
}
}
]
}

/models/{modelId}/trainings

path Parameters

modelId

required

string

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{"dataBundleIds": ["string"
],
"dataScientistAssistance": true,
"description": "string",
"instanceType": "small-gpu",
"metadata": { },
"name": "string",
"warmStartConfig": {"trainingId": "string"
}
}

Response samples

Content type

application/json

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

/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": ["string"
],
"dataScientistAssistance": true,
"deploymentEnvironmentId": "string",
"description": "string",
"evaluation": { },
"gpuHours": 0,
"instanceType": "small-gpu",
"metadata": { },
"modelId": "string",
"name": "string",
"statistics": { },
"status": "waiting-for-approval",
"trainingId": "string",
"updatedBy": "string",
"updatedTime": "string",
"warmStartConfig": {"trainingId": "string"
}
}

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

path Parameters

modelId required	string
trainingId required	string

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{"deploymentEnvironmentId": "string",
"description": "string",
"metadata": { },
"name": "string",
"status": "cancelled"
}

Response samples

Content type

application/json

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

/organizations

Authorizations:

OAuth2

query Parameters

nextToken	string
maxResults	string

Responses

Response samples

Content type

application/json

{"nextToken": "string",
"organizations": [{"clientId": "string",
"createdTime": "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

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{"name": "string"
}

Response samples

Content type

application/json

{"clientId": "string",
"createdTime": "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",
"createdTime": "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

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{"description": "string",
"name": "string",
"paymentMethodId": "string",
"planId": "string"
}

Response samples

Content type

application/json

{"clientId": "string",
"createdTime": "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": [{"createdBy": "string",
"createdTime": "string",
"description": "string",
"details": { },
"name": "string",
"paymentMethodId": "string",
"stripePublishableKey": "string",
"stripeSetupIntentSecret": "string",
"updatedBy": "string",
"updatedTime": "string"
}
]
}

/paymentMethods

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

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

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

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

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{ }

Response samples

200

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": [{"createdBy": "string",
"createdTime": "string",
"documentId": "string",
"error": "string",
"inferenceTime": 0,
"modelId": "string",
"nextPage": 0,
"postprocessConfig": {"outputFormat": "v1",
"strategy": "BEST_FIRST"
},
"predictionId": "string",
"predictions": [{"confidence": 1,
"label": "string",
"location": [1,
1,
1,
1
],
"page": 0,
"rawValue": "string",
"source": "llm",
"value": "string"
}
],
"preprocessConfig": {"autoRotate": true,
"imageQuality": "LOW",
"maxPages": 1,
"pages": [0
],
"rotation": 0,
"startPage": 0
},
"status": "pending",
"trainingId": "string"
}
],
"sortBy": "createdTime"
}

/predictions

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{ }

/predictions

Authorizations:

OAuth2

header Parameters

Content-Type

required

string

Request Body schema: application/json
required

async	boolean
autoRotate	boolean
documentId required	string^las:document:[a-f0-9]{32}$
imageQuality	string Enum: "LOW" "HIGH"
maxPages	integer [ 1 .. 100 ]
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-z0-9-_]+$

Responses

Request samples

Payload

Content type

application/json

{"async": true,
"autoRotate": true,
"documentId": "string",
"imageQuality": "LOW",
"maxPages": 1,
"modelId": "string",
"postprocessConfig": {"outputFormat": "v1",
"strategy": "BEST_FIRST"
},
"preprocessConfig": {"autoRotate": true,
"imageQuality": "LOW",
"maxPages": 1,
"pages": [0
],
"rotation": 0,
"startPage": 0
},
"rotation": 0,
"trainingId": "string"
}

Response samples

Content type

application/json

{"createdBy": "string",
"createdTime": "string",
"documentId": "string",
"error": "string",
"inferenceTime": 0,
"modelId": "string",
"nextPage": 0,
"postprocessConfig": {"outputFormat": "v1",
"strategy": "BEST_FIRST"
},
"predictionId": "string",
"predictions": [{"confidence": 1,
"label": "string",
"location": [1,
1,
1,
1
],
"page": 0,
"rawValue": "string",
"source": "llm",
"value": "string"
}
],
"preprocessConfig": {"autoRotate": true,
"imageQuality": "LOW",
"maxPages": 1,
"pages": [0
],
"rotation": 0,
"startPage": 0
},
"status": "pending",
"trainingId": "string"
}

/predictions/{predictionId}

Authorizations:

OAuth2

path Parameters

predictionId

required

string

Responses

Response samples

Content type

application/json

{"createdBy": "string",
"createdTime": "string",
"documentId": "string",
"error": "string",
"inferenceTime": 0,
"modelId": "string",
"nextPage": 0,
"postprocessConfig": {"outputFormat": "v1",
"strategy": "BEST_FIRST"
},
"predictionId": "string",
"predictions": [{"confidence": 1,
"label": "string",
"location": [1,
1,
1,
1
],
"page": 0,
"rawValue": "string",
"source": "llm",
"value": "string"
}
],
"preprocessConfig": {"autoRotate": true,
"imageQuality": "LOW",
"maxPages": 1,
"pages": [0
],
"rotation": 0,
"startPage": 0
},
"status": "pending",
"trainingId": "string"
}

/predictions/{predictionId}

path Parameters

predictionId

required

string

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

/profiles/{profileId}

path Parameters

profileId

required

string

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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": [{"createdBy": "string",
"createdTime": "string",
"description": "string",
"name": "string",
"permissions": [{"action": "read",
"effect": "allow",
"resourceId": "string"
}
],
"roleId": "string",
"updatedBy": "string",
"updatedTime": "string"
}
]
}

/roles

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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": [{"action": "read",
"effect": "allow",
"resourceId": "string"
}
],
"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

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{ }

/secrets

Authorizations:

OAuth2

query Parameters

nextToken	string
maxResults	string

Responses

Response samples

Content type

application/json

{"nextToken": "string",
"secrets": [{"createdBy": "string",
"createdTime": "string",
"description": "string",
"name": "string",
"secretId": "string",
"updatedBy": "string",
"updatedTime": "string"
}
]
}

/secrets

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

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

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

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": ["docker"
],
"transitions": [{"assets": {"jsRemoteComponent": "string",
"property1": "string",
"property2": "string"
},
"createdBy": "string",
"createdTime": "string",
"description": "string",
"name": "string",
"parameters": { },
"timeoutInSeconds": 60,
"transitionId": "string",
"transitionType": "docker",
"updatedBy": "string",
"updatedTime": "string"
}
]
}

/transitions

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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
name	string or null <= 4096 characters
	object or object or object
timeoutInSeconds	integer [ 60 .. 10800 ]
transitionType required	string Enum: "docker" "manual" "lambda"

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"parameters": {"cpu": 256,
"environment": {"property1": "string",
"property2": "string"
},
"environmentSecrets": ["string"
],
"imageUrl": "string",
"memory": 512,
"secretId": "string"
},
"timeoutInSeconds": 60,
"transitionType": "docker"
}

Response samples

Content type

application/json

{"assets": {"jsRemoteComponent": "string",
"property1": "string",
"property2": "string"
},
"createdBy": "string",
"createdTime": "string",
"description": "string",
"name": "string",
"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": {"jsRemoteComponent": "string",
"property1": "string",
"property2": "string"
},
"createdBy": "string",
"createdTime": "string",
"description": "string",
"name": "string",
"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": {"jsRemoteComponent": "string",
"property1": "string",
"property2": "string"
},
"createdBy": "string",
"createdTime": "string",
"description": "string",
"name": "string",
"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

Payload

Content type

application/json

{ }

Response samples

200

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

description	string or null <= 4096 characters
name	string or null <= 4096 characters
	object or object or object

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"parameters": {"cpu": 256,
"environment": {"property1": "string",
"property2": "string"
},
"environmentSecrets": ["string"
],
"imageUrl": "string",
"memory": 512,
"secretId": "string"
}
}

Response samples

Content type

application/json

{"assets": {"jsRemoteComponent": "string",
"property1": "string",
"property2": "string"
},
"createdBy": "string",
"createdTime": "string",
"description": "string",
"name": "string",
"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": [{"completedBy": "string",
"endTime": "string",
"executionId": "string",
"input": { },
"logId": "string",
"output": { },
"startTime": "string",
"status": "running",
"transitionId": "string"
}
],
"nextToken": "string",
"status": ["running"
],
"transitionId": "string"
}

/transitions/{transitionId}/executions

path Parameters

transitionId

required

string

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{"completedBy": "string",
"endTime": "string",
"executionId": "string",
"input": { },
"logId": "string",
"output": { },
"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",
"output": { },
"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

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{"status": "string",
"error": {"message": "string"
},
"output": { },
"startTime": "string"
}

Response samples

Content type

application/json

{"completedBy": "string",
"endTime": "string",
"executionId": "string",
"input": { },
"logId": "string",
"output": { },
"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

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

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": [{"createdBy": "string",
"createdTime": "string",
"metadata": { },
"profileId": "string",
"roleIds": ["string"
],
"status": "inactive",
"updatedBy": "string",
"updatedTime": "string",
"userId": "string"
}
]
}

/users

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{"appClientId": "string",
"email": "string",
"metadata": { },
"roleIds": ["string"
]
}

Response samples

Content type

application/json

{"createdBy": "string",
"createdTime": "string",
"metadata": { },
"profileId": "string",
"roleIds": ["string"
],
"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": ["string"
],
"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": ["string"
],
"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

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{"metadata": { },
"roleIds": ["string"
]
}

Response samples

Content type

application/json

{"createdBy": "string",
"createdTime": "string",
"metadata": { },
"profileId": "string",
"roleIds": ["string"
],
"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": [{"completedConfig": {"environment": {"property1": "string",
"property2": "string"
},
"environmentSecrets": ["string"
],
"imageUrl": "string",
"secretId": "string"
},
"createdBy": "string",
"createdTime": "string",
"description": "string",
"emailConfig": {"additionalWorkflowInput": { },
"allowedOrigins": ["string"
],
"email": "string",
"secretId": "string"
},
"errorConfig": {"email": "string",
"manualRetry": true
},
"metadata": { },
"monthlyNumberOfWorkflowExecutionsAllowed": 0,
"monthlyNumberOfWorkflowExecutionsCreated": 0,
"name": "string",
"numberOfRunningExecutions": 0,
"status": "development",
"updatedBy": "string",
"updatedTime": "string",
"workflowId": "string"
}
]
}

/workflows

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{"completedConfig": {"environment": {"property1": "string",
"property2": "string"
},
"environmentSecrets": ["string"
],
"imageUrl": "string",
"secretId": "string"
},
"description": "string",
"emailConfig": {"additionalWorkflowInput": { },
"allowedOrigins": ["string"
],
"email": "string",
"secretId": "string"
},
"errorConfig": {"email": "string",
"manualRetry": true
},
"metadata": { },
"name": "string",
"specification": {"definition": { },
"language": "ASL",
"version": "1.0.0"
},
"status": "development"
}

Response samples

Content type

application/json

{"completedConfig": {"environment": {"property1": "string",
"property2": "string"
},
"environmentSecrets": ["string"
],
"imageUrl": "string",
"secretId": "string"
},
"createdBy": "string",
"createdTime": "string",
"description": "string",
"emailConfig": {"additionalWorkflowInput": { },
"allowedOrigins": ["string"
],
"email": "string",
"secretId": "string"
},
"errorConfig": {"email": "string",
"manualRetry": true
},
"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": {"environment": {"property1": "string",
"property2": "string"
},
"environmentSecrets": ["string"
],
"imageUrl": "string",
"secretId": "string"
},
"createdBy": "string",
"createdTime": "string",
"description": "string",
"emailConfig": {"additionalWorkflowInput": { },
"allowedOrigins": ["string"
],
"email": "string",
"secretId": "string"
},
"errorConfig": {"email": "string",
"manualRetry": true
},
"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": {"environment": {"property1": "string",
"property2": "string"
},
"environmentSecrets": ["string"
],
"imageUrl": "string",
"secretId": "string"
},
"createdBy": "string",
"createdTime": "string",
"description": "string",
"emailConfig": {"additionalWorkflowInput": { },
"allowedOrigins": ["string"
],
"email": "string",
"secretId": "string"
},
"errorConfig": {"email": "string",
"manualRetry": true
},
"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

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{"completedConfig": {"environment": {"property1": "string",
"property2": "string"
},
"environmentSecrets": ["string"
],
"imageUrl": "string",
"secretId": "string"
},
"description": "string",
"emailConfig": {"additionalWorkflowInput": { },
"allowedOrigins": ["string"
],
"email": "string",
"secretId": "string"
},
"errorConfig": {"email": "string",
"manualRetry": true
},
"metadata": { },
"name": "string",
"status": "development"
}

Response samples

Content type

application/json

{"completedConfig": {"environment": {"property1": "string",
"property2": "string"
},
"environmentSecrets": ["string"
],
"imageUrl": "string",
"secretId": "string"
},
"createdBy": "string",
"createdTime": "string",
"description": "string",
"emailConfig": {"additionalWorkflowInput": { },
"allowedOrigins": ["string"
],
"email": "string",
"secretId": "string"
},
"errorConfig": {"email": "string",
"manualRetry": true
},
"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": [{"completedBy": ["string"
],
"completedTaskLogId": "string",
"createdBy": "string",
"endTime": "string",
"events": [{ }
],
"executionId": "string",
"input": { },
"logId": "string",
"output": { },
"startTime": "string",
"status": "running",
"transitionExecutions": { },
"workflowId": "string"
}
],
"nextToken": "string",
"order": "ascending",
"sortBy": "startTime",
"status": ["running"
],
"workflowId": "string"
}

/workflows/{workflowId}/executions

path Parameters

workflowId

required

string

Request Body schema: application/json
required

object (Empty Schema)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{"input": { }
}

Response samples

Content type

application/json

{"completedBy": ["string"
],
"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": ["string"
],
"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": ["string"
],
"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

Payload

Content type

application/json

{ }

Response samples

200

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

Payload

Content type

application/json

{"nextTransitionId": "string",
"status": "succeeded"
}

Response samples

Content type

application/json

{"completedBy": ["string"
],
"completedTaskLogId": "string",
"createdBy": "string",
"endTime": "string",
"events": [{ }
],
"executionId": "string",
"input": { },
"logId": "string",
"output": { },
"startTime": "string",
"status": "running",
"transitionExecutions": { },
"workflowId": "string"
}

Lucidtech API (2024-11-29T08:05:46Z)

/appClients

Authorizations:

query Parameters

Responses

Response samples

/appClients

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

/appClients

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

/appClients/{appClientId}

Authorizations:

path Parameters

Responses

Response samples

/appClients/{appClientId}

Authorizations:

path Parameters

Responses

Response samples

/appClients/{appClientId}

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

/appClients/{appClientId}

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

/assets

Authorizations:

query Parameters

Responses

Response samples

/assets

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

/assets

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

/assets/{assetId}

Authorizations:

path Parameters

Responses

Response samples

/assets/{assetId}

Authorizations:

path Parameters

Responses

Response samples

/assets/{assetId}

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

/assets/{assetId}

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required