latest

GET /appClients

Header name

Header value

Authorization

Bearer <your access token here>

x-api-key

<your api key here>

Query name

Query value

nextToken

String value as returned by a previous list operation

maxResults

Integer representing maximum number of resources to list

Response body JSON Schema

{
"title": "appClients",
"required": [
"appClients",
"nextToken"
],
"type": "object",
"properties": {
"nextToken": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"appClients": {
"type": "array",
"items": {
"required": [
"apiKey",
"appClientId",
"callbackUrls",
"clientId",
"createdTime",
"description",
"hasSecret",
"logoutUrls",
"name"
],
"type": "object",
"properties": {
"hasSecret": {
"type": "boolean"
},
"clientId": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"name": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"logoutUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"createdTime": {
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$",
"type": "string",
"nullable": true
},
"callbackUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"clientSecret": {
"type": "string"
},
"appClientId": {
"pattern": "^las:app-client:[a-f0-9]{32}$",
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}

POST /appClients

Header name

Header value

Content-Type

application/json

Authorization

Bearer <your access token here>

x-api-key

<your api key here>

Request body JSON Schema

{
"title": "POST /appClients",
"type": "object",
"properties": {
"generateSecret": {
"type": "boolean",
"default": true
},
"logoutUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"callbackUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"maxLength": 4096,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}

Response body JSON Schema

{
"title": "appClient",
"required": [
"apiKey",
"appClientId",
"callbackUrls",
"clientId",
"createdTime",
"description",
"hasSecret",
"logoutUrls",
"name"
],
"type": "object",
"properties": {
"hasSecret": {
"type": "boolean"
},
"clientId": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"name": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"logoutUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"createdTime": {
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$",
"type": "string",
"nullable": true
},
"callbackUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"clientSecret": {
"type": "string"
},
"appClientId": {
"pattern": "^las:app-client:[a-f0-9]{32}$",
"type": "string"
}
},
"additionalProperties": false
}

DELETE /appClients/{appClientId}

Path name

Path value

appClientId

Id of appClient on the form las:appClient:<hex>

Header name

Header value

Authorization

Bearer <your access token here>

x-api-key

<your api key here>

Response body JSON Schema

{
"title": "appClient",
"required": [
"apiKey",
"appClientId",
"callbackUrls",
"clientId",
"createdTime",
"description",
"hasSecret",
"logoutUrls",
"name"
],
"type": "object",
"properties": {
"hasSecret": {
"type": "boolean"
},
"clientId": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"name": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"logoutUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"createdTime": {
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$",
"type": "string",
"nullable": true
},
"callbackUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"clientSecret": {
"type": "string"
},
"appClientId": {
"pattern": "^las:app-client:[a-f0-9]{32}$",
"type": "string"
}
},
"additionalProperties": false
}

GET /assets

Header name

Header value

Authorization

Bearer <your access token here>

x-api-key

<your api key here>

Query name

Query value

nextToken

String value as returned by a previous list operation

maxResults

Integer representing maximum number of resources to list

Response body JSON Schema

