Skip to main content
API docs by Redocly

Cambrion API (1.0)

Download OpenAPI specification:Download

The official Cambrion API specification. To receive a free API key reach out at hello@cambrion.ai with brief description of your use-case.

Executions

Execution environment that store results.

Find out more

Creates an execution

Create an execution from an ID (optional). If an execution ID is given that ID will be used, otherwise a new one is created. If the execution already exists, it will be ignored and 204 will be returned. If a new execution was created, 200 is returned with the execution ID as body.

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Execution is the context which holds data related to a specific execution

executionId
string

ID of the execution

tag
string

Tag to identify the execution

createdAt
string

Creation time

completedAt
string

Completion time

duration
number

Duration in seconds

status
string

Status of the current execution. Includes error message in case of error.

object
hookIds
Array of strings

Optional list of hook IDs to trigger for this execution. The referenced hooks will be notified when events occur on this execution (status changes, observation updates, etc.).

Responses

Request samples

Content type
application/json
{
  • "executionId": "string",
  • "tag": "string",
  • "createdAt": "string",
  • "completedAt": "string",
  • "duration": 0,
  • "status": "string",
  • "metaData": { },
  • "hookIds": [
    ]
}

Response samples

Content type
application/json
{
  • "executionId": "string",
  • "tag": "string",
  • "createdAt": "string",
  • "completedAt": "string",
  • "duration": 0,
  • "status": "string",
  • "metaData": { },
  • "hookIds": [
    ]
}

Gets all executions

Authorizations:
ApiKeyAuth
query Parameters
tag
string

Filter executions by tag

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets execution

Authorizations:
ApiKeyAuth
path Parameters
executionId
required
string

ID of an execution

Responses

Response samples

Content type
application/json
{
  • "executionId": "string",
  • "tag": "string",
  • "createdAt": "string",
  • "completedAt": "string",
  • "duration": 0,
  • "status": "string",
  • "metaData": { },
  • "hookIds": [
    ]
}

Deletes an execution

Authorizations:
ApiKeyAuth
path Parameters
executionId
required
string

ID of an execution

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Add media to an observation

Authorizations:
ApiKeyAuth
path Parameters
executionId
required
string

ID of an execution

Request Body schema:
string <base64>

Responses

Response samples

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

Retrieve a specific media

Authorizations:
ApiKeyAuth
path Parameters
executionId
required
string

ID of an execution

mediaId
required
string

ID of uploaded media

Responses

Merge a raw observation into the current observation

The raw observation is merged into the current observation context.

Authorizations:
ApiKeyAuth
path Parameters
executionId
required
string

ID of an execution

Request Body schema: application/json

Observation request

executionId
required
string
Array of objects (Image Content)
Array of objects (Linked Document)

Responses

Request samples

