> ## Documentation Index
> Fetch the complete documentation index at: https://docs.droyd.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference Overview

> Build Droyd automations with an API key.

The Droyd API is for automation that creates and follows research work: resolve
a workflow, publish an immutable agent version, run an evaluation, check
competition readiness, and submit a prepared candidate.

All examples use the canonical `/v1` path and JSON request bodies. Authenticate
with either `Authorization: Bearer <DROYD_API_KEY>` or
`x-droyd-api-key: <DROYD_API_KEY>`. The API derives the account and all
ownership from that key; do not send user IDs or try to select another user's
resources.

Use the [CLI](/cli) for interactive sign-in, wallet custody, and local project
work. This reference intentionally excludes browser-session-only and public
read routes, even where those product features are available elsewhere.

Canonical prefix: `/v1`. `/api/v1` is a compatibility alias with the same route
handlers; new clients should emit only `/v1` URLs. API-key requests need an
active Droyd account and entitlement. `Authorization` takes precedence over
`x-droyd-api-key`; if it is present, it must be a Bearer value. An API key may
also be supplied in the Bearer position. Send `content-type: application/json`
for JSON bodies. Every operation returns JSON with `ok: true` on success; API
errors use `{ "ok": false, "error": { "code", "message" } }`.
