Skip to content
IonWarpRouterTry for free
IonWarp Docs
Reference

Product operations

The exact operations served by this product and its model tools.

Create a project with POST /api/v1/projects. Include setup: true to run setup in the same call; the response includes setup.task with durable run and stream handles. Omit the flag for manual configuration.

The OpenAPI document and operation catalog come from the same declaration as these routes and tools.

Contract hash: 13e71da0eab71ea67e511af42d73c9cdd9bbafa8f35e825c7ffe9fb2d3aad6dc.

| HTTP | Action | Model tool |

| --- | --- | --- |

| GET /api/v1/checks/{id} | get Checks. The individual checks a scorecard scores. | checks_get |

| GET /api/v1/checks | list Checks. The individual checks a scorecard scores. | checks_list |

| POST /api/v1/dashboards | create Dashboards. Metric boards built from your repo's review history. | dashboards_create |

| GET /api/v1/dashboards/{id} | get Dashboards. Metric boards built from your repo's review history. | dashboards_get |

| GET /api/v1/dashboards | list Dashboards. Metric boards built from your repo's review history. | dashboards_list |

| PATCH /api/v1/dashboards/{id} | update Dashboards. Metric boards built from your repo's review history. | dashboards_update |

| GET /api/v1/findings/{id} | get Findings. Structured review findings — the durable ledger the website renders. | findings_get |

| GET /api/v1/findings | list Findings. Structured review findings — the durable ledger the website renders. | findings_list |

| POST /api/v1/learnings/{id}/events | Append an event to Learnings | learnings_append_event |

| GET /api/v1/learnings/{id}/events | Read events for Learnings | learnings_events |

| GET /api/v1/learnings/{id} | get Learnings. What IonWarp learned about this repo, with an expiry. | learnings_get |

| GET /api/v1/learnings | list Learnings. What IonWarp learned about this repo, with an expiry. | learnings_list |

| GET /api/v1/metric-records/{id} | get Metrics. Stored metric values — one row per (owner, key), newest write wins. | metric_records_get |

| GET /api/v1/metric-records | list Metrics. Stored metric values — one row per (owner, key), newest write wins. | metric_records_list |

| POST /api/v1/plans/{id}/events | Append an event to Plans | plans_append_event |

| GET /api/v1/plans/{id}/events | Read events for Plans | plans_events |

| GET /api/v1/plans/{id} | get Plans. Proposed work, scored and approved before anything is written. | plans_get |

| GET /api/v1/plans | list Plans. Proposed work, scored and approved before anything is written. | plans_list |

| GET /api/v1/preferences/{id} | get Preferences. Per-project dashboard state (notification read/cleared markers). | preferences_get |

| POST /api/v1/projects/{project_id}/setup | Set up the project with AI | projects_setup |

| GET /api/v1/projects/{project_id}/setup | Read setup evidence and missing requirements | projects_setup_status |

| POST /api/v1/pull-requests/{id}/events | Append an event to Pull Requests | pull_requests_append_event |

| GET /api/v1/pull-requests/{id}/events | Read events for Pull Requests | pull_requests_events |

| GET /api/v1/pull-requests/{id} | get Pull Requests. Pull requests IonWarp is watching, and where each one got to in review. | pull_requests_get |

| GET /api/v1/pull-requests | list Pull Requests. Pull requests IonWarp is watching, and where each one got to in review. | pull_requests_list |

| GET /api/v1/quick-actions/{id} | get Quick Actions. One-click next steps the scorecard suggests. | quick_actions_get |

| GET /api/v1/quick-actions | list Quick Actions. One-click next steps the scorecard suggests. | quick_actions_list |

| GET /api/v1/review-results/{id} | get Pull Requests. A single review pass over a pull request. | review_results_get |

| GET /api/v1/review-results | list Pull Requests. A single review pass over a pull request. | review_results_list |

| POST /api/v1/reviewers/{id}/events | Append an event to Reviewers | reviewers_append_event |

| POST /api/v1/reviewers | create Reviewers. The reviewers available to run on your repo. | reviewers_create |

| GET /api/v1/reviewers/{id}/events | Read events for Reviewers | reviewers_events |

| GET /api/v1/reviewers/{reviewer_id} | Read one reviewer and its pin | reviewers_get |

| GET /api/v1/reviewers | List reviewers, most popular first, with their governed model pin | reviewers_list |

| GET /api/v1/reviewers/{reviewer_id}/models | List the models measured for a reviewer, current pin flagged | reviewers_models |

| PATCH /api/v1/reviewers/{id} | update Reviewers. The reviewers available to run on your repo. | reviewers_update |

| POST /api/v1/reviews/{review_id}/reviewers | add reviewer a review configuration or attempt | reviews_add_reviewer |

| POST /api/v1/reviews | Create a review and start its run | reviews_create |

| DELETE /api/v1/reviews/{review_id}/reviewers/{reviewer_key} | delete reviewer a review configuration or attempt | reviews_delete_reviewer |

| GET /api/v1/reviews/{review_id} | Get a review with its latest run receipt and findings | reviews_get |

| GET /api/v1/reviews | list a review configuration or attempt | reviews_list |

| POST /api/v1/reviews/{review_id}/runs | run a review configuration or attempt | reviews_run |

| PATCH /api/v1/reviews/{review_id} | update a review configuration or attempt | reviews_update |

| PATCH /api/v1/reviews/{review_id}/reviewers/{reviewer_key} | update reviewer a review configuration or attempt | reviews_update_reviewer |

| GET /api/v1/scorecard-levels/{id} | get Scorecard Levels. The ladder a repo climbs, level by level. | scorecard_levels_get |

| GET /api/v1/scorecard-levels | list Scorecard Levels. The ladder a repo climbs, level by level. | scorecard_levels_list |

| POST /api/v1/scorecards/{id}/events | Append an event to Scorecards | scorecards_append_event |

| GET /api/v1/scorecards/{id}/events | Read events for Scorecards | scorecards_events |

| GET /api/v1/scorecards/{id} | get Scorecards. Your repo's readiness score and how it was earned. | scorecards_get |

| GET /api/v1/scorecards | list Scorecards. Your repo's readiness score and how it was earned. | scorecards_list |

| POST /api/v1/skill-imports | Import an immutable skill revision | skills_import |

| GET /api/v1/skill-revisions/{revision_id} | Read and verify an immutable skill revision | skills_revision |

| GET /api/v1/swarms/{id} | get Review Swarms. Multi-agent runs coordinated toward one goal. | swarms_get |

| GET /api/v1/swarms | list Review Swarms. Multi-agent runs coordinated toward one goal. | swarms_list |

| POST /api/v1/tasks/{task_id}/cancel | Cancel a task's active run | tasks_cancel |

| GET /api/v1/tasks/{task_id} | Read a task with its latest run receipt | tasks_get |

| GET /api/v1/tasks/{task_id}/runs | List a task's run receipts | tasks_runs |

| GET /api/v1/timeline-events/{id} | get Timeline Events. The append-only record of what happened to an object. | timeline_events_get |

| GET /api/v1/timeline-events | list Timeline Events. The append-only record of what happened to an object. | timeline_events_list |

Write retries use Idempotency-Key. Changing input under the same key returns 409. An unfinished acknowledgement remains a named operation_in_progress conflict; never retry it under a new key without inspecting the resource.

Review configuration edits require If-Match with the current quoted revision. A run executes its saved revision; subsequent edits change the next attempt.

On this page

No Headings
IonWarp logoIonWarp

Ready to build? Connect an agent and go — no credit card needed to start.

Get startedSee our plans