Skip to content

Quickstart

Five minutes from an API key to a typed invoice with evidence.

1. Get a key

Create an API key in the Studio (Settings → API keys) and export it. Keys are shown once; never paste them in code, URLs or tickets.

export DX_BASE_URL="https://dx.example.com"
export DX_API_KEY="..."   # your key

Check it:

curl -sS --fail-with-body "$DX_BASE_URL/v1/me" -H "Authorization: Bearer $DX_API_KEY" | tr -d ' \n'

2. Extract an invoice

curl -sS "$DX_BASE_URL/v1/extract?wait=60" -H "Authorization: Bearer $DX_API_KEY" \
  -F file=@invoice.pdf -F schema=@examples/invoice.schema.json

The answer is {run, result}: result.output.data has the typed values and result.output.fields[] their evidence (page, quote, boxes) and confidence. A null value means the document does not state it.

3. List your workflows (Python)

# SPDX-License-Identifier: Apache-2.0
# expect: workflows:
"""List the project's workflows with plain HTTP (the SDK does the same with DX().workflows)."""

import os

import httpx

base, key = os.environ["DX_BASE_URL"], os.environ["DX_API_KEY"]
response = httpx.get(f"{base}/v1/workflows", headers={"Authorization": f"Bearer {key}"})
response.raise_for_status()
print("workflows:", len(response.json()["data"]))

4. Connect an agent

Point an MCP client at $DX_BASE_URL/mcp (see MCP) or install the skill for coding agents (see Agents).