Sign in
Cases

Enqueue document analysis

Enqueue a River job to analyze an extracted document with the chosen AI model

post/v1/cases/{caseId}/documents/{documentId}/analyse

Request

  • Base URL: https://dev.api.bb.tricirc.de (the document declares no server; this is the origin it was published from)
  • URL: https://dev.api.bb.tricirc.de/v1/cases/{caseId}/documents/{documentId}/analyse
  • Auth: session-cookie (a scheme the document does not define)

Path parameters

caseIdstring required
documentIdstring required

Request body

$schemastring uri

A URL to the JSON Schema for this object.

languagestring

Locale to write the analysis output in (e.g. de, en, ru, ua, pl, ar)

modelstring required

AI model to run the analysis with; see GET /v1/models

Example request

{
  "$schema": "https://example.com/schemas/EnqueueDocumentAnalysisInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

documentIdstring required
jobIdinteger required

Example response

{
  "$schema": "https://example.com/schemas/EnqueueDocumentAnalysisOutputBody.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.