API Reference

Create Workflow

Create a new workflow definition.

Example:

{
  "name": "PDF Processing Pipeline",
  "team_id": 1,
  "steps": [
    {
      "step_key": "marker_parse",
      "unique_name": "parse",
      "settings": {"extract_images": true}
    },
    {
      "step_key": "marker_extract",
      "unique_name": "extract",
      "version": "1.0.0",
      "settings": {},
      "depends_on": ["parse"]
    },
    {
      "step_key": "marker_segment",
      "unique_name": "segment",
      "settings": {"method": "auto"},
      "depends_on": ["parse"]
    }
  ]
}

This creates a template that can be executed multiple times. Note:

version is optional and defaults to the latest active version
unique_name is required and must be unique within the workflow
depends_on references other steps by their unique_name

POST

api

workflows

Create Workflow

import requests

url = "https://www.datalab.to/api/v1/workflows/workflows"

payload = {
    "name": "<string>",
    "steps": [
        {
            "step_key": "<string>",
            "unique_name": "<string>",
            "version": "<string>",
            "settings": {},
            "depends_on": []
        }
    ]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

curl --request POST \
  --url https://www.datalab.to/api/v1/workflows/workflows \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "steps": [
    {
      "step_key": "<string>",
      "unique_name": "<string>",
      "version": "<string>",
      "settings": {},
      "depends_on": []
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    steps: [
      {
        step_key: '<string>',
        unique_name: '<string>',
        version: '<string>',
        settings: {},
        depends_on: []
      }
    ]
  })
};

fetch('https://www.datalab.to/api/v1/workflows/workflows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.datalab.to/api/v1/workflows/workflows"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"steps\": [\n    {\n      \"step_key\": \"<string>\",\n      \"unique_name\": \"<string>\",\n      \"version\": \"<string>\",\n      \"settings\": {},\n      \"depends_on\": []\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": 123,
  "name": "<string>",
  "team_id": 123,
  "steps": [
    {}
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Cookies

wos-session

string

datalab_active_team

string

Body

application/json

Request to create a new workflow definition.

name

string

required

steps

WorkflowStepDefinition · object[]

required

Show child attributes

Response

Successful Response

Response with workflow definition details.

integer

required

name

string

required

team_id

integer

required

steps

Steps · object[]

required

Create Workflow

import requests

url = "https://www.datalab.to/api/v1/workflows/workflows"

payload = {
    "name": "<string>",
    "steps": [
        {
            "step_key": "<string>",
            "unique_name": "<string>",
            "version": "<string>",
            "settings": {},
            "depends_on": []
        }
    ]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

curl --request POST \
  --url https://www.datalab.to/api/v1/workflows/workflows \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "steps": [
    {
      "step_key": "<string>",
      "unique_name": "<string>",
      "version": "<string>",
      "settings": {},
      "depends_on": []
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    steps: [
      {
        step_key: '<string>',
        unique_name: '<string>',
        version: '<string>',
        settings: {},
        depends_on: []
      }
    ]
  })
};

fetch('https://www.datalab.to/api/v1/workflows/workflows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.datalab.to/api/v1/workflows/workflows"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"steps\": [\n    {\n      \"step_key\": \"<string>\",\n      \"unique_name\": \"<string>\",\n      \"version\": \"<string>\",\n      \"settings\": {},\n      \"depends_on\": []\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": 123,
  "name": "<string>",
  "team_id": 123,
  "steps": [
    {}
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

compliance

API Reference

Custom Processors

Processor Templates

Custom Pipelines (Deprecated)

Pipeline Templates (Deprecated)

files

eval_rubrics

collections

pipelines

extraction_schemas

Create Workflow

Authorizations

Cookies

Body

Response