Lucidtech API (2024-02-02T13:36:49Z)
Download OpenAPI specification:Download
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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
Authorizations:
OAuth2
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
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
- 200
- 400
- 403
- 404
- 415
- 500
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"
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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"
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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 |
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
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
- 200
- 400
- 403
- 404
- 415
- 500
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"
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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
Authorizations:
OAuth2
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
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
- 200
- 400
- 403
- 404
- 415
- 500
Content type
application/json
{- "assetId": "string",
- "content": "string",
- "contentMD5": "string",
- "createdBy": "string",
- "createdTime": "string",
- "description": "string",
- "name": "string",
- "updatedBy": "string",
- "updatedTime": "string"
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
Content type
application/json
{- "assetId": "string",
- "content": "string",
- "contentMD5": "string",
- "createdBy": "string",
- "createdTime": "string",
- "description": "string",
- "name": "string",
- "updatedBy": "string",
- "updatedTime": "string"
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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 |
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
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
- 200
- 400
- 403
- 404
- 415
- 500
Content type
application/json
{- "assetId": "string",
- "content": "string",
- "contentMD5": "string",
- "createdBy": "string",
- "createdTime": "string",
- "description": "string",
- "name": "string",
- "updatedBy": "string",
- "updatedTime": "string"
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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
Authorizations:
OAuth2
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
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
- 200
- 400
- 403
- 404
- 415
- 500
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
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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 |
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
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
- 200
- 400
- 403
- 404
- 415
- 500
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
- 200
- 400
- 403
- 404
- 415
- 500
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
Authorizations:
OAuth2
path Parameters
datasetId required | string |
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
Array of objects | |||||
Array
|
Responses
Request samples
- Payload
Content type
application/json
{- "operations": [
- {
- "options": { },
- "type": "remove-duplicates"
}
]
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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
- 200
- 400
- 403
- 404
- 415
- 500
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/jsonrequired
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
- 200
- 400
- 403
- 404
- 415
- 500
Content type
application/json
{- "deploymentEnvironments": [
- {
- "deploymentEnvironmentId": "string",
- "description": "string",
- "modelDeploymentUnits": 0,
- "name": "string",
- "organizationId": "string",
- "status": "available"
}
], - "nextToken": "string"
}
/deploymentEnvironments/{deploymentEnvironmentId}
Authorizations:
OAuth2
path Parameters
deploymentEnvironmentId required | string |
Responses
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
Content type
application/json
{- "deploymentEnvironmentId": "string",
- "description": "string",
- "modelDeploymentUnits": 0,
- "name": "string",
- "organizationId": "string",
- "status": "available"
}
/documents
Authorizations:
OAuth2
query Parameters
consentId | string |
datasetId | string |
nextToken | string |
maxResults | string |
Responses
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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": [
- {
- "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
- 200
- 400
- 403
- 404
- 415
- 500
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": [
- {
- "label": "string",
- "pages": [
- 0
], - "value": "string"
}
], - "metadata": { },
- "name": "string",
- "retentionInDays": 1,
- "updatedBy": "string",
- "updatedTime": "string"
}
], - "nextToken": "string",
- "order": "ascending",
- "sortBy": "createdTime"
}
/documents
Authorizations:
OAuth2
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
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
- Payload
Content type
application/json
{- "consentId": "string",
- "content": "string",
- "contentType": "application/pdf",
- "datasetId": "string",
- "description": "string",
- "groundTruth": [
- {
- "label": "string",
- "pages": [
- 0
], - "value": "string"
}
], - "metadata": { },
- "name": "string",
- "retentionInDays": 1
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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": [
- {
- "label": "string",
- "pages": [
- 0
], - "value": "string"
}
], - "metadata": { },
- "name": "string",
- "retentionInDays": 1,
- "updatedBy": "string",
- "updatedTime": "string"
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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": [
- {
- "label": "string",
- "pages": [
- 0
], - "value": "string"
}
], - "metadata": { },
- "name": "string",
- "retentionInDays": 1,
- "updatedBy": "string",
- "updatedTime": "string"
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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": [
- {
- "label": "string",
- "pages": [
- 0
], - "value": "string"
}
], - "metadata": { },
- "name": "string",
- "retentionInDays": 1,
- "updatedBy": "string",
- "updatedTime": "string"
}
/documents/{documentId}
Authorizations:
OAuth2
path Parameters
documentId required | string |
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
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": [
- {
- "label": "string",
- "pages": [
- 0
], - "value": "string"
}
], - "metadata": { },
- "name": "string",
- "retentionInDays": 1
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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": [
- {
- "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
- 200
- 400
- 403
- 404
- 415
- 500
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"
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
Content type
application/json
{- "events": [
- { }
], - "logId": "string",
- "startTime": "string",
- "transitionExecutionId": "string",
- "transitionId": "string",
- "workflowExecutionId": "string",
- "workflowId": "string"
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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"
}
], - "nextToken": "string"
}
/models
Authorizations:
OAuth2
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
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
- 200
- 400
- 403
- 404
- 415
- 500
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"
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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"
}
/models/{modelId}
Authorizations:
OAuth2
path Parameters
modelId required | string |
query Parameters
statisticsLastNDays | string |
Responses
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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"
}
/models/{modelId}
Authorizations:
OAuth2
path Parameters
modelId required | string |
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
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
- 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
- 200
- 400
- 403
- 404
- 415
- 500
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"
}
/models/{modelId}/dataBundles
Authorizations:
OAuth2
path Parameters
modelId required | string |
query Parameters
status | string |
nextToken | string |
maxResults | string |
Responses
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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
Authorizations:
OAuth2
path Parameters
modelId required | string |
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
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
- 200
- 400
- 403
- 404
- 415
- 500
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
- 200
- 400
- 403
- 404
- 415
- 500
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
- 200
- 400
- 403
- 404
- 415
- 500
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 |
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
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
- 200
- 400
- 403
- 404
- 415
- 500
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
- 200
- 400
- 403
- 404
- 415
- 500
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",
- "status": "waiting-for-approval",
- "trainingId": "string",
- "updatedBy": "string",
- "updatedTime": "string",
- "warmStartConfig": {
- "trainingId": "string"
}
}
]
}
/models/{modelId}/trainings
Authorizations:
OAuth2
path Parameters
modelId required | string |
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
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
- 200
- 400
- 403
- 404
- 415
- 500
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",
- "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
- 200
- 400
- 403
- 404
- 415
- 500
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",
- "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 |
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
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
- 200
- 400
- 403
- 404
- 415
- 500
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",
- "status": "waiting-for-approval",
- "trainingId": "string",
- "updatedBy": "string",
- "updatedTime": "string",
- "warmStartConfig": {
- "trainingId": "string"
}
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
Content type
application/json
{- "nextToken": "string",
- "organizations": [
- {
- "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
Authorizations:
OAuth2
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
name | string or null <= 4096 characters |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string"
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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
- 200
- 400
- 403
- 404
- 415
- 500
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 |
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
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
- 200
- 400
- 403
- 404
- 415
- 500
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"
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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
Authorizations:
OAuth2
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
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
- 200
- 400
- 403
- 404
- 415
- 500
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
- 200
- 400
- 403
- 404
- 415
- 500
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
- 200
- 400
- 403
- 404
- 415
- 500
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 |
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
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
- 200
- 400
- 403
- 404
- 415
- 500
Content type
application/json
{- "createdBy": "string",
- "createdTime": "string",
- "description": "string",
- "details": { },
- "name": "string",
- "paymentMethodId": "string",
- "stripePublishableKey": "string",
- "stripeSetupIntentSecret": "string",
- "updatedBy": "string",
- "updatedTime": "string"
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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": { }
}
]
}
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
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": { }
}
/predictions
Authorizations:
OAuth2
query Parameters
nextToken | string |
maxResults | string |
sortBy | string |
order | string |
modelId | string |
Responses
Response samples
- 200
- 400
- 403
- 404
- 415
- 500
Content type
application/json
{- "modelId": "string",
- "nextToken": "string",
- "order": "ascending",
- "predictions": [
- {
- "createdBy": "string",
- "createdTime": "string",
- "documentId": "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,
- "value": "string"
}
], - "preprocessConfig": {
- "autoRotate": true,
- "imageQuality": "LOW",
- "maxPages": 1,
- "pages": [
- 0
], - "rotation": 0,
- "startPage": 0
}, - "trainingId": "string"
}
], - "sortBy": "createdTime"
}
/predictions
Authorizations:
OAuth2
header Parameters
Content-Type required | string |
Request Body schema: application/jsonrequired
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
- Payload
Content type
application/json
{- "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
- 200
- 400
- 403
- 404
- 415
- 500
Content type
application/json
{- "createdBy": "string",
- "createdTime": "string",
- "documentId": "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,
- "value": "string"
}
], - "preprocessConfig": {
- "autoRotate": true,
- "imageQuality": "LOW",
- "maxPages": 1,
- "pages": [
- 0
],