API Reference

The Adroyt REST API lets you read and write project data programmatically, trigger AI agent runs, and subscribe to real-time events via webhooks. All API requests require an API key issued from Settings → API Keys.

Base URL

https://api.adroyt.io/v1

Authentication

Pass your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Rate Limits

Default rate limit is 1,000 requests / minute per tenant. Enterprise plans support higher limits on request.

GET /projects

Returns a paginated list of projects. Supports ?status=AT_RISK, ?limit=50, and ?offset=0 query parameters.

GET /projects/:id

Returns full project details including milestones, team, and budget.

POST /projects

Create a new project. Required fields: name, startDate, endDate. Optional: budget, projectManagerId, description.

PATCH /projects/:id

Update project fields. Only fields provided in the request body are updated.

GET /risks

Returns all risks for the tenant. Filter by ?projectId=, ?status=OPEN, or ?severity=HIGH.

POST /risks

Create a risk. Required: title, projectId, likelihood (1–5), impact (1–5).

POST /agents/run

Trigger an agent run programmatically. Body: { "agentId": "risk-sentinel", "scope": "all", "depth": "standard" }. Returns an executionId.

GET /agents/executions/:executionId

Poll an execution for status (PENDING, RUNNING, COMPLETED, FAILED) and retrieve output when complete.

POST /agents/ask

Send a natural-language question to the Ask Agent. Body: { "question": "Which projects are over budget?" }. Returns an AI-generated answer with citations.

Webhooks let you receive real-time notifications when events occur in Adroyt. Configure webhooks in Settings → Webhooks.

Supported Events

• project.status_changed
• risk.created / risk.severity_escalated
• milestone.missed
• agent.execution_completed
• budget.overrun_detected

Payload Format

All webhook payloads include event, tenantId, timestamp, and an data object specific to the event type. Payloads are signed with HMAC-SHA256 using your webhook secret.

Official client libraries are in development:

• TypeScript / Node.js — npm install @adroyt/sdk
• Python — pip install adroyt

Both SDKs are currently in beta. Contact [email protected] for early access.

API questions and integration support: [email protected]