Skip to navigation
API ReferenceAgent Documents

Dismiss Suggestion

View as Markdown

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

suggestion_idstringRequired
project_idstringRequired
agent_slugstringRequired

Response

Successful Response
actorstring
baseLiveVersionIdstring
candidateVersionIdstring
contentOriginstring
createdAtstring
documentstring
idstring
statusstring
affectedRunsinteger or nullOptional
This agent's runs that showed the issue.
affectedSharedouble or nullOptional0-1

Share of runs affected; omitted when unknown.

citedRunIdslist of strings or nullOptional
Visible project runs that show the problem.
diffstring or nullOptional
rationalestring or nullOptional
Why it was suggested, in at most 280 characters.
signalIdstring or nullOptional
The linked issue, when the change came from one.
titlestring or nullOptional
The change this suggestion came from, when it has one.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error