Skip to navigation

Quickstart

View as Markdown

This guide walks through the initial setup of the Conduit platform, from authentication to running your first document review workflow.

Prerequisites

  • A ConductorAI account with API credentials
  • Access to the Conduit platform dashboard
  • Documents to process (PDF, DOCX, XLSX, or CSV)

Authenticate

1

Obtain API credentials

Navigate to the ConductorAI dashboard and generate an API key from Settings > API Keys.

export CONDUIT_API_KEY="your-api-key"
2

Verify connectivity

Test your connection to the Conduit API:

curl -H "Authorization: Bearer $CONDUIT_API_KEY" \
https://api.conductorai.com/v1/health

Expected response:

{
"status": "healthy",
"version": "2.4.1",
"environment": "production"
}
3

Upload documents

Upload documents for processing:

curl -X POST https://api.conductorai.com/v1/documents \
-H "Authorization: Bearer $CONDUIT_API_KEY" \
-F "file=@policy-document.pdf" \
-F "collection=compliance-review"
4

Run a workflow

Initiate a review workflow on your uploaded documents:

curl -X POST https://api.conductorai.com/v1/workflows/run \
-H "Authorization: Bearer $CONDUIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"workflow": "compliance-review",
"collection": "compliance-review",
"options": {
"auto_approve": false,
"require_human_review": true
}
}'

Next steps