Quickstart

Create a key and make your first API calls in five minutes.

You need a workspace and the workspace admin role to create a key.

Create an API key
In the app, open Workspace → API keys and choose New API key. Give it a name, tick the scopes you need — for this quickstart agents:read and tasks:write — and pick an expiry. Copy the key: it is shown once.
Store it as a secret
Keep the key in a secret manager or an environment variable on your server. Never put it in a browser, a mobile app or a repository.
```
export AGENTWORKS_API_KEY="aw_ak_…"
export AGENTWORKS_API_URL="https://api.agent-works.ai"
```
Check who the key is
```
curl "$AGENTWORKS_API_URL/auth/me" \
  -H "Authorization: Bearer $AGENTWORKS_API_KEY"
```
The answer shows the person and workspace the key acts as. This endpoint needs no scope.

List your agents

curl "$AGENTWORKS_API_URL/agents/?limit=10" \
  -H "Authorization: Bearer $AGENTWORKS_API_KEY"

Create a task

curl -X POST "$AGENTWORKS_API_URL/tasks" \
  -H "Authorization: Bearer $AGENTWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "Check invoice 2026-0412", "description": "Compare the invoice with the purchase order."}'

tasks:write includes tasks:read, so the same key can read the task back.

Next steps

Hand work to agents: assign the task to an agent and follow the run.
Scopes: give each integration only what it needs.
Rate limits and errors: build a client that backs off correctly.