POST /reviews
Run a code review on demand.
| Method | Path |
|---|---|
| POST | /v1/reviews |
Reviews an open pull request. Which pipeline runs is not a parameter: it resolves from the repository's files exactly as it does for a push, so an on-demand review never disagrees with the automatic one. A review is one pipeline run over one commit range, with one agent session per stage: `review.id` is the run id, and `stages[].session_id` is where a client streams (/sessions/{id}/stream on a stage session), since the review itself is a pipeline rather than one process.
curl -X POST "https://api.ellipsis.dev/v1/reviews" \
-H "Authorization: Bearer $ELLIPSIS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"owner": "...",
"pull_request_number": 0,
"repo": "..."
}'import os
from ellipsis import Ellipsis
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
result = client.reviews.create("...", 0, "...")
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const result = await client.reviews.create(
{ owner: '...', pull_request_number: 0, repo: '...' },
);
console.log(result);Request
Body parameters
The repository owner's login.
truebooleanWhether the review is posted to GitHub. Setting this false keeps the review API-only; it cannot force posting where posting is otherwise disabled.
The pull request to review.
The repository name, without the owner.
What range to review. Defaults to an incremental review of everything since the last review.