Skip to main content
POST
/
context-documents
/
reviews
/
{review_id}
/
suggestions
/
{suggestion_id}
/
decide
Accept or dismiss a suggestion
curl --request POST \
  --url https://api.hyperspell.com/context-documents/reviews/{review_id}/suggestions/{suggestion_id}/decide \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "<string>"
}
'
{
  "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
suggestion_id
integer
required

Body

application/json
action
string
required

'accept' or 'dismiss'

Response

Successful Response

id
integer
required
review_id
integer
required
kind
string
required
original_excerpt
string
required
replacement_excerpt
string
required
proposed_change
string
required
rationale
string
required
sources
SuggestionSource · object[]
required
confidence
string
required
status
string
required
applied
boolean
required
decided_by
string | null
required
decided_at
string<date-time> | null
required
created_at
string<date-time>
required