Content type
application/json
{
  • "executionId": "execution-1",
  • "mediaContents": [
    ],
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Get observation

Get a full observation of the execution.

Authorizations:
ApiKeyAuth
path Parameters
executionId
required
string

ID of an execution

Responses

Response samples

Content type
application/json
{
  • "executionId": "execution-1",
  • "mediaContents": [
    ],
  • "documents": [
    ]
}

Transform an observation

Transform a raw observation into an object using a JSONata statement. JSONata is a transformation language for JSON data. It can be used to transform . For more information see http://docs.jsonata.org/overview.html

Authorizations:
ApiKeyAuth
path Parameters
executionId
required
string

ID of an execution

Request Body schema: text/plain
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Transform an observation into JSON

Transform a raw observation into the corresponding JSON object. The values in the JSON object correspond to the data values in the observation. If data values are not available, the raw text is used.

Authorizations:
ApiKeyAuth
path Parameters
executionId
required
string

ID of an execution

Responses

Response samples

Content type
application/json
{ }

Submit refinements to an observation

Submit user corrections to extracted data. Refinements can target entities, key-value pairs, tables, or key-value sets by their IDs. Refinements are additive - original data is preserved.

Authorizations:
ApiKeyAuth
path Parameters
executionId
required
string

ID of an execution

Request Body schema: application/json
Array of objects (Entity Refinement Item)

Refinements for individual entities

Array of objects (Key Value Pair Refinement Item)

Refinements for key-value pair associations

Array of objects (Table Refinement Item)

Structural refinements for tables

Array of objects (Key Value Set Refinement Item)

Structural refinements for key-value sets

Responses

Request samples

Content type
application/json
{
  • "entityRefinements": [
    ],
  • "keyValuePairRefinements": [
    ],
  • "tableRefinements": [
    ],
  • "keyValueSetRefinements": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Get all refinements for an observation

Retrieve a summary of all refinements that have been applied to the observation.

Authorizations:
ApiKeyAuth
path Parameters
executionId
required
string

ID of an execution

Responses

Response samples

Content type
application/json
{
  • "executionId": "string",
  • "totalRefinements": 0,
  • "entityRefinementCount": 0,
  • "structuralRefinementCount": 0,
  • "lastUpdated": "2019-08-24T14:15:22Z"
}

Submit an execution

Triggers all SUBMIT-type hooks attached to this execution. This endpoint is used to signal that an execution is ready for external processing or notification. Returns the exact payloads that were sent (or would be sent) to each hook endpoint.

Authorizations:
ApiKeyAuth
path Parameters
executionId
required
string

ID of an execution

Responses

Response samples

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

Retry an execution

Retry a failed or completed execution with a specified pipeline. This updates the existing execution, resetting its status to PENDING and scheduling it for async processing. Only executions with status ERROR or COMPLETED can be retried.

Authorizations:
ApiKeyAuth
path Parameters
executionId
required
string

ID of an execution

Request Body schema: application/json

Request to retry an execution with a specified pipeline

pipelineId
required
string

ID of the pipeline to execute for the retry

Responses

Request samples

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

Response samples

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

Pipelines

Machine learning pipelines.

Find out more in the documentation

Get all deployed pipelines

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new pipeline

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Pipeline request

pipelineId
string
name
string
deploy
boolean
Default: true

Whether to deploy the pipeline when creating/updating it

description
string
tag
string
version
integer
object (PipelineDefinition)

Responses

Request samples

Content type
application/json
{
  • "pipelineId": "receipt-pipeline",
  • "name": "receipt-pipeline",
  • "deploy": true,
  • "description": "A pipeline to extract contents from a receipt",
  • "tag": "string",
  • "version": 1,
  • "pipelineDefinition": {
    }
}

Response samples

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

Get a specific pipeline

Authorizations:
ApiKeyAuth
path Parameters
pipelineId
required
string

ID of the pipeline to execute

Responses

Response samples

Content type
application/json
{
  • "pipeline": {
    },
  • "pipelineDefinition": {
    }
}

Update an existing pipeline

Authorizations:
ApiKeyAuth
path Parameters
pipelineId
required
string

ID of the pipeline to execute

Request Body schema: application/json

Pipeline request

pipelineId
string
name
string
deploy
boolean
Default: true

Whether to deploy the pipeline when creating/updating it

description
string
tag
string
version
integer
object (PipelineDefinition)

Responses

Request samples

Content type
application/json
{
  • "pipelineId": "receipt-pipeline",
  • "name": "receipt-pipeline",
  • "deploy": true,
  • "description": "A pipeline to extract contents from a receipt",
  • "tag": "string",
  • "version": 1,
  • "pipelineDefinition": {
    }
}

Response samples

Content type
application/json
{
  • "pipeline": {
    },
  • "pipelineDefinition": {
    }
}

Delete a specific pipeline

Authorizations:
ApiKeyAuth
path Parameters
pipelineId
required
string

ID of the pipeline to execute

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Get graph representation (definition) of a pipeline

Authorizations:
ApiKeyAuth
path Parameters
pipelineId
required
string

ID of the pipeline to execute

Responses

Response samples

Content type
application/json
{
  • "pipelineDefinitionId": "receipt-pipeline-definition",
  • "nodes": [
    ],
  • "edges": [
    ]
}

Execute pipeline synchronously

Execute a pipeline synchronously and return the corresponding observation. The timeout is 30 seconds. If the computation takes longer than the timeout period a timeout error will be returned.

Authorizations:
ApiKeyAuth
path Parameters
pipelineId
required
string

ID of the pipeline to execute

Request Body schema: application/json

Execution request for a pipeline

executionId
string

ID of the execution

tag
string

Tag used to identify the resulting execution. Ignored if transient is true.

transient
boolean

Whether to delete all execution data after pipeline completion

transform
string

JSONata instruction to transform the result observation into a desired object. JSONata is a transformation language for JSON data. It can be used to transform . For more information see http://docs.jsonata.org/overview.html

tryImageConversion
boolean
Default: false

DEPRECATED: Tries to convert the provided content to an image (e.g. PDF)

trySimpleText
boolean
Default: false

DEPRECATED: Tries to extract readable text from input media (e.g. Word doc). A number of different file formats is supported. Internally Apache Tika is used for text extraction. A full list of supported file formats can be found here: https://tika.apache.org/2.9.1/formats.html

idempotent
boolean
Default: false

Whether to update the existing observation with the results from pipeline run (always true if executionId is null)

media
Array of strings <base64>

Array of base 64 encoded media files. Content type will be detected automatically. For PDF, Docx, PPTX files the files will be rendered as images. The images can then be processed within a pipeline.

object

Not active yet!

object (Execution Observation)

The structured content of a set of media files.

text
string

Raw text that can be used as input in pipelines

hookIds
Array of strings

Optional list of hook IDs to trigger for this pipeline execution. The referenced hooks will be notified when events occur on the resulting execution (status changes, observation updates, etc.).

entryPoint
string

Responses

Request samples

Content type
application/json
{
  • "executionId": "string",
  • "tag": "string",
  • "transient": true,
  • "transform": "string",
  • "tryImageConversion": false,
  • "trySimpleText": false,
  • "idempotent": false,
  • "media": [
    ],
  • "runtimeParameters": { },
  • "observation": {
    },
  • "text": "string",
  • "hookIds": [
    ],
  • "entryPoint": "string"
}

Response samples

Content type
application/json
{
  • "executionId": "string",
  • "observation": {
    }
}

Transform an observation

Execute a pipeline synchronously and return the transformed observation

Authorizations:
ApiKeyAuth
path Parameters
pipelineId
required
string

ID of the pipeline to execute

Request Body schema: application/json

Execution request for a pipeline

executionId
string

ID of the execution

tag
string

Tag used to identify the resulting execution. Ignored if transient is true.

transient
boolean

Whether to delete all execution data after pipeline completion

transform
string

JSONata instruction to transform the result observation into a desired object. JSONata is a transformation language for JSON data. It can be used to transform . For more information see http://docs.jsonata.org/overview.html

tryImageConversion
boolean
Default: false

DEPRECATED: Tries to convert the provided content to an image (e.g. PDF)

trySimpleText
boolean
Default: false

DEPRECATED: Tries to extract readable text from input media (e.g. Word doc). A number of different file formats is supported. Internally Apache Tika is used for text extraction. A full list of supported file formats can be found here: https://tika.apache.org/2.9.1/formats.html

idempotent
boolean
Default: false

Whether to update the existing observation with the results from pipeline run (always true if executionId is null)

media
Array of strings <base64>

Array of base 64 encoded media files. Content type will be detected automatically. For PDF, Docx, PPTX files the files will be rendered as images. The images can then be processed within a pipeline.

object

Not active yet!

object (Execution Observation)

The structured content of a set of media files.

text
string

Raw text that can be used as input in pipelines

hookIds
Array of strings

Optional list of hook IDs to trigger for this pipeline execution. The referenced hooks will be notified when events occur on the resulting execution (status changes, observation updates, etc.).

entryPoint
string

Responses

Request samples

Content type
application/json
{
  • "executionId": "string",
  • "tag": "string",
  • "transient": true,
  • "transform": "string",
  • "tryImageConversion": false,
  • "trySimpleText": false,
  • "idempotent": false,
  • "media": [
    ],
  • "runtimeParameters": { },
  • "observation": {
    },
  • "text": "string",
  • "hookIds": [
    ],
  • "entryPoint": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Transform an observation

Execute a pipeline synchronously and return the corresponding JSON object.

Authorizations:
ApiKeyAuth
path Parameters
pipelineId
required
string

ID of the pipeline to execute

Request Body schema: application/json

Execution request for a pipeline

executionId
string

ID of the execution

tag
string

Tag used to identify the resulting execution. Ignored if transient is true.

transient
boolean

Whether to delete all execution data after pipeline completion

transform
string

JSONata instruction to transform the result observation into a desired object. JSONata is a transformation language for JSON data. It can be used to transform . For more information see http://docs.jsonata.org/overview.html

tryImageConversion
boolean
Default: false

DEPRECATED: Tries to convert the provided content to an image (e.g. PDF)

trySimpleText
boolean
Default: false

DEPRECATED: Tries to extract readable text from input media (e.g. Word doc). A number of different file formats is supported. Internally Apache Tika is used for text extraction. A full list of supported file formats can be found here: https://tika.apache.org/2.9.1/formats.html

idempotent
boolean
Default: false

Whether to update the existing observation with the results from pipeline run (always true if executionId is null)

media
Array of strings <base64>

Array of base 64 encoded media files. Content type will be detected automatically. For PDF, Docx, PPTX files the files will be rendered as images. The images can then be processed within a pipeline.

object

Not active yet!

object (Execution Observation)

The structured content of a set of media files.

text
string

Raw text that can be used as input in pipelines

hookIds
Array of strings

Optional list of hook IDs to trigger for this pipeline execution. The referenced hooks will be notified when events occur on the resulting execution (status changes, observation updates, etc.).

entryPoint
string

Responses

Request samples

Content type
application/json
{
  • "executionId": "string",
  • "tag": "string",
  • "transient": true,
  • "transform": "string",
  • "tryImageConversion": false,
  • "trySimpleText": false,
  • "idempotent": false,
  • "media": [
    ],
  • "runtimeParameters": { },
  • "observation": {
    },
  • "text": "string",
  • "hookIds": [
    ],
  • "entryPoint": "string"
}

Response samples

Content type
application/json
{ }

Execute pipeline asynchronously

Authorizations:
ApiKeyAuth
path Parameters
pipelineId
required
string

ID of the pipeline to execute

Request Body schema: application/json

Execution request for a pipeline

executionId
string

ID of the execution

tag
string

Tag used to identify the resulting execution. Ignored if transient is true.

transient
boolean

Whether to delete all execution data after pipeline completion

transform
string

JSONata instruction to transform the result observation into a desired object. JSONata is a transformation language for JSON data. It can be used to transform . For more information see http://docs.jsonata.org/overview.html

tryImageConversion
boolean
Default: false

DEPRECATED: Tries to convert the provided content to an image (e.g. PDF)

trySimpleText
boolean
Default: false

DEPRECATED: Tries to extract readable text from input media (e.g. Word doc). A number of different file formats is supported. Internally Apache Tika is used for text extraction. A full list of supported file formats can be found here: https://tika.apache.org/2.9.1/formats.html

idempotent
boolean
Default: false

Whether to update the existing observation with the results from pipeline run (always true if executionId is null)

media
Array of strings <base64>

Array of base 64 encoded media files. Content type will be detected automatically. For PDF, Docx, PPTX files the files will be rendered as images. The images can then be processed within a pipeline.

object

Not active yet!

object (Execution Observation)

The structured content of a set of media files.

text
string

Raw text that can be used as input in pipelines

hookIds
Array of strings

Optional list of hook IDs to trigger for this pipeline execution. The referenced hooks will be notified when events occur on the resulting execution (status changes, observation updates, etc.).

entryPoint
string

Responses

Request samples

Content type
application/json
{
  • "executionId": "string",
  • "tag": "string",
  • "transient": true,
  • "transform": "string",
  • "tryImageConversion": false,
  • "trySimpleText": false,
  • "idempotent": false,
  • "media": [
    ],
  • "runtimeParameters": { },
  • "observation": {
    },
  • "text": "string",
  • "hookIds": [
    ],
  • "entryPoint": "string"
}

Response samples

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

Extractions

Extraction definitions.

Find out more in the documentation

Get all extractions

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create extraction

Create a document extraction. This automatically creates a pipeline that corresponds to the instructions in the extraction.

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Extraction request

description
string

The description of the extraction

compact
boolean
Default: false

Faster response but no confidences

highPrecision
boolean
Default: false

Used for higher precision but slower response

size
number
Default: 1300

Image resolution in px. Higher leads to better precision but slower response.

parallelProcessing
boolean
Default: false

Pages will be processed in parallel. This leads to lower latency but context between pages will be lost.

intelligentBatching
boolean
Default: false

The AI will batch as many pages together as possible. This allows understanding content across pages. Will be ignored if parallelProcessing is true.

targetModel
string
object

The instruct JSON expression that is used to describe the extraction.

hookIds
Array of strings

List of hook IDs to attach to executions created from this extraction.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "compact": false,
  • "highPrecision": false,
  • "size": 1300,
  • "parallelProcessing": false,
  • "intelligentBatching": false,
  • "targetModel": "string",
  • "generationInstruct": { },
  • "hookIds": [
    ]
}

Response samples

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

Get specific extraction

Authorizations:
ApiKeyAuth
path Parameters
extractionId
required
string

ID of an extraction

Responses

Response samples

Content type
application/json
{
  • "extractionId": "string",
  • "description": "string",
  • "state": "string",
  • "compact": false,
  • "highPrecision": false,
  • "size": 1300,
  • "parallelProcessing": false,
  • "intelligentBatching": false,
  • "targetModel": "string",
  • "generationInstruct": { },
  • "hookIds": [
    ]
}

Update extraction

Update an existing extraction and the corresponding pipeline.

Authorizations:
ApiKeyAuth
path Parameters
extractionId
required
string

ID of an extraction

Request Body schema: application/json

Extraction request

description
string

The description of the extraction

compact
boolean
Default: false

Faster response but no confidences

highPrecision
boolean
Default: false

Used for higher precision but slower response

size
number
Default: 1300

Image resolution in px. Higher leads to better precision but slower response.

parallelProcessing
boolean
Default: false

Pages will be processed in parallel. This leads to lower latency but context between pages will be lost.

intelligentBatching
boolean
Default: false

The AI will batch as many pages together as possible. This allows understanding content across pages. Will be ignored if parallelProcessing is true.

targetModel
string
object

The instruct JSON expression that is used to describe the extraction.

hookIds
Array of strings

List of hook IDs to attach to executions created from this extraction.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "compact": false,
  • "highPrecision": false,
  • "size": 1300,
  • "parallelProcessing": false,
  • "intelligentBatching": false,
  • "targetModel": "string",
  • "generationInstruct": { },
  • "hookIds": [
    ]
}

Response samples

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

Delete extraction

Authorizations:
ApiKeyAuth
path Parameters
extractionId
required
string

ID of an extraction

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Suggest changes to an extraction

Suggest changes to an extraction

Authorizations:
ApiKeyAuth
path Parameters
extractionId
required
string

ID of an extraction

Request Body schema: application/json

Suggest a change to an existing extraction via natural language or examples

media
Array of strings <base64>

Array of base 64 encoded media files. The media files will be used to derive a suggestion for a possible underlying extraction. Content type will be detected automatically. For PDF, Docx, PPTX files the files will be rendered as images. The images can then be processed within a pipeline.

documentContext
string
instruction
string
Array of objects (Feedback)

Responses

Request samples

Content type
application/json
{
  • "media": [
    ],
  • "documentContext": "string",
  • "instruction": "string",
  • "feedback": [
    ]
}

Response samples

Content type
application/json
{
  • "extractionId": "string",
  • "description": "string",
  • "state": "string",
  • "compact": false,
  • "highPrecision": false,
  • "size": 1300,
  • "parallelProcessing": false,
  • "intelligentBatching": false,
  • "targetModel": "string",
  • "generationInstruct": { },
  • "hookIds": [
    ]
}

Suggest changes to an extraction asynchronously

Suggest changes to an extraction asynchronously

Authorizations:
ApiKeyAuth
path Parameters
extractionId
required
string

ID of an extraction

Request Body schema: application/json

Suggest a change to an existing extraction via natural language or examples

media
Array of strings <base64>

Array of base 64 encoded media files. The media files will be used to derive a suggestion for a possible underlying extraction. Content type will be detected automatically. For PDF, Docx, PPTX files the files will be rendered as images. The images can then be processed within a pipeline.

documentContext
string
instruction
string
Array of objects (Feedback)

Responses

Request samples

Content type
application/json
{
  • "media": [
    ],
  • "documentContext": "string",
  • "instruction": "string",
  • "feedback": [
    ]
}

Response samples

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

Improve an extraction with an example

Improve an extraction with an example

Authorizations:
ApiKeyAuth
path Parameters
extractionId
required
string

ID of an extraction

Request Body schema: application/json

Add feedback via examples

note
string
object (FeedbackExample)

Feedback example

Responses

Request samples

Content type
application/json
{
  • "note": "string",
  • "example": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Get all indices

Get a list of all indices.

Authorizations:
ApiKeyAuth
query Parameters
limit
integer

Limits the number of indices on a page

offset
integer

Specifies the page number of the indices to be displayed

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create index

Create a new index with an optional schema.

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Index creation request

indexId
string

Unique ID of the index.

semanticSearchFields
Array of strings

A list of document fields that is used to semantically embed the field text.

Responses

Request samples

Content type
application/json
{
  • "indexId": "string",
  • "semanticSearchFields": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Get index description

Get the description of an index. Including the data model if present.

Authorizations:
ApiKeyAuth
path Parameters
indexId
required
string
Example: Warehouse-Index

ID of the index

Responses

Response samples

Content type
application/json
{
  • "indexId": "string",
  • "semanticSearchFields": [
    ]
}

Delete index

Delete an index.

Authorizations:
ApiKeyAuth
path Parameters
indexId
required
string
Example: Warehouse-Index

ID of the index

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Query an index with a search string

Query an index with a search string

Authorizations:
ApiKeyAuth
path Parameters
indexId
required
string
Example: Warehouse-Index

ID of the index

Request Body schema: application/json

Query request

object

Fields used for full text search

object

A map that maps search strings to fields.

k
integer

The number of results to return that are similar to the search string

searchPipelineId
string

ID of the pipeline to be used for searching. If no pipeline is given, the default pipeline according to the number of search fields is selected.

object (PipelineExecutionObject)

The execution is a stateful environment in which media (such as images or PDF files) can be stored an used an inputs for pipelines. The ID in the request body is optional (generated if empty) and must be unique. Nothing will be persisted if transient is true. In order to trigger the pipeline either an execution ID containing valid media or base 64 encoded media under the media property have to be provided.

Responses

Request samples

Content type
application/json
{
  • "fullText": {
    },
  • "semanticSearch": {
    },
  • "k": 0,
  • "searchPipelineId": "string",
  • "pipelineParameters": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Get all documents

Authorizations:
ApiKeyAuth
path Parameters
indexId
required
string
Example: Warehouse-Index

ID of the index

query Parameters
limit
integer

Limits the number of documents on a page

offset
integer

Specifies the page number of the documents to be displayed

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create document

Create a JSON document in an index. If the index does not exist it will be created automatically.

Authorizations:
ApiKeyAuth
path Parameters
indexId
required
string
Example: Warehouse-Index

ID of the index

Request Body schema: application/json

Document request

indexId
string
object
score
number

Responses

Request samples

Content type
application/json
{
  • "indexId": "string",
  • "source": { },
  • "score": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Create document

Create a JSON document in an index. If the index does not exist it will be created automatically.

Authorizations:
ApiKeyAuth
path Parameters
indexId
required
string
Example: Warehouse-Index

ID of the index

Request Body schema: application/json

Document batch request

Array
indexId
string
object
score
number

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Get document

Authorizations:
ApiKeyAuth
path Parameters
indexId
required
string
Example: Warehouse-Index

ID of the index

documentId
required
string

ID of a document

Responses

Response samples

Content type
application/json
{
  • "indexId": "string",
  • "source": { },
  • "score": 0
}

Delete document

Authorizations:
ApiKeyAuth
path Parameters
indexId
required
string
Example: Warehouse-Index

ID of the index

documentId
required
string

ID of a document

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Hooks

Webhook and notification hooks for execution events.

Find out more in the documentation

Create a hook

Create a hook that will be triggered when specific events occur on executions. Hooks can notify external services via webhooks when execution status changes, observations are updated, or when submit events are triggered.

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Hook creation or update request

hookId
string

Unique identifier for the hook (auto-generated if not provided)

name
string

Human-readable name for the hook

eventType
required
string (Hook Event Type)
Enum: "STATUS_CHANGE" "OBSERVATION_UPDATE" "SUBMIT"

The type of event that triggers the hook

hookType
required
string (Hook Type)
Enum: "WEBHOOK" "KAFKA" "NATS"

The delivery mechanism for the hook

endpoint
required
string

Target URL for webhook delivery

object

Custom headers to include in webhook requests (e.g., for authentication)

statusFilter
Array of strings

For STATUS_CHANGE events: list of statuses that trigger the hook. If empty or not provided, the hook triggers on any status change.

payloadType
required
string (Hook Payload Type)
Enum: "RAW" "JSON" "TRANSFORM" "FORM_TRANSFORM"

How to format the payload sent by the hook

transform
string

JSONata expression to transform the observation before sending. Required when payloadType is TRANSFORM or FORM_TRANSFORM. For more information see http://docs.jsonata.org/overview.html

formPayloadKey
string
Default: "payload"

For FORM_TRANSFORM payloads: the form field name for the transformed JSON data. Defaults to "payload" if not specified.

formDocumentKey
string
Default: "documents"

For FORM_TRANSFORM payloads: the form field name prefix for media files. Multiple files will be named as {key}[0], {key}[1], etc. if there are multiple files. Defaults to "documents" if not specified.

enabled
boolean
Default: true

Whether the hook is active

createdAt
string <date-time>

Timestamp when the hook was created (auto-set)

Responses

Request samples

Content type
application/json
{
  • "hookId": "string",
  • "name": "string",
  • "eventType": "STATUS_CHANGE",
  • "hookType": "WEBHOOK",
  • "endpoint": "https://example.com/webhook",
  • "headers": {
    },
  • "statusFilter": [
    ],
  • "payloadType": "RAW",
  • "transform": "string",
  • "formPayloadKey": "payload",
  • "formDocumentKey": "documents",
  • "enabled": true,
  • "createdAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "hookId": "string",
  • "name": "string",
  • "eventType": "STATUS_CHANGE",
  • "hookType": "WEBHOOK",
  • "endpoint": "https://example.com/webhook",
  • "headers": {
    },
  • "statusFilter": [
    ],
  • "payloadType": "RAW",
  • "transform": "string",
  • "formPayloadKey": "payload",
  • "formDocumentKey": "documents",
  • "enabled": true,
  • "createdAt": "2019-08-24T14:15:22Z"
}

Get all hooks

Retrieve all configured hooks.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a specific hook

Retrieve a specific hook by its ID.

Authorizations:
ApiKeyAuth
path Parameters
hookId
required
string

ID of a hook

Responses

Response samples

Content type
application/json
{
  • "hookId": "string",
  • "name": "string",
  • "eventType": "STATUS_CHANGE",
  • "hookType": "WEBHOOK",
  • "endpoint": "https://example.com/webhook",
  • "headers": {
    },
  • "statusFilter": [
    ],
  • "payloadType": "RAW",
  • "transform": "string",
  • "formPayloadKey": "payload",
  • "formDocumentKey": "documents",
  • "enabled": true,
  • "createdAt": "2019-08-24T14:15:22Z"
}

Update a hook

Update an existing hook configuration.

Authorizations:
ApiKeyAuth
path Parameters
hookId
required
string

ID of a hook

Request Body schema: application/json

Hook creation or update request

hookId
string

Unique identifier for the hook (auto-generated if not provided)

name
string

Human-readable name for the hook

eventType
required
string (Hook Event Type)
Enum: "STATUS_CHANGE" "OBSERVATION_UPDATE" "SUBMIT"

The type of event that triggers the hook

hookType
required
string (Hook Type)
Enum: "WEBHOOK" "KAFKA" "NATS"

The delivery mechanism for the hook

endpoint
required
string

Target URL for webhook delivery

object

Custom headers to include in webhook requests (e.g., for authentication)

statusFilter
Array of strings

For STATUS_CHANGE events: list of statuses that trigger the hook. If empty or not provided, the hook triggers on any status change.

payloadType
required
string (Hook Payload Type)
Enum: "RAW" "JSON" "TRANSFORM" "FORM_TRANSFORM"

How to format the payload sent by the hook

transform
string

JSONata expression to transform the observation before sending. Required when payloadType is TRANSFORM or FORM_TRANSFORM. For more information see http://docs.jsonata.org/overview.html

formPayloadKey
string
Default: "payload"

For FORM_TRANSFORM payloads: the form field name for the transformed JSON data. Defaults to "payload" if not specified.

formDocumentKey
string
Default: "documents"

For FORM_TRANSFORM payloads: the form field name prefix for media files. Multiple files will be named as {key}[0], {key}[1], etc. if there are multiple files. Defaults to "documents" if not specified.

enabled
boolean
Default: true

Whether the hook is active

createdAt
string <date-time>

Timestamp when the hook was created (auto-set)

Responses

Request samples

Content type
application/json
{
  • "hookId": "string",
  • "name": "string",
  • "eventType": "STATUS_CHANGE",
  • "hookType": "WEBHOOK",
  • "endpoint": "https://example.com/webhook",
  • "headers": {
    },
  • "statusFilter": [
    ],
  • "payloadType": "RAW",
  • "transform": "string",
  • "formPayloadKey": "payload",
  • "formDocumentKey": "documents",
  • "enabled": true,
  • "createdAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "hookId": "string",
  • "name": "string",
  • "eventType": "STATUS_CHANGE",
  • "hookType": "WEBHOOK",
  • "endpoint": "https://example.com/webhook",
  • "headers": {
    },
  • "statusFilter": [
    ],
  • "payloadType": "RAW",
  • "transform": "string",
  • "formPayloadKey": "payload",
  • "formDocumentKey": "documents",
  • "enabled": true,
  • "createdAt": "2019-08-24T14:15:22Z"
}

Delete a hook

Delete a hook.

Authorizations:
ApiKeyAuth
path Parameters
hookId
required
string

ID of a hook

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Models

Get all registered models

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Register an uploaded model (currently internal only)

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Model request

name
string
object (ModelDescription)
object

Responses

Request samples

Content type
application/json
{
  • "name": "receipt-pipeline",
  • "description": {
    },
  • "config": { }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Copy a registered model

Authorizations:
ApiKeyAuth
path Parameters
modelName
required
string

Name of the model

Request Body schema: application/json

Model Copy request

newName
string
object (ModelDescription)
object

Responses

Request samples

Content type
application/json
{
  • "newName": "receipt-pipeline",
  • "newDescription": {
    },
  • "newConfig": { }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}