Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.phrony.com/llms.txt

Use this file to discover all available pages before exploring further.

Phrony exposes a JSON HTTP API for running agents from your own backends and clients. Requests use https and, for authenticated routes, a workspace API key in the X-API-Key header.

​
Base URL

EnvironmentBase URL (example)
Phrony Cloudhttps://api.phrony.com
Self‑hosted or stagingAs configured by your team (path layout under /v1 is the same)
There is no extra path prefix before the API version. Full example: https://api.phrony.com/v1/agents/{agentId}/runs.

​
Quick examples

Set PHRONY_API_KEY and AGENT_ID from the Phrony dashboard. Use runId from the start response to poll. Each group shows the same start a run, then get run flow. 
export PHRONY_API_BASE="${PHRONY_API_BASE:-https://api.phrony.com}"
export PHRONY_API_KEY="phk_..."
export AGENT_ID="00000000-0000-0000-0000-000000000000"

curl -sS -X POST "${PHRONY_API_BASE}/v1/agents/${AGENT_ID}/runs" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: ${PHRONY_API_KEY}" \
  -d '{"input":{}}'

# Replace RUN_ID with the runId from the JSON body above
RUN_ID="00000000-0000-0000-0000-000000000001"
curl -sS "${PHRONY_API_BASE}/v1/runs/${RUN_ID}" \
  -H "X-API-Key: ${PHRONY_API_KEY}"
See Agents, Runs, and File library for more endpoints and full examples.

​
Versioning

All documented paths use the v1 prefix. Future versions, if any, will be named explicitly.

​
How this relates to the guides

  • Embedded agents — End‑to‑end flow: API trigger, API key, start run, poll, optional file uploads, and code samples.
  • Trigger ingress — Operational log in the Phrony dashboard for API and event start attempts.
Use the pages under API Reference for endpoint and field details; use Embedded agents for procedural guidance.

​
Next steps

Authentication

API keys, headers, and how access is scoped to agents, triggers, and runs.

Agents

Start a run and list sessions for an agent.

Runs

Poll status, conversation, stream, and session messages.

File library

Presign, upload, finalize, and file references in run input.