> ## Documentation Index
> Fetch the complete documentation index at: https://docs.remyx.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Agents and runs

> Outrider agents, implementation runs, workflows, and eval environments.

## Outrider agents

The [agent](https://docs.remyx.ai/platform/agents/overview.md) plane: run telemetry, the fleet report, the inbox, and dispatch. Base path `/api/v1.0/outrider`. These endpoints back the studio's Agents, Reports, and Inbox views and the MCP fleet tools, so what you read here matches the app exactly. Visibility is scoped to your own agents. Read routes need `recommendations:read`; install and dispatch routes need `provisioning:*`.

### Runs & telemetry

```
POST /api/v1.0/outrider/runs
GET  /api/v1.0/outrider/runs
```

`POST /runs` is called by the [Outrider action](https://docs.remyx.ai/platform/agents/outrider-action.md) itself (authenticated with the repo's provisioned agent key) to report per-run telemetry: cost identity (agent, backend, model, tokens, cost basis), selection audit (pool sizes, per-candidate rejections, reasoning excerpt), routing and gate outcomes, chain phases, and file-touch lists. Idempotent on `run_id`.

`GET /runs` lists your runs; params `repo`, `limit` (default 20, max 100), and `include=selection` to add the selection audit trail.

```
POST /api/v1.0/outrider/agents/runs/analyze
```

Root-cause analysis of one run from its job log: `{repo, run_id}` → cause, evidence bullets, suggested next step. Cached per run.

### Fleet report, activity, and inbox

```
GET  /api/v1.0/outrider/agents/report
GET  /api/v1.0/outrider/agents/activity?repo=owner/name
GET  /api/v1.0/outrider/agents/inbox
POST /api/v1.0/outrider/agents/inbox/dismiss
POST /api/v1.0/outrider/agents/inbox/digest
POST /api/v1.0/outrider/agents/artifact/diff
POST /api/v1.0/outrider/agents/artifact/evidence
POST /api/v1.0/outrider/agents/refresh
POST /api/v1.0/outrider/agents/chat
GET  /api/v1.0/outrider/agents/chat/tasks/<task_id>
POST /api/v1.0/outrider/agents/validations
```

* `/agents/report`: the [fleet report](https://docs.remyx.ai/platform/review/reports.md): headline, KPIs, per-agent timelines and terminal states, findings, idea insights, deliverable pipeline, chronology. `since`/`until` (YYYY-MM-DD) and `repos` (intersected with your own footprint) scope it.
* `/agents/activity`: one agent's runs, events, directions, and summary; backs [Agent detail](https://docs.remyx.ai/platform/agents/overview.md#the-agent-report).
* `/agents/inbox`: the derived [Inbox](https://docs.remyx.ai/platform/review/inbox.md); `inbox/dismiss` archives `{id}` or `{ids: […]}` (or `undo: true`), `inbox/digest` generates once and persists the TLDR digest for a PR or Issue `{href}`, `artifact/diff` returns the per-file diff of an agent-authored PR `{href}`, and `artifact/evidence` returns the deterministic gate and fidelity facts for one artifact.
* `/agents/refresh`: force a re-fetch of agent state from GitHub (`{full: false}` for a delta).
* `/agents/chat`: one turn of the Ask chat: `{repo, messages[], focus_run_id?}`; long turns return a task to poll at `chat/tasks/<task_id>`. Context is assembled server-side, and the transcript carries no privileged access.
* `/agents/validations`: turn `@remyx-ai validate` on or off for one agent's repo: `{repo, enabled}`. The per-installation switch lives under [GitHub App](https://docs.remyx.ai/api-reference/projects.md#github-app) and covers every repo the installation does.

### Installations, capabilities, and dispatch

```
GET  /api/v1.0/outrider/installations
POST /api/v1.0/outrider/installations/<id>/revoke
GET  /api/v1.0/outrider/agent-matrix
POST /api/v1.0/outrider/trigger
GET  /api/v1.0/outrider/run-status?repo=owner/name
```

* `/installations`: one row per provisioned agent, including paused (revoked) ones.
* `/installations/<id>/revoke`: **pause an agent**: marks the installation revoked and revokes its agent key, so the next run fails auth immediately.
* `/agent-matrix`: the agent axis as capability data: every coding agent, the providers it can run against (already filtered to what this engine can provision), and the valid pairs. The same answer for every caller; what *you* have connected is `/integrations/providers`.
* `/trigger`: the API twin of `remyxai outrider trigger`: `{repo, pin_arxiv?, interest_id?, ref?, agent?, provider?, model?, start_from_ref?, lead_content?, test_integration_policy?, fidelity_policy?}`. `agent` is validated against `provider` before dispatch; an impossible pair is a `400`, and the credential the run is armed with follows the pair. Dispatches via the remyx-ai\[bot] App token; returns `409 {pool_building: true}` while a fresh interest's candidate pool is still building.
* `/run-status`: the latest run for a repo, live from GitHub (no webhook lag), enriched with its outcome kind and artifact URL.

> [!NOTE]
>
> Outcome tracking (merge or close of the artifacts a run opened) is **webhook-driven**: it flows back through the GitHub webhooks rather than being polled here.

***

## Implementation

Manage the experiment implementation pipeline: context assembly, implementation runs, and status tracking. Scope: `experiments:*`.

### Get Experiment Context

```
GET /api/v1.0/implement/experiments/<experiment_id>/context
```

Returns the full experiment context formatted for a coding agent: resource metadata, Docker environment, task description, and implementation plan.

### Get Reference Implementation

```
GET /api/v1.0/implement/experiments/<experiment_id>/reference
```

Returns reference implementation sources: GitHub repo, Docker image, key methods, and implementation plan extracted from the launch context.

### List Actionable Experiments

```
GET /api/v1.0/implement/experiments/actionable
```

| Parameter | Type | Description |
| - | - | - |
| `project_id` | string | Filter by project UUID |
| `limit` | integer | Max results |

Returns experiments that have a `launch_context` but no PR yet.

### Run Implementation

```
POST /api/v1.0/implement/experiments/<experiment_id>/run
```

Triggers the server-side implementation pipeline. Returns `202 Accepted` with a task reference.

### Get Implementation Status

```
GET /api/v1.0/implement/experiments/<experiment_id>/status
```

Returns the current pipeline status: `pipeline_status`, `pr_url`, `pr_status`, and timing information.

### Report Implementation Result

```
POST /api/v1.0/implement/experiments/<experiment_id>/report
```

| Field | Type | Description |
| - | - | - |
| `pr_url` | string | URL of the created PR |
| `branch_name` | string | Git branch name |
| `summary` | string | Implementation summary |
| `status` | string | Result status |
| `artifacts` | object | Additional artifact references |

The sandboxed coding-agent pipeline has its own endpoints under `/api/v1.0/pipeline/experiments/<id>/{run, context, progress, report}`; they are called by the pipeline container, not by clients.

***

## Workflows

Scheduled deliveries such as a daily digest to Slack. Scope: `workflows:read` / `workflows:write`.

```
GET    /api/v1.0/workflows
POST   /api/v1.0/workflows
GET    /api/v1.0/workflows/<workflow_id>
PATCH  /api/v1.0/workflows/<workflow_id>        # only the fields sent change; accepts `active`
DELETE /api/v1.0/workflows/<workflow_id>
POST   /api/v1.0/workflows/<workflow_id>/test   # deliver once, now
```

| Field | Type | Description |
| - | - | - |
| `workflow_type` | string | `digest` |
| `schedule_hour`, `schedule_minute` | integer | Local time of delivery |
| `schedule_days` | string | Comma-separated ISO weekdays, e.g. `1,2,3,4,5` |
| `schedule_timezone` | string | IANA zone, e.g. `America/Los_Angeles` |
| `interest_ids` | array | Interests to include |
| `limit_per_interest` | integer | Items per interest |
| `include_github` | boolean | Include GitHub repos alongside papers |
| `delivery_channel` | string | `slack` |
| `delivery_target` | string | Channel id |

***

## Eval Environments

Build and run containerized evaluation environments. Base path `/api/v1.0/eval-env`. Scope: `evals:read` / `evals:write`. This is the experiment-level evaluation path; PR validation has its own [Validate](https://docs.remyx.ai/platform/configure/account.md#validate) surface.

### Builds

```
POST /api/v1.0/eval-env/builds
GET  /api/v1.0/eval-env/builds/<build_id>
GET  /api/v1.0/eval-env/builds/<build_id>/context
POST /api/v1.0/eval-env/builds/<build_id>/progress
POST /api/v1.0/eval-env/builds/<build_id>/report
GET  /api/v1.0/eval-env/lookup
```

`POST /builds` starts a new environment build. `GET /builds/<id>` returns build status; `/context` returns the assembled build context; `/progress` and `/report` are called by the builder. `/lookup` finds an existing build for a repo and ref.

### Runs

```
GET  /api/v1.0/eval-env/runs
POST /api/v1.0/eval-env/runs
GET  /api/v1.0/eval-env/runs/<run_id>
POST /api/v1.0/eval-env/runs/<run_id>/cancel
```

List or create eval runs, fetch a single run, or cancel an in-flight run.

### Templates

```
POST /api/v1.0/eval-env/templates
GET  /api/v1.0/eval-env/templates
GET  /api/v1.0/eval-env/templates/<template_id>
PUT  /api/v1.0/eval-env/templates/<template_id>
POST /api/v1.0/eval-env/templates/<template_id>/lock
```

CRUD for reusable eval-environment templates. `POST /templates/<id>/lock` freezes a template so it can't be edited once it's in use.

### Runner webhooks

```
POST /api/v1.0/eval-env/webhooks/results
POST /api/v1.0/eval-env/webhooks/progress
POST /api/v1.0/eval-env/webhooks/artifact-url
```

Inbound calls from the runner, authenticated with the run's own HMAC secret rather than a key: `results` delivers scored results (idempotent per run, variant, seed, and nonce), `progress` is a heartbeat the engine relays to the PR comment and Check, and `artifact-url` hands the job a short-lived upload URL for one artifact.

***

## Other endpoints

Routes that exist but are either internal or rarely called directly:

| Route | Status |
| - | - |
| `GET /api/v1.0/user`, `GET /api/v1.0/user/credits` | Profile and balance summary (`account:read`); `GET /billing` is the fuller view |
| `GET /api/v1.0/evaluation/*` | Legacy evaluation downloads, `evals:*` |
| `/api/v1.0/webhooks/github/repo-events` | GitHub webhook receiver; internal |
| `/api/v1.0/pipeline/experiments/<id>/*` | Called by the implementation container; internal |
| `/api/v1.0/model/*`, `/datasets/*`, `/myxboard/*`, `/task/*`, `/deployment/*` | Deprecated model-hosting surface, reachable only with a full-access key |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.