Endpoints

In development

The full catalogue, grouped by what each part of the platform does. Every route here is designed and none is live — the shape is published early so it can be argued with before it is fixed.

Executions

3 routes

Start an analysis and read what it found.

POST/v1/executionsPlanned
Run an analysis against a subject.
Authentication: API key
example responseillustrative
```
{
  "id": "exe_…",
  "status": "running",
  "target": "token",
  "created_at": "…"
}
```
GET/v1/executionsPlanned
List your executions, newest first.
Authentication: API key

GET/v1/executions/{id}Planned

One execution with its evidence and sources.

Authentication: API key

example responseillustrative

{
  "id": "exe_…",
  "status": "succeeded",
  "evidence": [
    {
      "label": "Contract source verified",
      "state": "unknown",
      "reason": "The explorer has no source for this address."
    }
  ]
}

Research

3 routes

Gather and cite sources on a topic.

POST/v1/researchPlanned
Collect ranked sources with citations.
Authentication: API key
POST/v1/website-auditPlanned
Map a site, read what matters, and report on it.
Authentication: API key
POST/v1/repository-analysisPlanned
Read a repository and what is written about it.
Authentication: API key

Reports

2 routes

An execution rendered, and the files it produces.

POST/v1/reportsPlanned
Build a report from one or more executions.
Authentication: API key
GET/v1/reports/{id}Planned
Sections, findings, confidence, and sources.
Authentication: API key

Artifacts

2 routes

Downloadable output: markdown, CSV, charts, bundles.

GET/v1/artifacts/{id}Planned
One artifact, with its own media type.
Authentication: API key
GET/v1/executions/{id}/artifactsPlanned
Every file an execution produced.
Authentication: API key

Projects

1 route

Subjects grouped by what they are.

GET/v1/projectsPlanned
Everything you have analysed, grouped.
Authentication: API key

Providers

1 route

What the platform can currently do.

GET/v1/providersPlanned
Capabilities available on this deployment.
Authentication: None