API Reference

The ReArch API allows you to programmatically interact with agents, pipelines, and project resources.

Base URL

https://api.rearch.engineer/v1

All API requests must include an Authorization header with a valid API key.

Authentication

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.rearch.engineer/v1/agents

Endpoints

Agents

List Agents

GET /v1/agents

Response:

{
  "data": [
    {
      "id": "agent_abc123",
      "name": "code-reviewer",
      "status": "active",
      "created_at": "2025-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "per_page": 20
  }
}

Create Agent

POST /v1/agents

Request Body:

Field	Type	Required	Description
name	string	Yes	Agent name (unique within project)
type	string	Yes	Agent type: reviewer, builder, deployer
config	object	No	Agent-specific configuration

Example:

curl -X POST https://api.rearch.engineer/v1/agents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-reviewer",
    "type": "reviewer",
    "config": {
      "language": "typescript",
      "strictMode": true
    }
  }'

Get Agent

GET /v1/agents/:id

Delete Agent

DELETE /v1/agents/:id

Pipelines

List Pipelines

GET /v1/pipelines

Run Pipeline

POST /v1/pipelines/:id/run

Request Body:

Field	Type	Required	Description
input	object	Yes	Input data for the pipeline
async	boolean	No	Run asynchronously (default: false)
webhook_url	string	No	URL to notify on completion

Projects

Get Project

GET /v1/projects/:id

List Project Runs

GET /v1/projects/:id/runs

Error Codes

Code	Description
400	Bad Request — Invalid parameters
401	Unauthorized — Invalid or missing API key
403	Forbidden — Insufficient permissions
404	Not Found — Resource does not exist
429	Too Many Requests — Rate limit exceeded
500	Internal Server Error

Rate Limits

Plan	Requests/minute	Requests/day
Free	60	1,000
Pro	300	10,000
Enterprise	Custom	Custom