GET
/
v1
/
ai-reviews
/
{reviewId}
Fetch one AI review
curl --request GET \
  --url https://api.next.orenda.finance/v1/ai-reviews/{reviewId} \
  --header 'Authorization: Bearer <token>'
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.next.orenda.finance/v1/ai-reviews/{reviewId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
import requests

url = "https://api.next.orenda.finance/v1/ai-reviews/{reviewId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
{
  "success": true,
  "data": {
    "reviewId": "<string>",
    "targetId": "<string>",
    "schemaId": "<string>",
    "schemaVersion": 123,
    "report": {
      "schemaVersion": 1,
      "subject": "<string>",
      "summary": "<string>",
      "checks": [
        {
          "ruleId": "<string>",
          "label": "<string>",
          "detail": "<string>",
          "section": "<string>"
        }
      ],
      "followUpActions": [
        "<string>"
      ]
    },
    "documents": [
      {
        "key": "<string>",
        "pages": 123,
        "lastModified": "2023-11-07T05:31:56Z"
      }
    ],
    "reviewedAt": "2023-11-07T05:31:56Z",
    "error": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
{
"success": false,
"code": "<string>",
"message": "<string>"
}
{
"success": false,
"code": "<string>",
"message": "<string>"
}
{
"success": false,
"code": "<string>",
"message": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

reviewId
string
required

Query Parameters

programId
string
required

Program to operate on. Back-office convention — a BO token is not scoped to one program.

sandbox
enum<string>
default:false

Environment selector; defaults to production (false).

Available options:
true,
false

Response

The review.

success
boolean
Example:

true

data
object

Client-safe projection of a review. Omits internal telemetry (token usage, cost, model id, fingerprint).