Skip to main content
GET
/
context-documents
/
reviews
/
{review_id}
Get a review with its suggestions
curl --request GET \
  --url https://api.hyperspell.com/context-documents/reviews/{review_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "canonical_title": "<string>",
  "status": "<string>",
  "model": "<string>",
  "error": "<string>",
  "suggestion_count": 123,
  "evidence_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "suggestions": [
    {
      "id": 123,
      "review_id": 123,
      "kind": "<string>",
      "original_excerpt": "<string>",
      "replacement_excerpt": "<string>",
      "proposed_change": "<string>",
      "rationale": "<string>",
      "sources": [
        {
          "type": "<string>",
          "title": "<string>",
          "url": "<string>",
          "chunk_id": "<string>",
          "excerpt": ""
        }
      ],
      "confidence": "<string>",
      "status": "<string>",
      "applied": true,
      "decided_by": "<string>",
      "decided_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Path Parameters

review_id
integer
required

Response

Successful Response

id
integer
required
canonical_title
string
required
status
string
required
model
string
required
error
string | null
required
suggestion_count
integer
required
evidence_count
integer
required
created_at
string<date-time>
required
completed_at
string<date-time> | null
required
suggestions
SuggestionResponse · object[]