Skip to main content
This feature is currently in beta. The API may change.
Run an existing published processor with POST /api/v1/agent. You need a processor ID such as cp_XXXXX that your team can access. The processor’s published contract determines the task and output format. Before you begin, make sure you have:
  1. A Datalab account with an API key
  2. Python 3.11+ installed
  3. The Datalab SDK: pip install datalab-python-sdk
  4. Your DATALAB_API_KEY environment variable set
The legacy /api/v1/custom-processor and /api/v1/custom-pipeline run endpoints and their management APIs are deprecated, with an announced sunset of October 31, 2026. Use run_agent() or /api/v1/agent for new integrations. See migration guidance.

Built-in Processors

The published jats processor produces JATS XML for scholarly articles. The published wcag processor produces a tagged Accessible PDF. Both return verification results that need review before using the artifact. See JATS XML and Accessible PDF for complete examples and output fields.

Run a Processor

The SDK polls automatically and returns an AgentResult. Available output fields depend on the published processor. REST clients should check status and success, then download result_url if the completed response provides one.

Pin a Version

Use processor="cp_abc123@2.0" to pin a published version. Omitting the version runs the newest published version. Pin production integrations when you need repeatable processor behavior.

Run Options

AgentOptions accepts the following options. Omitted optional values use API defaults. The published processor sets its output format. Conversion options such as output_format are not run options on this endpoint.

CLI

Next Steps

Python SDK

Configure clients, handle errors, and control polling.

API Overview

Understand submission, polling, and completion responses.

Migration Guide

Replace deprecated custom processor calls.

Webhooks

Receive a notification when a run finishes.