Developers
API Reference
Integrate Alfred into your own tooling with the REST API and WebSocket streams. A full OpenAPI spec is coming soon.
Authentication
All requests require a Bearer token. Find your API key in your Alfred workspace under Settings → API Keys.
Authorization: Bearer alf_live_xxxxxxxxxxxxxxxxxxxx Base URL: https://api.alfred3.com
Endpoints
/v1/projects
List all projects in your workspace.
/v1/projects/:id/tasks
List all Kanban tasks for a project.
/v1/tasks
Create a new task and optionally assign it to an agent.
/v1/tasks/:id
Update task status, assignee, or metadata.
/v1/squads/:id/status
Get live status of all agents in a squad.
/v1/context
Set context (focus windows, constraints, criteria) for a project.
/v1/graph/:projectId
Fetch the Knowledge Graph for a project as JSON.
/v1/ws/squad/:id
Stream real-time agent execution events.
WebSocket events
The WebSocket stream emits structured JSON events for all agent activity:
{ "type": "agent.started", "agentId": "ag_123", "taskId": "task_456" }
{ "type": "agent.progress", "agentId": "ag_123", "percent": 42 }
{ "type": "shard.submitted", "shardId": "sh_789", "agentId": "ag_123" }
{ "type": "shard.passed", "shardId": "sh_789" }
{ "type": "shard.failed", "shardId": "sh_789", "reason": "test_failure" }
{ "type": "shard.merged", "shardId": "sh_789", "branch": "feat/task-456" }