DokuBrain
API Reference

Workflows

Automated document processing pipelines

List workflows

GET
/workflows

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Query Parameters

statusstring
searchstring
pageinteger
per_pageinteger
curl -X GET "https://api.dokubrain.com/api/v1/workflows?status=%3Cstring%3E&search=%3Cstring%3E&page=0&per_page=0" \
  -H "Authorization: Bearer <token>"

Workflow list

{
  "success": true,
  "data": {},
  "message": "string"
}

Create a workflow

POST
/workflows

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Request Body

application/jsonRequired
nameRequiredstring
descriptionstring
nodesarray<object>
edgesarray<object>
settingsobject
variablesobject
curl -X POST "https://api.dokubrain.com/api/v1/workflows" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "nodes": [
      {}
    ],
    "edges": [
      {}
    ],
    "settings": {},
    "variables": {}
  }'

Workflow created

{
  "success": true,
  "data": {},
  "message": "string"
}

Get workflow details

GET
/workflows/{id}

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Path Parameters

idRequiredstring
curl -X GET "https://api.dokubrain.com/api/v1/workflows/<string>" \
  -H "Authorization: Bearer <token>"

Workflow details

{
  "success": true,
  "data": {},
  "message": "string"
}

Delete a workflow

DELETE
/workflows/{id}

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Path Parameters

idRequiredstring
curl -X DELETE "https://api.dokubrain.com/api/v1/workflows/<string>" \
  -H "Authorization: Bearer <token>"

Workflow deleted

{
  "success": true,
  "data": {},
  "message": "string"
}

Update a workflow

PUT
/workflows/{id}

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Request Body

application/jsonOptional
namestring
descriptionstring
nodesarray<object>
edgesarray<object>

Path Parameters

idRequiredstring
curl -X PUT "https://api.dokubrain.com/api/v1/workflows/<string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "nodes": [
      {}
    ],
    "edges": [
      {}
    ]
  }'

Workflow updated

{
  "success": true,
  "data": {},
  "message": "string"
}

Trigger a workflow run

POST
/workflows/{id}/run

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Request Body

application/jsonOptional
modestring
Value in: "execute" | "dry_run"
inputobject
variablesobject

Path Parameters

idRequiredstring
curl -X POST "https://api.dokubrain.com/api/v1/workflows/<string>/run" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "execute",
    "input": {},
    "variables": {}
  }'

Workflow run started

{
  "success": true,
  "data": {},
  "message": "string"
}

List all workflow runs

GET
/workflows/runs

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Query Parameters

statusstring
pageinteger
per_pageinteger
curl -X GET "https://api.dokubrain.com/api/v1/workflows/runs?status=%3Cstring%3E&page=0&per_page=0" \
  -H "Authorization: Bearer <token>"

Workflow runs

{
  "success": true,
  "data": {},
  "message": "string"
}

Previous

Corpus

Next

Templates