Skip to main content
POST
/
api
/
v1
/
custom_pipelines
Submit Custom Pipeline
import requests

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

files = { "files.items": ("example-file", open("example-file", "rb")) }
payload = {
    "request": "<string>",
    "files": "<string>",
    "name": "<string>",
    "file_instructions": "<string>",
    "original_params": "<string>"
}
headers = {"X-API-Key": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)
{
  "response_check_url": "<string>",
  "success": true
}

Authorizations

​
X-API-Key
string
header
required

Cookies

​
wos-session
string
​
access_token
string
​
datalab_active_team
string

Body

multipart/form-data
​
request
string
required

Natural language description of desired pipeline behavior

​
files
file[]
required

Example documents (PDFs, images, etc.) to use for testing

​
name
string | null

Short display name for the pipeline (max 120 chars)

​
file_instructions
string | null

JSON array of per-file instructions: [{"filename": "doc.pdf", "general_instructions": "...", "page_instructions": [{"page": 3, "instructions": "..."}]}]

​
original_params
string | null

JSON string of base ChandraParsePipeline parameters (e.g., '{"output_formats": ["markdown"]}')

Response

Successful Response

Initial response returned immediately after submitting a custom pipeline request.

​
response_check_url
string
required

URL to poll for status and results. Once generation completes, the status response will include the pipeline_id for execution.

​
success
boolean
default:true

Whether the request was accepted