Reviews
Reviews endpoints of the Ellipsis REST API.
| Method | Path | Required permissions |
|---|---|---|
| POST | /v1/reviews | write:reviews |
- API key
- Supported.
- CLI user token
- Supported.
- Sandbox token
- Requires the ellipsis:api scope and the required grants in the token's permissions.ellipsis configuration.
Higher permission levels include lower levels: read < write < delete.
Set post to false to inspect findings without posting to GitHub.
curl -X POST "https://api.ellipsis.dev/v1/reviews" \
-H "Authorization: Bearer $ELLIPSIS_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"owner": "your-org",
"repo": "api-repo",
"pull_request_number": 42,
"post": false
}'import os
from ellipsis import Ellipsis
from ellipsis import models
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
request = models.CreateReviewRequest.model_validate(
{
"owner": "your-org",
"repo": "api-repo",
"pull_request_number": 42,
"post": False
}
)
result = client.reviews.create(
request.owner,
request.pull_request_number,
request.repo,
post=request.post,
)
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const request: Parameters<typeof client.reviews.create>[0] = {
"owner": "your-org",
"repo": "api-repo",
"pull_request_number": 42,
"post": false
};
const result = await client.reviews.create(request);
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.
Response
| Method | Path | Required permissions |
|---|---|---|
| GET | /v1/reviews | read:reviews |
- API key
- Supported.
- CLI user token
- Supported.
- Sandbox token
- Requires the ellipsis:api scope and the required grants in the token's permissions.ellipsis configuration.
Higher permission levels include lower levels: read < write < delete.
Query parameters
[]array<string>Only reviews on these repositories, each as owner/name. Repeat the parameter for several.
[]array<integer>Only reviews on these pull request numbers. Repeat the parameter for several.
[]array<CodeReviewRunStatus>Only reviews in these statuses. Repeat the parameter for several.
Only reviews created at or after this time.
Only reviews created at or before this time.
50integercurl "https://api.ellipsis.dev/v1/reviews" \
-H "Authorization: Bearer $ELLIPSIS_API_TOKEN"import os
from ellipsis import Ellipsis
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
for item in client.reviews.list():
print(item)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
for await (const item of await client.reviews.list()) {
console.log(item);
}Request
Response
| Method | Path | Required permissions |
|---|---|---|
| GET | /v1/reviews/{review_id} | read:reviews |
- API key
- Supported.
- CLI user token
- Supported.
- Sandbox token
- Requires the ellipsis:api scope and the required grants in the token's permissions.ellipsis configuration.
Higher permission levels include lower levels: read < write < delete.
Path parameters
curl "https://api.ellipsis.dev/v1/reviews/{review_id}" \
-H "Authorization: Bearer $ELLIPSIS_API_TOKEN"import os
from ellipsis import Ellipsis
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
result = client.reviews.get("review_example")
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const result = await client.reviews.get("review_example");
console.log(result);Request
Response
| Method | Path | Required permissions |
|---|---|---|
| GET | /v1/reviews/configs | read:reviews |
- API key
- Supported.
- CLI user token
- Supported.
- Sandbox token
- Requires the ellipsis:api scope and the required grants in the token's permissions.ellipsis configuration.
Higher permission levels include lower levels: read < write < delete.
curl "https://api.ellipsis.dev/v1/reviews/configs" \
-H "Authorization: Bearer $ELLIPSIS_API_TOKEN"import os
from ellipsis import Ellipsis
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
result = client.reviews.configs()
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const result = await client.reviews.configs();
console.log(result);