Skip to main content
GET
/
v1
/
reviews
/
{review_id}
Get review status and results
curl --request GET \
  --url https://api.propelcode.ai/v1/reviews/{review_id} \
  --header 'Authorization: Bearer <token>'
{
  "review_id": "<string>",
  "status": "queued",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "repository": "<string>",
  "base_commit": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "comments": [
    {
      "file_path": "<string>",
      "line": 123,
      "message": "<string>",
      "severity": "<string>"
    }
  ],
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.propelcode.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Review API token created through /v1/auth/tokens.

Path Parameters

​
review_id
string
required

Review ID returned by POST /v1/reviews.

Response

Review status and comments.

​
review_id
string
required
​
status
enum<string>
required
Available options:
queued,
running,
completed,
failed
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
repository
string
​
base_commit
string
​
started_at
string<date-time>
​
completed_at
string<date-time>
​
comments
object[]
​
error
object