latest

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

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
}

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
}
},
"additionalProperties": false
}

Response body JSON Schema

{
"title": "batch",
"required": [
"batchId",
"description",
"name"
],
"type": "object",
"properties": {
"name": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"description": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"batchId": {
"pattern": "^las:batch:[a-f0-9]{32}$",
"type": "string"
}
},
"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

consentId

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

Response body JSON Schema

{
"title": "documents",
"required": [
"documents"
],
"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"
},
"inferenceTime": {
"minimum": 0,
"type": "number"
},
"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"
]
},
"updated": {
"minimum": 1,
"type": "integer"
},
"content": {
"minLength": 1,
"type": "string"
},
"predictions": {
"type": "array",
"items": {
"required": [
"confidence",
"label",
"value"
],
"type": "object",
"properties": {
"confidence": {
"maximum": 1,
"minimum": 0,
"type": "number"
},
"label": {
"maxLength": 36,
"minLength": 1,
"pattern": "^[0-9A-Za-z_]+$",
"type": "string"
},
"value": {
"maxLength": 64,
"minLength": 1,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
}
},
"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"
],
"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"
},
"inferenceTime": {
"minimum": 0,
"type": "number"
},
"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"
]
},
"updated": {
"minimum": 1,
"type": "integer"
},
"content": {
"minLength": 1,
"type": "string"
},
"predictions": {
"type": "array",
"items": {
"required": [
"confidence",
"label",
"value"
],
"type": "object",
"properties": {
"confidence": {
"maximum": 1,
"minimum": 0,
"type": "number"
},
"label": {
"maxLength": 36,
"minLength": 1,
"pattern": "^[0-9A-Za-z_]+$",
"type": "string"
},
"value": {
"maxLength": 64,
"minLength": 1,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
}
},
"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"
},
"inferenceTime": {
"minimum": 0,
"type": "number"
},
"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"
]
},
"updated": {
"minimum": 1,
"type": "integer"
},
"content": {
"minLength": 1,
"type": "string"
},
"predictions": {
"type": "array",
"items": {
"required": [
"confidence",
"label",
"value"
],
"type": "object",
"properties": {
"confidence": {
"maximum": 1,
"minimum": 0,
"type": "number"
},
"label": {
"maxLength": 36,
"minLength": 1,
"pattern": "^[0-9A-Za-z_]+$",
"type": "string"
},
"value": {
"maxLength": 64,
"minLength": 1,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
}
},
"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"
},
"inferenceTime": {
"minimum": 0,
"type": "number"
},
"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"
]
},
"updated": {
"minimum": 1,
"type": "integer"
},
"content": {
"minLength": 1,
"type": "string"
},
"predictions": {
"type": "array",
"items": {
"required": [
"confidence",
"label",
"value"
],
"type": "object",
"properties": {
"confidence": {
"maximum": 1,
"minimum": 0,
"type": "number"
},
"label": {
"maxLength": 36,
"minLength": 1,
"pattern": "^[0-9A-Za-z_]+$",
"type": "string"
},
"value": {
"maxLength": 64,
"minLength": 1,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
}
},
"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"
},
"inferenceTime": {
"minimum": 0,
"type": "number"
},
"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"
]
},
"updated": {
"minimum": 1,
"type": "integer"
},
"content": {
"minLength": 1,
"type": "string"
},
"predictions": {
"type": "array",
"items": {
"required": [
"confidence",
"label",
"value"
],
"type": "object",
"properties": {
"confidence": {
"maximum": 1,
"minimum": 0,
"type": "number"
},
"label": {
"maxLength": 36,
"minLength": 1,
"pattern": "^[0-9A-Za-z_]+$",
"type": "string"
},
"value": {
"maxLength": 64,
"minLength": 1,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}

GET /logs/{logId}

Path name

Path value

logId

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

Header name

Header value

Authorization

Bearer <your access token here>

x-api-key

<your api key here>

Response body JSON Schema

{
"title": "log",
"required": [
"events",
"logId"
],
"type": "object",
"properties": {
"transitionId": {
"anyOf": [
{
"pattern": "^las:transition:[a-f0-9]{32}$",
"type": "string"
},
{
"pattern": "^las:transition:commons-[0-9A-Za-z-]+$",
"type": "string"
}
]
},
"logId": {
"pattern": "^las:log:[a-f0-9]{32}$",
"type": "string"
},
"events": {
"type": "array",
"items": {
"type": "object"
}
}
},
"additionalProperties": false
}

GET /models

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": "models",
"required": [
"models"
],
"type": "object",
"properties": {
"models": {
"type": "array",
"items": {
"required": [
"description",
"height",
"modelId",
"name",
"preprocessConfig",
"width"
],
"type": "object",
"properties": {
"preprocessConfig": {
"required": [
"autoRotate",
"imageQuality",
"maxPages"
],
"type": "object",
"properties": {
"maxPages": {
"type": "integer"
},
"autoRotate": {
"type": "boolean"
},
"imageQuality": {
"type": "string",
"enum": [
"LOW",
"HIGH"
]
}
},
"additionalProperties": false
},
"modelId": {
"pattern": "^las:model:[0-9A-Za-z_]+$",
"type": "string"
},
"name": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"width": {
"type": "integer"
},
"description": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"height": {
"type": "integer"
}
},
"additionalProperties": false
}
},
"nextToken": {
"maxLength": 4096,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}

GET /predictions

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": "predictions",
"required": [
"predictions"
],
"type": "object",
"properties": {
"nextToken": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"predictions": {
"type": "array",
"items": {
"required": [
"documentId",
"inferenceTime",
"modelId",
"predictionId",
"predictions",
"timestamp"
],
"type": "object",
"properties": {
"modelId": {
"pattern": "^las:model:[0-9A-Za-z_]+$",
"type": "string"
},
"inferenceTime": {
"minimum": 0,
"type": "number"
},
"documentId": {
"pattern": "^las:document:[a-f0-9]{32}$",
"type": "string"
},
"predictionId": {
"pattern": "^las:prediction:[a-f0-9]{32}$",
"type": "string"
},
"predictions": {
"type": "array",
"items": {
"required": [
"confidence",
"label",
"value"
],
"type": "object",
"properties": {
"confidence": {
"maximum": 1,
"minimum": 0,
"type": "number"
},
"label": {
"maxLength": 36,
"minLength": 1,
"pattern": "^[0-9A-Za-z_]+$",
"type": "string"
},
"value": {
"maxLength": 64,
"minLength": 1,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
},
"timestamp": {
"minimum": 1,
"type": "integer"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}

POST /predictions

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 /predictions",
"required": [
"documentId",
"modelId"
],
"type": "object",
"properties": {
"modelId": {
"pattern": "^las:model:[0-9A-Za-z_]+$",
"type": "string"
},
"maxPages": {
"maximum": 3,
"minimum": 1,
"type": "integer"
},
"documentId": {
"pattern": "^las:document:[a-f0-9]{32}$",
"type": "string"
},
"autoRotate": {
"type": "boolean"
},
"imageQuality": {
"type": "string",
"enum": [
"LOW",
"HIGH"
]
}
},
"additionalProperties": false
}

Response body JSON Schema

{
"title": "prediction",
"required": [
"documentId",
"inferenceTime",
"modelId",
"predictionId",
"predictions",
"timestamp"
],
"type": "object",
"properties": {
"modelId": {
"pattern": "^las:model:[0-9A-Za-z_]+$",
"type": "string"
},
"inferenceTime": {
"minimum": 0,
"type": "number"
},
"documentId": {
"pattern": "^las:document:[a-f0-9]{32}$",
"type": "string"
},
"predictionId": {
"pattern": "^las:prediction:[a-f0-9]{32}$",
"type": "string"
},
"predictions": {
"type": "array",
"items": {
"required": [
"confidence",
"label",
"value"
],
"type": "object",
"properties": {
"confidence": {
"maximum": 1,
"minimum": 0,
"type": "number"
},
"label": {
"maxLength": 36,
"minLength": 1,
"pattern": "^[0-9A-Za-z_]+$",
"type": "string"
},
"value": {
"maxLength": 64,
"minLength": 1,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
},
"timestamp": {
"minimum": 1,
"type": "integer"
}
},
"additionalProperties": false
}

GET /secrets

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": "secrets",
"required": [
"secrets"
],
"type": "object",
"properties": {
"nextToken": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"secrets": {
"type": "array",
"items": {
"required": [
"description",
"name"<