{
"title": "assets",
"required": [
"assets",
"nextToken"
],
"type": "object",
"properties": {
"assets": {
"type": "array",
"items": {
"required": [
"assetId",
"description",
"name"
],
"type": "object",
"properties": {
"assetId": {
"pattern": "^las:asset:[a-f0-9]{32}$",
"type": "string"
},
"name": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"description": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"content": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
}
},
"nextToken": {
"maxLength": 4096,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}

POST /assets

Header name

Header value

Content-Type

application/json

Authorization

Bearer <your access token here>

x-api-key

<your api key here>

Request body JSON Schema

{
"title": "POST /assets",
"required": [
"content"
],
"type": "object",
"properties": {
"name": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"description": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"content": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
}

Response body JSON Schema

{
"title": "asset",
"required": [
"assetId",
"description",
"name"
],
"type": "object",
"properties": {
"assetId": {
"pattern": "^las:asset:[a-f0-9]{32}$",
"type": "string"
},
"name": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"description": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"content": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
}

DELETE /assets/{assetId}

Path name

Path value

assetId

Id of asset on the form las:asset:<hex>

Header name

Header value

Authorization

Bearer <your access token here>

x-api-key

<your api key here>

Response body JSON Schema

{
"title": "asset",
"required": [
"assetId",
"description",
"name"
],
"type": "object",
"properties": {
"assetId": {
"pattern": "^las:asset:[a-f0-9]{32}$",
"type": "string"
},
"name": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"description": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"content": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
}

GET /assets/{assetId}

Path name

Path value

assetId

Id of asset on the form las:asset:<hex>

Header name

Header value

Authorization

Bearer <your access token here>

x-api-key

<your api key here>

Response body JSON Schema

{
"title": "asset",
"required": [
"assetId",
"description",
"name"
],
"type": "object",
"properties": {
"assetId": {
"pattern": "^las:asset:[a-f0-9]{32}$",
"type": "string"
},
"name": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"description": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"content": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
}

PATCH /assets/{assetId}

Path name

Path value

assetId

Id of asset on the form las:asset:<hex>

Header name

Header value

Content-Type

application/json

Authorization

Bearer <your access token here>

x-api-key

<your api key here>

Request body JSON Schema

{
"title": "PATCH /assets/assetId",
"minProperties": 1,
"type": "object",
"properties": {
"name": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"description": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"content": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
}

Response body JSON Schema

{
"title": "asset",
"required": [
"assetId",
"description",
"name"
],
"type": "object",
"properties": {
"assetId": {
"pattern": "^las:asset:[a-f0-9]{32}$",
"type": "string"
},
"name": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"description": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"content": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
}

GET /batches

Header name

Header value

Authorization

Bearer <your access token here>

x-api-key

<your api key here>

Query name

Query value

nextToken

String value as returned by a previous list operation

maxResults

Integer representing maximum number of resources to list

Response body JSON Schema

{
"title": "batches",
"required": [
"batches",
"nextToken"
],
"type": "object",
"properties": {
"batches": {
"type": "array",
"items": {
"required": [
"batchId",
"containsPersonallyIdentifiableInformation",
"createdTime",
"description",
"numDocuments",
"retentionInDays",
"storageLocation"
],
"type": "object",
"properties": {
"retentionInDays": {
"maximum": 1825,
"minimum": 0,
"type": "integer"
},
"name": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"description": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"createdTime": {
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$",
"type": "string",
"nullable": true
},
"storageLocation": {
"type": "string",
"enum": [
"EU"
]
},
"containsPersonallyIdentifiableInformation": {
"type": "boolean"
},
"batchId": {
"pattern": "^las:batch:[a-f0-9]{32}$",
"type": "string"
},
"numDocuments": {
"minimum": 0,
"type": "integer"
}
},
"additionalProperties": false
}
},
"nextToken": {
"maxLength": 4096,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}

POST /batches

Header name

Header value

Content-Type

application/json

Authorization

Bearer <your access token here>

x-api-key

<your api key here>

Request body JSON Schema

{
"title": "POST /batches",
"type": "object",
"properties": {
"name": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"description": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"containsPersonallyIdentifiableInformation": {
"type": "boolean"
}
},
"additionalProperties": false
}

Response body JSON Schema

{
"title": "batch",
"required": [
"batchId",
"containsPersonallyIdentifiableInformation",
"createdTime",
"description",
"numDocuments",
"retentionInDays",
"storageLocation"
],
"type": "object",
"properties": {
"retentionInDays": {
"maximum": 1825,
"minimum": 0,
"type": "integer"
},
"name": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"description": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"createdTime": {
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$",
"type": "string",
"nullable": true
},
"storageLocation": {
"type": "string",
"enum": [
"EU"
]
},
"containsPersonallyIdentifiableInformation": {
"type": "boolean"
},
"batchId": {
"pattern": "^las:batch:[a-f0-9]{32}$",
"type": "string"
},
"numDocuments": {
"minimum": 0,
"type": "integer"
}
},
"additionalProperties": false
}

DELETE /batches/{batchId}

Path name

Path value

batchId

Id of batch on the form las:batch:<hex>

Header name

Header value

Authorization

Bearer <your access token here>

x-api-key

<your api key here>

Response body JSON Schema

{
"title": "batch",
"required": [
"batchId",
"containsPersonallyIdentifiableInformation",
"createdTime",
"description",
"numDocuments",
"retentionInDays",
"storageLocation"
],
"type": "object",
"properties": {
"retentionInDays": {
"maximum": 1825,
"minimum": 0,
"type": "integer"
},
"name": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"description": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"createdTime": {
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$",
"type": "string",
"nullable": true
},
"storageLocation": {
"type": "string",
"enum": [
"EU"
]
},
"containsPersonallyIdentifiableInformation": {
"type": "boolean"
},
"batchId": {
"pattern": "^las:batch:[a-f0-9]{32}$",
"type": "string"
},
"numDocuments": {
"minimum": 0,
"type": "integer"
}
},
"additionalProperties": false
}

DELETE /documents

Header name

Header value

Authorization

Bearer <your access token here>

x-api-key

<your api key here>

Query name

Query value

batchId

Id of batch on the form las:batch:<hex>

consentId

Id of consent on the form las:consent:<hex>

nextToken

String value as returned by a previous list operation

maxResults

Integer representing maximum number of resources to list

Response body JSON Schema

{
"title": "documents",
"required": [
"documents",
"nextToken"
],
"type": "object",
"properties": {
"consentId": {
"type": "array",
"items": {
"pattern": "^las:consent:[a-f0-9]{32}$",
"type": "string"
}
},
"documents": {
"type": "array",
"items": {
"required": [
"contentType",
"documentId"
],
"type": "object",
"properties": {
"groundTruth": {
"type": "array",
"items": {
"required": [
"label",
"value"
],
"type": "object",
"properties": {
"label": {
"maxLength": 36,
"minLength": 1,
"pattern": "^[0-9A-Za-z_]+$",
"type": "string"
},
"value": {
"anyOf": [
{
"maxLength": 64,
"minLength": 1,
"type": "string",
"nullable": true
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
},
"consentId": {
"pattern": "^las:consent:[a-f0-9]{32}$",
"type": "string"
},
"documentId": {
"pattern": "^las:document:[a-f0-9]{32}$",
"type": "string"
},
"batchId": {
"pattern": "^las:batch:[a-f0-9]{32}$",
"type": "string"
},
"contentType": {
"type": "string",
"enum": [
"application/pdf",
"image/jpeg",
"image/png",
"image/tiff"
]
},
"content": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
}
},
"nextToken": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"batchId": {
"type": "array",
"items": {
"pattern": "^las:batch:[a-f0-9]{32}$",
"type": "string"
}
}
},
"additionalProperties": false
}

GET /documents

Header name

Header value

Authorization

Bearer <your access token here>

x-api-key

<your api key here>

Query name

Query value

batchId

Id of batch on the form las:batch:<hex>

consentId

Id of consent on the form las:consent:<hex>

nextToken

String value as returned by a previous list operation

maxResults

Integer representing maximum number of resources to list

Response body JSON Schema

{
"title": "documents",
"required": [
"documents",
"nextToken"
],
"type": "object",
"properties": {
"consentId": {
"type": "array",
"items": {
"pattern": "^las:consent:[a-f0-9]{32}$",
"type": "string"
}
},
"documents": {
"type": "array",
"items": {
"required": [
"contentType",
"documentId"
],
"type": "object",
"properties": {
"groundTruth": {
"type": "array",
"items": {
"required": [
"label",
"value"
],
"type": "object",
"properties": {
"label": {
"maxLength": 36,
"minLength": 1,
"pattern": "^[0-9A-Za-z_]+$",
"type": "string"
},
"value": {
"anyOf": [
{
"maxLength": 64,
"minLength": 1,
"type": "string",
"nullable": true
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
},
"consentId": {
"pattern": "^las:consent:[a-f0-9]{32}$",
"type": "string"
},
"documentId": {
"pattern": "^las:document:[a-f0-9]{32}$",
"type": "string"
},
"batchId": {
"pattern": "^las:batch:[a-f0-9]{32}$",
"type": "string"
},
"contentType": {
"type": "string",
"enum": [
"application/pdf",
"image/jpeg",
"image/png",
"image/tiff"
]
},
"content": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
}
},
"nextToken": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"batchId": {
"type": "array",
"items": {
"pattern": "^las:batch:[a-f0-9]{32}$",
"type": "string"
}
}
},
"additionalProperties": false
}

POST /documents

Header name

Header value

Content-Type

application/json

Authorization

Bearer <your access token here>

x-api-key

<your api key here>

Request body JSON Schema

{
"title": "POST /documents",
"required": [
"content",
"contentType"
],
"type": "object",
"properties": {
"groundTruth": {
"type": "array",
"items": {
"required": [
"label",
"value"
],
"type": "object",
"properties": {
"label": {
"maxLength": 36,
"minLength": 1,
"pattern": "^[0-9A-Za-z_]+$",
"type": "string"
},
"value": {
"anyOf": [
{
"maxLength": 64,
"minLength": 1,
"type": "string",
"nullable": true
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
},
"consentId": {
"pattern": "^las:consent:[a-f0-9]{32}$",
"type": "string"
},
"batchId": {
"pattern": "^las:batch:[a-f0-9]{32}$",
"type": "string"
},
"contentType": {
"type": "string",
"enum": [
"application/pdf",
"image/jpeg",
"image/png",
"image/tiff"
]
},
"content": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
}

Response body JSON Schema

{
"title": "document",
"required": [
"contentType",
"documentId"
],
"type": "object",
"properties": {
"groundTruth": {
"type": "array",
"items": {
"required": [
"label",
"value"
],
"type": "object",
"properties": {
"label": {
"maxLength": 36,
"minLength": 1,
"pattern": "^[0-9A-Za-z_]+$",
"type": "string"
},
"value": {
"anyOf": [
{
"maxLength": 64,
"minLength": 1,
"type": "string",
"nullable": true
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
},
"consentId": {
"pattern": "^las:consent:[a-f0-9]{32}$",
"type": "string"
},
"documentId": {
"pattern": "^las:document:[a-f0-9]{32}$",
"type": "string"
},
"batchId": {
"pattern": "^las:batch:[a-f0-9]{32}$",
"type": "string"
},
"contentType": {
"type": "string",
"enum": [
"application/pdf",
"image/jpeg",
"image/png",
"image/tiff"
]
},
"content": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
}

GET /documents/{documentId}

Path name

Path value

documentId

Id of document on the form las:document:<hex>

Header name

Header value

Authorization

Bearer <your access token here>

x-api-key

<your api key here>

Response body JSON Schema

{
"title": "document",
"required": [
"contentType",
"documentId"
],
"type": "object",
"properties": {
"groundTruth": {
"type": "array",
"items": {
"required": [
"label",
"value"
],
"type": "object",
"properties": {
"label": {
"maxLength": 36,
"minLength": 1,
"pattern": "^[0-9A-Za-z_]+$",
"type": "string"
},
"value": {
"anyOf": [
{
"maxLength": 64,
"minLength": 1,
"type": "string",
"nullable": true
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
},
"consentId": {
"pattern": "^las:consent:[a-f0-9]{32}$",
"type": "string"
},
"documentId": {
"pattern": "^las:document:[a-f0-9]{32}$",
"type": "string"
},
"batchId": {
"pattern": "^las:batch:[a-f0-9]{32}$",
"type": "string"
},
"contentType": {
"type": "string",
"enum": [
"application/pdf",
"image/jpeg",
"image/png",
"image/tiff"
]
},
"content": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
}

PATCH /documents/{documentId}

Path name

Path value

documentId

Id of document on the form las:document:<hex>

Header name

Header value

Content-Type

application/json

Authorization

Bearer <your access token here>

x-api-key

<your api key here>

Request body JSON Schema

{
"title": "PATCH /documents/{documentId}",
"required": [
"groundTruth"
],
"type": "object",
"properties": {
"groundTruth": {
"type": "array",
"items": {
"required": [
"label",
"value"
],
"type": "object",
"properties": {
"label": {
"maxLength": 36,
"minLength": 1,
"pattern": "^[0-9A-Za-z_]+$",
"type": "string"
},
"value": {
"anyOf": [
{
"maxLength": 64,
"minLength": 1,
"type": "string",
"nullable": true
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}

Response body JSON Schema

{
"title": "document",
"required": [
"contentType",
"documentId"
],
"type": "object",
"properties": {
"groundTruth": {
"type": "array",
"items": {
"required": [
"label",
"value"
],
"type": "object",
"properties": {
"label": {
"maxLength": 36,
"minLength": 1,
"pattern": "^[0-9A-Za-z_]+$",
"type": "string"
},
"value": {
"anyOf": [
{
"maxLength": 64,
"minLength": 1,
"type": "string",
"nullable": true
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
},
"consentId": {
"pattern": "^las:consent:[a-f0-9]{32}$",
"type": "string"
},
"documentId": {
"pattern": "^las:document:[a-f0-9]{32}$",
"type": "string"
},
"batchId": {
"pattern": "^las:batch:[a-f0-9]{32}$",
"type": "string"
},
"contentType": {
"type": "string",
"enum": [
"application/pdf",
"image/jpeg",
"image/png",
"image/tiff"
]
},
"content": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
}

GET /logs

Header name

Header value

Authorization

Bearer <your access token here>

x-api-key

<your api key here>

Query name

Query value

workflowId

String

nextToken

String value as returned by a previous list operation

order

ascending | descending

transitionExecutionId

String

transitionId

String

maxResults

Integer representing maximum number of resources to list

workflowExecutionId

String

Response body JSON Schema

{
"title": "logs",
"required": [
"logs",
"nextToken"
],
"type": "object",
"properties": {
"transitionId": {
"anyOf": [
{
"pattern": "^las:transition:[a-f0-9]{32}$",
"type": "string"
},
{
"pattern": "^las:transition:commons-[0-9A-Za-z-]+$",
"type": "string"
}
]
},
"nextToken": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"transitionExecutionId": {
"pattern": "^las:transition-execution:[a-f0-9]{32}$",
"type": "string"
},
"workflowExecutionId": {
"pattern": "^las:workflow-execution:[a-f0-9]{32}$",
"type": "string"
},
"logs": {
"type": "array",
"items": {
"required": [
"logId",
"startTime",
"transitionExecutionId",
"transitionId",
"workflowExecutionId",
"workflowId"
],
"type": "object",
"properties": {
"transitionId": {
"anyOf": [
{
"pattern": "^las:transition:[a-f0-9]{32}$",
"type": "string"
},
{
"pattern": "^las:transition:commons-[0-9A-Za-z-]+$",
"type": "string"
}
]
},