Skip to main content
The gateway is profClaw’s unified entry point for dispatching work to AI agents. It accepts structured requests and routes them to the appropriate agent adapter, workflow, or task queue. Authentication uses Bearer token (tokenAuthMiddleware from src/auth/api-tokens.ts).

​
POST /api/gateway

Submit a request to the gateway. 
curl -X POST http://localhost:3000/api/gateway \
  -H "Authorization: Bearer <api-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "task": {
      "title": "Review PR #42",
      "description": "Check for security issues and code quality",
      "source": "api",
      "priority": 2
    },
    "workflow": "code-review",
    "options": {
      "synchronous": false,
      "notifyUrl": "https://your-service.com/callback"
    }
  }'
Request body
FieldTypeRequiredDescription
taskobjectYesTask definition (see CreateTaskSchema)
workflowstringNoNamed workflow type to execute
options.synchronousbooleanNoWait for completion (default: false)
options.notifyUrlstringNoWebhook URL for completion notification
options.timeoutnumberNoMax wait time in ms (synchronous mode)
Response 202 (async) 
{
  "requestId": "gw_01",
  "taskId": "task_01",
  "status": "queued",
  "estimatedWait": 30000,
  "statusUrl": "http://localhost:3000/api/gateway/gw_01/status"
}
Response 200 (synchronous, options.synchronous: true) 
{
  "requestId": "gw_01",
  "taskId": "task_01",
  "status": "completed",
  "result": {
    "output": "Code review complete. Found 2 issues...",
    "duration": 45230,
    "model": "claude-sonnet-4-6"
  }
}

​
GET /api/gateway/:requestId/status

Poll the status of a gateway request. 
curl http://localhost:3000/api/gateway/gw_01/status \
  -H "Authorization: Bearer <api-token>"
Response 200 
{
  "requestId": "gw_01",
  "taskId": "task_01",
  "status": "in_progress",
  "progress": 65,
  "startedAt": "2026-03-12T10:00:00Z",
  "updatedAt": "2026-03-12T10:00:30Z"
}

​
Workflow Types

workflowDescription
code-reviewAnalyze code changes, check for issues
ticket-resolveWork a ticket end-to-end
test-generationGenerate tests for specified code
refactorApply a refactoring pattern
summarizeSummarize a document or conversation
customFree-form task, no workflow scaffolding

​
API Token Management

API tokens are scoped to the gateway and integration webhooks. Generate tokens in the settings UI or via: 
POST /api/tokens
{ "name": "CI/CD pipeline", "scopes": ["gateway:write"] }
Response 201 
{
  "token": "pct_...",
  "name": "CI/CD pipeline",
  "createdAt": "2026-03-12T10:00:00Z"
}
The token is shown once. Store it securely.

​
Rate Limits

Gateway requests are rate-limited per token:
  • Default: 60 requests / minute
  • Burst: 10 requests / second
Configure via GATEWAY_RATE_LIMIT_RPM environment variable.

​
Gateway Context

The GatewayContext type (src/gateway/types.ts) carries metadata through the request pipeline: 
interface GatewayContext {
  requestId: string;
  tokenId: string;
  workflow?: WorkflowType;
  task: CreateTaskInput;
  options: GatewayOptions;
  receivedAt: Date;
}