Review content and return inspector results and aggregated summaries
curl --request POST \
--url https://api.example.com/api/v1/inspector/review \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document": {
"schema_version": 1,
"pages": [
{
"id": "<string>",
"number": 2,
"grounding_metadata": {
"coordinate_space": {
"unit": "pixel",
"origin": "top_left",
"width": 2,
"height": 2
},
"units": {},
"panels": {}
},
"width": 2,
"height": 2,
"blocks": [
{
"id": "<string>",
"label": "<string>",
"lang": "<string>",
"bbox": {
"[0]": 123,
"[1]": 123,
"[2]": 123,
"[3]": 123
},
"source_unit_ids": [
"<string>"
],
"elements": [
{
"text": "<string>",
"type": "paragraph"
}
]
}
],
"panels": [
{
"id": "<string>",
"label": "<string>",
"bbox": {
"[0]": 123,
"[1]": 123,
"[2]": 123,
"[3]": 123
},
"blocks": [
{
"id": "<string>",
"label": "<string>",
"lang": "<string>",
"bbox": {
"[0]": 123,
"[1]": 123,
"[2]": 123,
"[3]": 123
},
"source_unit_ids": [
"<string>"
],
"elements": [
{
"text": "<string>",
"type": "paragraph"
}
]
}
],
"skipped_source_unit_ids": [
"<string>"
]
}
]
}
]
},
"document_context": "<unknown>",
"objects": [
{
"content": "<string>",
"type": "image",
"ctx": null
}
],
"ctx": {
"operation": "question_about_existing_finding",
"user_message": "<string>",
"history": [
{
"text": "<string>",
"blocks": [
{
"props": {
"items": [
{
"claim": "<string>",
"detail": "<string>",
"source": "<string>"
}
]
},
"type": "evidence",
"sources": [
"<string>"
]
}
]
}
],
"document_version": 2,
"review_revision": "<string>",
"finding": {
"id": "<string>",
"content": {
"text": "<string>",
"metadata": {}
},
"description": "<string>",
"why_summary_matters": "<string>",
"action_description": "<string>",
"suggested_text": "<string>",
"grounding": [
{
"url": "<string>",
"block_id": "<string>",
"block_name": "<string>",
"group": "<string>"
}
],
"status": "active",
"user_feedback": "<string>",
"previous_summaries": [
{
"summary_id": "<string>",
"version": "<string>"
}
],
"violation_ids": [
"<string>"
]
},
"sources": [
{
"inspector": {
"id": 123,
"name": "<string>",
"type": "<string>",
"short_name": "<string>",
"description": "",
"short_description": "<string>",
"imageUrl": "<string>",
"is_shared": false,
"requested_context": "all_data"
},
"violation": {
"id": "<string>",
"content": {
"text": "<string>",
"metadata": {}
},
"issues": [
{
"rule": {
"name": "<string>",
"text": "<string>",
"rule_id": 123,
"ctx": {}
},
"explanation": "<string>",
"insight": "<string>"
}
],
"violation_summary": "<string>",
"insight_summary": "<string>",
"correction": "<string>",
"violation_type": "fix",
"block_id": "<string>",
"location": "<string>",
"evidence": "<string>"
}
}
]
},
"context_selection": "requested",
"inspector_ids": [
123
],
"include_recommendations": false,
"organization_id": 123,
"countries": [
"<string>"
],
"brand_id": 123,
"product_name": "<string>",
"use_case": "<string>",
"max_recommendations": 10,
"doc_context": "<string>",
"insights_locale": "<string>",
"previous_inspections": [
{
"inspector": {
"id": 123,
"name": "<string>",
"type": "<string>",
"short_name": "<string>",
"description": "",
"short_description": "<string>",
"imageUrl": "<string>",
"is_shared": false,
"requested_context": "all_data"
},
"violation": {
"id": "<string>",
"content": {
"text": "<string>",
"metadata": {}
},
"issues": [
{
"rule": {
"name": "<string>",
"text": "<string>",
"rule_id": 123,
"ctx": {}
},
"explanation": "<string>",
"insight": "<string>"
}
],
"violation_summary": "<string>",
"insight_summary": "<string>",
"correction": "<string>",
"violation_type": "fix",
"block_id": "<string>",
"location": "<string>",
"evidence": "<string>",
"status": "active",
"user_feedback": "<string>"
},
"source_summary": {
"summary_id": "<string>",
"version": "<string>",
"description": "<string>",
"why_summary_matters": "<string>",
"action_description": "<string>",
"suggested_text": "<string>",
"previous_summaries": [
{
"summary_id": "<string>",
"version": "<string>"
}
]
}
}
],
"session_context": [
{
"question": "<string>",
"answer": "<string>"
}
]
}
'import requests
url = "https://api.example.com/api/v1/inspector/review"
payload = {
"document": {
"schema_version": 1,
"pages": [
{
"id": "<string>",
"number": 2,
"grounding_metadata": {
"coordinate_space": {
"unit": "pixel",
"origin": "top_left",
"width": 2,
"height": 2
},
"units": {},
"panels": {}
},
"width": 2,
"height": 2,
"blocks": [
{
"id": "<string>",
"label": "<string>",
"lang": "<string>",
"bbox": {
"[0]": 123,
"[1]": 123,
"[2]": 123,
"[3]": 123
},
"source_unit_ids": ["<string>"],
"elements": [
{
"text": "<string>",
"type": "paragraph"
}
]
}
],
"panels": [
{
"id": "<string>",
"label": "<string>",
"bbox": {
"[0]": 123,
"[1]": 123,
"[2]": 123,
"[3]": 123
},
"blocks": [
{
"id": "<string>",
"label": "<string>",
"lang": "<string>",
"bbox": {
"[0]": 123,
"[1]": 123,
"[2]": 123,
"[3]": 123
},
"source_unit_ids": ["<string>"],
"elements": [
{
"text": "<string>",
"type": "paragraph"
}
]
}
],
"skipped_source_unit_ids": ["<string>"]
}
]
}
]
},
"document_context": "<unknown>",
"objects": [
{
"content": "<string>",
"type": "image",
"ctx": None
}
],
"ctx": {
"operation": "question_about_existing_finding",
"user_message": "<string>",
"history": [
{
"text": "<string>",
"blocks": [
{
"props": { "items": [
{
"claim": "<string>",
"detail": "<string>",
"source": "<string>"
}
] },
"type": "evidence",
"sources": ["<string>"]
}
]
}
],
"document_version": 2,
"review_revision": "<string>",
"finding": {
"id": "<string>",
"content": {
"text": "<string>",
"metadata": {}
},
"description": "<string>",
"why_summary_matters": "<string>",
"action_description": "<string>",
"suggested_text": "<string>",
"grounding": [
{
"url": "<string>",
"block_id": "<string>",
"block_name": "<string>",
"group": "<string>"
}
],
"status": "active",
"user_feedback": "<string>",
"previous_summaries": [
{
"summary_id": "<string>",
"version": "<string>"
}
],
"violation_ids": ["<string>"]
},
"sources": [
{
"inspector": {
"id": 123,
"name": "<string>",
"type": "<string>",
"short_name": "<string>",
"description": "",
"short_description": "<string>",
"imageUrl": "<string>",
"is_shared": False,
"requested_context": "all_data"
},
"violation": {
"id": "<string>",
"content": {
"text": "<string>",
"metadata": {}
},
"issues": [
{
"rule": {
"name": "<string>",
"text": "<string>",
"rule_id": 123,
"ctx": {}
},
"explanation": "<string>",
"insight": "<string>"
}
],
"violation_summary": "<string>",
"insight_summary": "<string>",
"correction": "<string>",
"violation_type": "fix",
"block_id": "<string>",
"location": "<string>",
"evidence": "<string>"
}
}
]
},
"context_selection": "requested",
"inspector_ids": [123],
"include_recommendations": False,
"organization_id": 123,
"countries": ["<string>"],
"brand_id": 123,
"product_name": "<string>",
"use_case": "<string>",
"max_recommendations": 10,
"doc_context": "<string>",
"insights_locale": "<string>",
"previous_inspections": [
{
"inspector": {
"id": 123,
"name": "<string>",
"type": "<string>",
"short_name": "<string>",
"description": "",
"short_description": "<string>",
"imageUrl": "<string>",
"is_shared": False,
"requested_context": "all_data"
},
"violation": {
"id": "<string>",
"content": {
"text": "<string>",
"metadata": {}
},
"issues": [
{
"rule": {
"name": "<string>",
"text": "<string>",
"rule_id": 123,
"ctx": {}
},
"explanation": "<string>",
"insight": "<string>"
}
],
"violation_summary": "<string>",
"insight_summary": "<string>",
"correction": "<string>",
"violation_type": "fix",
"block_id": "<string>",
"location": "<string>",
"evidence": "<string>",
"status": "active",
"user_feedback": "<string>"
},
"source_summary": {
"summary_id": "<string>",
"version": "<string>",
"description": "<string>",
"why_summary_matters": "<string>",
"action_description": "<string>",
"suggested_text": "<string>",
"previous_summaries": [
{
"summary_id": "<string>",
"version": "<string>"
}
]
}
}
],
"session_context": [
{
"question": "<string>",
"answer": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
document: {
schema_version: 1,
pages: [
{
id: '<string>',
number: 2,
grounding_metadata: {
coordinate_space: {unit: 'pixel', origin: 'top_left', width: 2, height: 2},
units: {},
panels: {}
},
width: 2,
height: 2,
blocks: [
{
id: '<string>',
label: '<string>',
lang: '<string>',
bbox: {'[0]': 123, '[1]': 123, '[2]': 123, '[3]': 123},
source_unit_ids: ['<string>'],
elements: [{text: '<string>', type: 'paragraph'}]
}
],
panels: [
{
id: '<string>',
label: '<string>',
bbox: {'[0]': 123, '[1]': 123, '[2]': 123, '[3]': 123},
blocks: [
{
id: '<string>',
label: '<string>',
lang: '<string>',
bbox: {'[0]': 123, '[1]': 123, '[2]': 123, '[3]': 123},
source_unit_ids: ['<string>'],
elements: [{text: '<string>', type: 'paragraph'}]
}
],
skipped_source_unit_ids: ['<string>']
}
]
}
]
},
document_context: '<unknown>',
objects: [{content: '<string>', type: 'image', ctx: null}],
ctx: {
operation: 'question_about_existing_finding',
user_message: '<string>',
history: [
{
text: '<string>',
blocks: [
{
props: {items: [{claim: '<string>', detail: '<string>', source: '<string>'}]},
type: 'evidence',
sources: ['<string>']
}
]
}
],
document_version: 2,
review_revision: '<string>',
finding: {
id: '<string>',
content: {text: '<string>', metadata: {}},
description: '<string>',
why_summary_matters: '<string>',
action_description: '<string>',
suggested_text: '<string>',
grounding: [
{
url: '<string>',
block_id: '<string>',
block_name: '<string>',
group: '<string>'
}
],
status: 'active',
user_feedback: '<string>',
previous_summaries: [{summary_id: '<string>', version: '<string>'}],
violation_ids: ['<string>']
},
sources: [
{
inspector: {
id: 123,
name: '<string>',
type: '<string>',
short_name: '<string>',
description: '',
short_description: '<string>',
imageUrl: '<string>',
is_shared: false,
requested_context: 'all_data'
},
violation: {
id: '<string>',
content: {text: '<string>', metadata: {}},
issues: [
{
rule: {name: '<string>', text: '<string>', rule_id: 123, ctx: {}},
explanation: '<string>',
insight: '<string>'
}
],
violation_summary: '<string>',
insight_summary: '<string>',
correction: '<string>',
violation_type: 'fix',
block_id: '<string>',
location: '<string>',
evidence: '<string>'
}
}
]
},
context_selection: 'requested',
inspector_ids: [123],
include_recommendations: false,
organization_id: 123,
countries: ['<string>'],
brand_id: 123,
product_name: '<string>',
use_case: '<string>',
max_recommendations: 10,
doc_context: '<string>',
insights_locale: '<string>',
previous_inspections: [
{
inspector: {
id: 123,
name: '<string>',
type: '<string>',
short_name: '<string>',
description: '',
short_description: '<string>',
imageUrl: '<string>',
is_shared: false,
requested_context: 'all_data'
},
violation: {
id: '<string>',
content: {text: '<string>', metadata: {}},
issues: [
{
rule: {name: '<string>', text: '<string>', rule_id: 123, ctx: {}},
explanation: '<string>',
insight: '<string>'
}
],
violation_summary: '<string>',
insight_summary: '<string>',
correction: '<string>',
violation_type: 'fix',
block_id: '<string>',
location: '<string>',
evidence: '<string>',
status: 'active',
user_feedback: '<string>'
},
source_summary: {
summary_id: '<string>',
version: '<string>',
description: '<string>',
why_summary_matters: '<string>',
action_description: '<string>',
suggested_text: '<string>',
previous_summaries: [{summary_id: '<string>', version: '<string>'}]
}
}
],
session_context: [{question: '<string>', answer: '<string>'}]
})
};
fetch('https://api.example.com/api/v1/inspector/review', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/inspector/review",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document' => [
'schema_version' => 1,
'pages' => [
[
'id' => '<string>',
'number' => 2,
'grounding_metadata' => [
'coordinate_space' => [
'unit' => 'pixel',
'origin' => 'top_left',
'width' => 2,
'height' => 2
],
'units' => [
],
'panels' => [
]
],
'width' => 2,
'height' => 2,
'blocks' => [
[
'id' => '<string>',
'label' => '<string>',
'lang' => '<string>',
'bbox' => [
'[0]' => 123,
'[1]' => 123,
'[2]' => 123,
'[3]' => 123
],
'source_unit_ids' => [
'<string>'
],
'elements' => [
[
'text' => '<string>',
'type' => 'paragraph'
]
]
]
],
'panels' => [
[
'id' => '<string>',
'label' => '<string>',
'bbox' => [
'[0]' => 123,
'[1]' => 123,
'[2]' => 123,
'[3]' => 123
],
'blocks' => [
[
'id' => '<string>',
'label' => '<string>',
'lang' => '<string>',
'bbox' => [
'[0]' => 123,
'[1]' => 123,
'[2]' => 123,
'[3]' => 123
],
'source_unit_ids' => [
'<string>'
],
'elements' => [
[
'text' => '<string>',
'type' => 'paragraph'
]
]
]
],
'skipped_source_unit_ids' => [
'<string>'
]
]
]
]
]
],
'document_context' => '<unknown>',
'objects' => [
[
'content' => '<string>',
'type' => 'image',
'ctx' => null
]
],
'ctx' => [
'operation' => 'question_about_existing_finding',
'user_message' => '<string>',
'history' => [
[
'text' => '<string>',
'blocks' => [
[
'props' => [
'items' => [
[
'claim' => '<string>',
'detail' => '<string>',
'source' => '<string>'
]
]
],
'type' => 'evidence',
'sources' => [
'<string>'
]
]
]
]
],
'document_version' => 2,
'review_revision' => '<string>',
'finding' => [
'id' => '<string>',
'content' => [
'text' => '<string>',
'metadata' => [
]
],
'description' => '<string>',
'why_summary_matters' => '<string>',
'action_description' => '<string>',
'suggested_text' => '<string>',
'grounding' => [
[
'url' => '<string>',
'block_id' => '<string>',
'block_name' => '<string>',
'group' => '<string>'
]
],
'status' => 'active',
'user_feedback' => '<string>',
'previous_summaries' => [
[
'summary_id' => '<string>',
'version' => '<string>'
]
],
'violation_ids' => [
'<string>'
]
],
'sources' => [
[
'inspector' => [
'id' => 123,
'name' => '<string>',
'type' => '<string>',
'short_name' => '<string>',
'description' => '',
'short_description' => '<string>',
'imageUrl' => '<string>',
'is_shared' => false,
'requested_context' => 'all_data'
],
'violation' => [
'id' => '<string>',
'content' => [
'text' => '<string>',
'metadata' => [
]
],
'issues' => [
[
'rule' => [
'name' => '<string>',
'text' => '<string>',
'rule_id' => 123,
'ctx' => [
]
],
'explanation' => '<string>',
'insight' => '<string>'
]
],
'violation_summary' => '<string>',
'insight_summary' => '<string>',
'correction' => '<string>',
'violation_type' => 'fix',
'block_id' => '<string>',
'location' => '<string>',
'evidence' => '<string>'
]
]
]
],
'context_selection' => 'requested',
'inspector_ids' => [
123
],
'include_recommendations' => false,
'organization_id' => 123,
'countries' => [
'<string>'
],
'brand_id' => 123,
'product_name' => '<string>',
'use_case' => '<string>',
'max_recommendations' => 10,
'doc_context' => '<string>',
'insights_locale' => '<string>',
'previous_inspections' => [
[
'inspector' => [
'id' => 123,
'name' => '<string>',
'type' => '<string>',
'short_name' => '<string>',
'description' => '',
'short_description' => '<string>',
'imageUrl' => '<string>',
'is_shared' => false,
'requested_context' => 'all_data'
],
'violation' => [
'id' => '<string>',
'content' => [
'text' => '<string>',
'metadata' => [
]
],
'issues' => [
[
'rule' => [
'name' => '<string>',
'text' => '<string>',
'rule_id' => 123,
'ctx' => [
]
],
'explanation' => '<string>',
'insight' => '<string>'
]
],
'violation_summary' => '<string>',
'insight_summary' => '<string>',
'correction' => '<string>',
'violation_type' => 'fix',
'block_id' => '<string>',
'location' => '<string>',
'evidence' => '<string>',
'status' => 'active',
'user_feedback' => '<string>'
],
'source_summary' => [
'summary_id' => '<string>',
'version' => '<string>',
'description' => '<string>',
'why_summary_matters' => '<string>',
'action_description' => '<string>',
'suggested_text' => '<string>',
'previous_summaries' => [
[
'summary_id' => '<string>',
'version' => '<string>'
]
]
]
]
],
'session_context' => [
[
'question' => '<string>',
'answer' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/inspector/review"
payload := strings.NewReader("{\n \"document\": {\n \"schema_version\": 1,\n \"pages\": [\n {\n \"id\": \"<string>\",\n \"number\": 2,\n \"grounding_metadata\": {\n \"coordinate_space\": {\n \"unit\": \"pixel\",\n \"origin\": \"top_left\",\n \"width\": 2,\n \"height\": 2\n },\n \"units\": {},\n \"panels\": {}\n },\n \"width\": 2,\n \"height\": 2,\n \"blocks\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"lang\": \"<string>\",\n \"bbox\": {\n \"[0]\": 123,\n \"[1]\": 123,\n \"[2]\": 123,\n \"[3]\": 123\n },\n \"source_unit_ids\": [\n \"<string>\"\n ],\n \"elements\": [\n {\n \"text\": \"<string>\",\n \"type\": \"paragraph\"\n }\n ]\n }\n ],\n \"panels\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"bbox\": {\n \"[0]\": 123,\n \"[1]\": 123,\n \"[2]\": 123,\n \"[3]\": 123\n },\n \"blocks\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"lang\": \"<string>\",\n \"bbox\": {\n \"[0]\": 123,\n \"[1]\": 123,\n \"[2]\": 123,\n \"[3]\": 123\n },\n \"source_unit_ids\": [\n \"<string>\"\n ],\n \"elements\": [\n {\n \"text\": \"<string>\",\n \"type\": \"paragraph\"\n }\n ]\n }\n ],\n \"skipped_source_unit_ids\": [\n \"<string>\"\n ]\n }\n ]\n }\n ]\n },\n \"document_context\": \"<unknown>\",\n \"objects\": [\n {\n \"content\": \"<string>\",\n \"type\": \"image\",\n \"ctx\": null\n }\n ],\n \"ctx\": {\n \"operation\": \"question_about_existing_finding\",\n \"user_message\": \"<string>\",\n \"history\": [\n {\n \"text\": \"<string>\",\n \"blocks\": [\n {\n \"props\": {\n \"items\": [\n {\n \"claim\": \"<string>\",\n \"detail\": \"<string>\",\n \"source\": \"<string>\"\n }\n ]\n },\n \"type\": \"evidence\",\n \"sources\": [\n \"<string>\"\n ]\n }\n ]\n }\n ],\n \"document_version\": 2,\n \"review_revision\": \"<string>\",\n \"finding\": {\n \"id\": \"<string>\",\n \"content\": {\n \"text\": \"<string>\",\n \"metadata\": {}\n },\n \"description\": \"<string>\",\n \"why_summary_matters\": \"<string>\",\n \"action_description\": \"<string>\",\n \"suggested_text\": \"<string>\",\n \"grounding\": [\n {\n \"url\": \"<string>\",\n \"block_id\": \"<string>\",\n \"block_name\": \"<string>\",\n \"group\": \"<string>\"\n }\n ],\n \"status\": \"active\",\n \"user_feedback\": \"<string>\",\n \"previous_summaries\": [\n {\n \"summary_id\": \"<string>\",\n \"version\": \"<string>\"\n }\n ],\n \"violation_ids\": [\n \"<string>\"\n ]\n },\n \"sources\": [\n {\n \"inspector\": {\n \"id\": 123,\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"short_name\": \"<string>\",\n \"description\": \"\",\n \"short_description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"is_shared\": false,\n \"requested_context\": \"all_data\"\n },\n \"violation\": {\n \"id\": \"<string>\",\n \"content\": {\n \"text\": \"<string>\",\n \"metadata\": {}\n },\n \"issues\": [\n {\n \"rule\": {\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"rule_id\": 123,\n \"ctx\": {}\n },\n \"explanation\": \"<string>\",\n \"insight\": \"<string>\"\n }\n ],\n \"violation_summary\": \"<string>\",\n \"insight_summary\": \"<string>\",\n \"correction\": \"<string>\",\n \"violation_type\": \"fix\",\n \"block_id\": \"<string>\",\n \"location\": \"<string>\",\n \"evidence\": \"<string>\"\n }\n }\n ]\n },\n \"context_selection\": \"requested\",\n \"inspector_ids\": [\n 123\n ],\n \"include_recommendations\": false,\n \"organization_id\": 123,\n \"countries\": [\n \"<string>\"\n ],\n \"brand_id\": 123,\n \"product_name\": \"<string>\",\n \"use_case\": \"<string>\",\n \"max_recommendations\": 10,\n \"doc_context\": \"<string>\",\n \"insights_locale\": \"<string>\",\n \"previous_inspections\": [\n {\n \"inspector\": {\n \"id\": 123,\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"short_name\": \"<string>\",\n \"description\": \"\",\n \"short_description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"is_shared\": false,\n \"requested_context\": \"all_data\"\n },\n \"violation\": {\n \"id\": \"<string>\",\n \"content\": {\n \"text\": \"<string>\",\n \"metadata\": {}\n },\n \"issues\": [\n {\n \"rule\": {\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"rule_id\": 123,\n \"ctx\": {}\n },\n \"explanation\": \"<string>\",\n \"insight\": \"<string>\"\n }\n ],\n \"violation_summary\": \"<string>\",\n \"insight_summary\": \"<string>\",\n \"correction\": \"<string>\",\n \"violation_type\": \"fix\",\n \"block_id\": \"<string>\",\n \"location\": \"<string>\",\n \"evidence\": \"<string>\",\n \"status\": \"active\",\n \"user_feedback\": \"<string>\"\n },\n \"source_summary\": {\n \"summary_id\": \"<string>\",\n \"version\": \"<string>\",\n \"description\": \"<string>\",\n \"why_summary_matters\": \"<string>\",\n \"action_description\": \"<string>\",\n \"suggested_text\": \"<string>\",\n \"previous_summaries\": [\n {\n \"summary_id\": \"<string>\",\n \"version\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"session_context\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/inspector/review")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document\": {\n \"schema_version\": 1,\n \"pages\": [\n {\n \"id\": \"<string>\",\n \"number\": 2,\n \"grounding_metadata\": {\n \"coordinate_space\": {\n \"unit\": \"pixel\",\n \"origin\": \"top_left\",\n \"width\": 2,\n \"height\": 2\n },\n \"units\": {},\n \"panels\": {}\n },\n \"width\": 2,\n \"height\": 2,\n \"blocks\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"lang\": \"<string>\",\n \"bbox\": {\n \"[0]\": 123,\n \"[1]\": 123,\n \"[2]\": 123,\n \"[3]\": 123\n },\n \"source_unit_ids\": [\n \"<string>\"\n ],\n \"elements\": [\n {\n \"text\": \"<string>\",\n \"type\": \"paragraph\"\n }\n ]\n }\n ],\n \"panels\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"bbox\": {\n \"[0]\": 123,\n \"[1]\": 123,\n \"[2]\": 123,\n \"[3]\": 123\n },\n \"blocks\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"lang\": \"<string>\",\n \"bbox\": {\n \"[0]\": 123,\n \"[1]\": 123,\n \"[2]\": 123,\n \"[3]\": 123\n },\n \"source_unit_ids\": [\n \"<string>\"\n ],\n \"elements\": [\n {\n \"text\": \"<string>\",\n \"type\": \"paragraph\"\n }\n ]\n }\n ],\n \"skipped_source_unit_ids\": [\n \"<string>\"\n ]\n }\n ]\n }\n ]\n },\n \"document_context\": \"<unknown>\",\n \"objects\": [\n {\n \"content\": \"<string>\",\n \"type\": \"image\",\n \"ctx\": null\n }\n ],\n \"ctx\": {\n \"operation\": \"question_about_existing_finding\",\n \"user_message\": \"<string>\",\n \"history\": [\n {\n \"text\": \"<string>\",\n \"blocks\": [\n {\n \"props\": {\n \"items\": [\n {\n \"claim\": \"<string>\",\n \"detail\": \"<string>\",\n \"source\": \"<string>\"\n }\n ]\n },\n \"type\": \"evidence\",\n \"sources\": [\n \"<string>\"\n ]\n }\n ]\n }\n ],\n \"document_version\": 2,\n \"review_revision\": \"<string>\",\n \"finding\": {\n \"id\": \"<string>\",\n \"content\": {\n \"text\": \"<string>\",\n \"metadata\": {}\n },\n \"description\": \"<string>\",\n \"why_summary_matters\": \"<string>\",\n \"action_description\": \"<string>\",\n \"suggested_text\": \"<string>\",\n \"grounding\": [\n {\n \"url\": \"<string>\",\n \"block_id\": \"<string>\",\n \"block_name\": \"<string>\",\n \"group\": \"<string>\"\n }\n ],\n \"status\": \"active\",\n \"user_feedback\": \"<string>\",\n \"previous_summaries\": [\n {\n \"summary_id\": \"<string>\",\n \"version\": \"<string>\"\n }\n ],\n \"violation_ids\": [\n \"<string>\"\n ]\n },\n \"sources\": [\n {\n \"inspector\": {\n \"id\": 123,\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"short_name\": \"<string>\",\n \"description\": \"\",\n \"short_description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"is_shared\": false,\n \"requested_context\": \"all_data\"\n },\n \"violation\": {\n \"id\": \"<string>\",\n \"content\": {\n \"text\": \"<string>\",\n \"metadata\": {}\n },\n \"issues\": [\n {\n \"rule\": {\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"rule_id\": 123,\n \"ctx\": {}\n },\n \"explanation\": \"<string>\",\n \"insight\": \"<string>\"\n }\n ],\n \"violation_summary\": \"<string>\",\n \"insight_summary\": \"<string>\",\n \"correction\": \"<string>\",\n \"violation_type\": \"fix\",\n \"block_id\": \"<string>\",\n \"location\": \"<string>\",\n \"evidence\": \"<string>\"\n }\n }\n ]\n },\n \"context_selection\": \"requested\",\n \"inspector_ids\": [\n 123\n ],\n \"include_recommendations\": false,\n \"organization_id\": 123,\n \"countries\": [\n \"<string>\"\n ],\n \"brand_id\": 123,\n \"product_name\": \"<string>\",\n \"use_case\": \"<string>\",\n \"max_recommendations\": 10,\n \"doc_context\": \"<string>\",\n \"insights_locale\": \"<string>\",\n \"previous_inspections\": [\n {\n \"inspector\": {\n \"id\": 123,\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"short_name\": \"<string>\",\n \"description\": \"\",\n \"short_description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"is_shared\": false,\n \"requested_context\": \"all_data\"\n },\n \"violation\": {\n \"id\": \"<string>\",\n \"content\": {\n \"text\": \"<string>\",\n \"metadata\": {}\n },\n \"issues\": [\n {\n \"rule\": {\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"rule_id\": 123,\n \"ctx\": {}\n },\n \"explanation\": \"<string>\",\n \"insight\": \"<string>\"\n }\n ],\n \"violation_summary\": \"<string>\",\n \"insight_summary\": \"<string>\",\n \"correction\": \"<string>\",\n \"violation_type\": \"fix\",\n \"block_id\": \"<string>\",\n \"location\": \"<string>\",\n \"evidence\": \"<string>\",\n \"status\": \"active\",\n \"user_feedback\": \"<string>\"\n },\n \"source_summary\": {\n \"summary_id\": \"<string>\",\n \"version\": \"<string>\",\n \"description\": \"<string>\",\n \"why_summary_matters\": \"<string>\",\n \"action_description\": \"<string>\",\n \"suggested_text\": \"<string>\",\n \"previous_summaries\": [\n {\n \"summary_id\": \"<string>\",\n \"version\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"session_context\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/inspector/review")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document\": {\n \"schema_version\": 1,\n \"pages\": [\n {\n \"id\": \"<string>\",\n \"number\": 2,\n \"grounding_metadata\": {\n \"coordinate_space\": {\n \"unit\": \"pixel\",\n \"origin\": \"top_left\",\n \"width\": 2,\n \"height\": 2\n },\n \"units\": {},\n \"panels\": {}\n },\n \"width\": 2,\n \"height\": 2,\n \"blocks\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"lang\": \"<string>\",\n \"bbox\": {\n \"[0]\": 123,\n \"[1]\": 123,\n \"[2]\": 123,\n \"[3]\": 123\n },\n \"source_unit_ids\": [\n \"<string>\"\n ],\n \"elements\": [\n {\n \"text\": \"<string>\",\n \"type\": \"paragraph\"\n }\n ]\n }\n ],\n \"panels\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"bbox\": {\n \"[0]\": 123,\n \"[1]\": 123,\n \"[2]\": 123,\n \"[3]\": 123\n },\n \"blocks\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"lang\": \"<string>\",\n \"bbox\": {\n \"[0]\": 123,\n \"[1]\": 123,\n \"[2]\": 123,\n \"[3]\": 123\n },\n \"source_unit_ids\": [\n \"<string>\"\n ],\n \"elements\": [\n {\n \"text\": \"<string>\",\n \"type\": \"paragraph\"\n }\n ]\n }\n ],\n \"skipped_source_unit_ids\": [\n \"<string>\"\n ]\n }\n ]\n }\n ]\n },\n \"document_context\": \"<unknown>\",\n \"objects\": [\n {\n \"content\": \"<string>\",\n \"type\": \"image\",\n \"ctx\": null\n }\n ],\n \"ctx\": {\n \"operation\": \"question_about_existing_finding\",\n \"user_message\": \"<string>\",\n \"history\": [\n {\n \"text\": \"<string>\",\n \"blocks\": [\n {\n \"props\": {\n \"items\": [\n {\n \"claim\": \"<string>\",\n \"detail\": \"<string>\",\n \"source\": \"<string>\"\n }\n ]\n },\n \"type\": \"evidence\",\n \"sources\": [\n \"<string>\"\n ]\n }\n ]\n }\n ],\n \"document_version\": 2,\n \"review_revision\": \"<string>\",\n \"finding\": {\n \"id\": \"<string>\",\n \"content\": {\n \"text\": \"<string>\",\n \"metadata\": {}\n },\n \"description\": \"<string>\",\n \"why_summary_matters\": \"<string>\",\n \"action_description\": \"<string>\",\n \"suggested_text\": \"<string>\",\n \"grounding\": [\n {\n \"url\": \"<string>\",\n \"block_id\": \"<string>\",\n \"block_name\": \"<string>\",\n \"group\": \"<string>\"\n }\n ],\n \"status\": \"active\",\n \"user_feedback\": \"<string>\",\n \"previous_summaries\": [\n {\n \"summary_id\": \"<string>\",\n \"version\": \"<string>\"\n }\n ],\n \"violation_ids\": [\n \"<string>\"\n ]\n },\n \"sources\": [\n {\n \"inspector\": {\n \"id\": 123,\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"short_name\": \"<string>\",\n \"description\": \"\",\n \"short_description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"is_shared\": false,\n \"requested_context\": \"all_data\"\n },\n \"violation\": {\n \"id\": \"<string>\",\n \"content\": {\n \"text\": \"<string>\",\n \"metadata\": {}\n },\n \"issues\": [\n {\n \"rule\": {\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"rule_id\": 123,\n \"ctx\": {}\n },\n \"explanation\": \"<string>\",\n \"insight\": \"<string>\"\n }\n ],\n \"violation_summary\": \"<string>\",\n \"insight_summary\": \"<string>\",\n \"correction\": \"<string>\",\n \"violation_type\": \"fix\",\n \"block_id\": \"<string>\",\n \"location\": \"<string>\",\n \"evidence\": \"<string>\"\n }\n }\n ]\n },\n \"context_selection\": \"requested\",\n \"inspector_ids\": [\n 123\n ],\n \"include_recommendations\": false,\n \"organization_id\": 123,\n \"countries\": [\n \"<string>\"\n ],\n \"brand_id\": 123,\n \"product_name\": \"<string>\",\n \"use_case\": \"<string>\",\n \"max_recommendations\": 10,\n \"doc_context\": \"<string>\",\n \"insights_locale\": \"<string>\",\n \"previous_inspections\": [\n {\n \"inspector\": {\n \"id\": 123,\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"short_name\": \"<string>\",\n \"description\": \"\",\n \"short_description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"is_shared\": false,\n \"requested_context\": \"all_data\"\n },\n \"violation\": {\n \"id\": \"<string>\",\n \"content\": {\n \"text\": \"<string>\",\n \"metadata\": {}\n },\n \"issues\": [\n {\n \"rule\": {\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"rule_id\": 123,\n \"ctx\": {}\n },\n \"explanation\": \"<string>\",\n \"insight\": \"<string>\"\n }\n ],\n \"violation_summary\": \"<string>\",\n \"insight_summary\": \"<string>\",\n \"correction\": \"<string>\",\n \"violation_type\": \"fix\",\n \"block_id\": \"<string>\",\n \"location\": \"<string>\",\n \"evidence\": \"<string>\",\n \"status\": \"active\",\n \"user_feedback\": \"<string>\"\n },\n \"source_summary\": {\n \"summary_id\": \"<string>\",\n \"version\": \"<string>\",\n \"description\": \"<string>\",\n \"why_summary_matters\": \"<string>\",\n \"action_description\": \"<string>\",\n \"suggested_text\": \"<string>\",\n \"previous_summaries\": [\n {\n \"summary_id\": \"<string>\",\n \"version\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"session_context\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"state": "responded_final",
"operation": "question_about_existing_finding",
"document_version": 123,
"review_revision": "<string>",
"finding_id": "<string>",
"selected_inspectors": [
123
],
"inspector_results": [
{
"inspector": {
"description": "Checks advertising claims against substantiation rules.",
"id": 51,
"is_shared": false,
"name": "Advertising Claims",
"requested_context": "all_data",
"short_description": "Advertising claims",
"short_name": "Claims",
"type": "general"
},
"violations": [
{
"block_id": "b12",
"content": {
"text": "Quick Approval Process: Apply in just minutes."
},
"id": "0f1f6f0c-4f0a-4b0e-9a5c-1c6a2f9a7d31",
"insight_summary": "Marketing copy implies a guaranteed fast approval, which can mislead applicants and conflict with required disclosures.",
"issues": [
{
"explanation": "Marketing copy implies a guaranteed fast approval, which can mislead applicants and conflict with required disclosures.",
"insight": "Qualify the speed claim with eligibility language or remove the specific timeframe.",
"rule": {
"name": "Unsubstantiated Speed Claim",
"rule_id": 3412,
"text": "Claims about application or approval speed must include a qualifying disclaimer."
}
}
],
"severity": "MODERATE",
"type": "text",
"violation_summary": "Qualify the speed claim with eligibility language or remove the specific timeframe.",
"violation_type": "fix"
}
]
}
],
"inspector_errors": [
{
"inspector": {
"id": 123,
"name": "<string>",
"type": "<string>",
"short_name": "<string>",
"description": "",
"short_description": "<string>",
"imageUrl": "<string>",
"is_shared": false,
"requested_context": "all_data"
},
"detail": "<string>",
"rule_ids": [
123
],
"error_type": "<string>"
}
],
"summaries": [
{
"id": "<string>",
"type": "text",
"content": {
"text": "<string>",
"metadata": {}
},
"description": "<string>",
"why_summary_matters": "<string>",
"action_requirement": "required",
"action_description": "<string>",
"suggested_text": "<string>",
"grounding": [
{
"url": "<string>",
"block_id": "<string>",
"block_name": "<string>",
"group": "<string>"
}
],
"status": "active",
"user_feedback": "<string>",
"previous_summaries": [
{
"summary_id": "<string>",
"version": "<string>"
}
],
"violation_ids": [
"<string>"
]
}
],
"memory": {
"invalidated_previous_ids": [
"<string>"
],
"carried_over_previous_ids": [
"<string>"
],
"kept_active_previous_ids": [
"<string>"
],
"re_raised_previous_ids": [
"<string>"
],
"suppressed_new_ids": [
"<string>"
]
},
"blocks": [
{
"props": {
"items": [
{
"claim": "<string>",
"detail": "<string>",
"source": "<string>"
}
]
},
"type": "evidence",
"sources": [
"<string>"
]
}
]
}{
"error": "Unauthorized"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Inspector
Review content and return inspector results and aggregated summaries
Review shared objects with inspector_ids, recommendations and memory, or use typed ctx for finding questions and summaries. Includes blocks and conversation metadata. Customer organization_id comes from authentication; system tokens may supply it. Customer brand_id must belong to the authenticated organization. The context_selection default is requested. One credit per request running inspectors, regardless of count. Questions and summaries of supplied findings are free; summaries that first run inspectors cost one credit. HTTP, transport and contract failures and wholly failed inspector runs refund an applied charge once. Partial successes and zero-violation results retain the charge. System tokens are exempt. Use inspector_ids [id] for a single inspection; multiple inspectors share one objects list. Different-content batches need separate review requests.
POST
/
api
/
v1
/
inspector
/
review
Review content and return inspector results and aggregated summaries
curl --request POST \
--url https://api.example.com/api/v1/inspector/review \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document": {
"schema_version": 1,
"pages": [
{
"id": "<string>",
"number": 2,
"grounding_metadata": {
"coordinate_space": {
"unit": "pixel",
"origin": "top_left",
"width": 2,
"height": 2
},
"units": {},
"panels": {}
},
"width": 2,
"height": 2,
"blocks": [
{
"id": "<string>",
"label": "<string>",
"lang": "<string>",
"bbox": {
"[0]": 123,
"[1]": 123,
"[2]": 123,
"[3]": 123
},
"source_unit_ids": [
"<string>"
],
"elements": [
{
"text": "<string>",
"type": "paragraph"
}
]
}
],
"panels": [
{
"id": "<string>",
"label": "<string>",
"bbox": {
"[0]": 123,
"[1]": 123,
"[2]": 123,
"[3]": 123
},
"blocks": [
{
"id": "<string>",
"label": "<string>",
"lang": "<string>",
"bbox": {
"[0]": 123,
"[1]": 123,
"[2]": 123,
"[3]": 123
},
"source_unit_ids": [
"<string>"
],
"elements": [
{
"text": "<string>",
"type": "paragraph"
}
]
}
],
"skipped_source_unit_ids": [
"<string>"
]
}
]
}
]
},
"document_context": "<unknown>",
"objects": [
{
"content": "<string>",
"type": "image",
"ctx": null
}
],
"ctx": {
"operation": "question_about_existing_finding",
"user_message": "<string>",
"history": [
{
"text": "<string>",
"blocks": [
{
"props": {
"items": [
{
"claim": "<string>",
"detail": "<string>",
"source": "<string>"
}
]
},
"type": "evidence",
"sources": [
"<string>"
]
}
]
}
],
"document_version": 2,
"review_revision": "<string>",
"finding": {
"id": "<string>",
"content": {
"text": "<string>",
"metadata": {}
},
"description": "<string>",
"why_summary_matters": "<string>",
"action_description": "<string>",
"suggested_text": "<string>",
"grounding": [
{
"url": "<string>",
"block_id": "<string>",
"block_name": "<string>",
"group": "<string>"
}
],
"status": "active",
"user_feedback": "<string>",
"previous_summaries": [
{
"summary_id": "<string>",
"version": "<string>"
}
],
"violation_ids": [
"<string>"
]
},
"sources": [
{
"inspector": {
"id": 123,
"name": "<string>",
"type": "<string>",
"short_name": "<string>",
"description": "",
"short_description": "<string>",
"imageUrl": "<string>",
"is_shared": false,
"requested_context": "all_data"
},
"violation": {
"id": "<string>",
"content": {
"text": "<string>",
"metadata": {}
},
"issues": [
{
"rule": {
"name": "<string>",
"text": "<string>",
"rule_id": 123,
"ctx": {}
},
"explanation": "<string>",
"insight": "<string>"
}
],
"violation_summary": "<string>",
"insight_summary": "<string>",
"correction": "<string>",
"violation_type": "fix",
"block_id": "<string>",
"location": "<string>",
"evidence": "<string>"
}
}
]
},
"context_selection": "requested",
"inspector_ids": [
123
],
"include_recommendations": false,
"organization_id": 123,
"countries": [
"<string>"
],
"brand_id": 123,
"product_name": "<string>",
"use_case": "<string>",
"max_recommendations": 10,
"doc_context": "<string>",
"insights_locale": "<string>",
"previous_inspections": [
{
"inspector": {
"id": 123,
"name": "<string>",
"type": "<string>",
"short_name": "<string>",
"description": "",
"short_description": "<string>",
"imageUrl": "<string>",
"is_shared": false,
"requested_context": "all_data"
},
"violation": {
"id": "<string>",
"content": {
"text": "<string>",
"metadata": {}
},
"issues": [
{
"rule": {
"name": "<string>",
"text": "<string>",
"rule_id": 123,
"ctx": {}
},
"explanation": "<string>",
"insight": "<string>"
}
],
"violation_summary": "<string>",
"insight_summary": "<string>",
"correction": "<string>",
"violation_type": "fix",
"block_id": "<string>",
"location": "<string>",
"evidence": "<string>",
"status": "active",
"user_feedback": "<string>"
},
"source_summary": {
"summary_id": "<string>",
"version": "<string>",
"description": "<string>",
"why_summary_matters": "<string>",
"action_description": "<string>",
"suggested_text": "<string>",
"previous_summaries": [
{
"summary_id": "<string>",
"version": "<string>"
}
]
}
}
],
"session_context": [
{
"question": "<string>",
"answer": "<string>"
}
]
}
'import requests
url = "https://api.example.com/api/v1/inspector/review"
payload = {
"document": {
"schema_version": 1,
"pages": [
{
"id": "<string>",
"number": 2,
"grounding_metadata": {
"coordinate_space": {
"unit": "pixel",
"origin": "top_left",
"width": 2,
"height": 2
},
"units": {},
"panels": {}
},
"width": 2,
"height": 2,
"blocks": [
{
"id": "<string>",
"label": "<string>",
"lang": "<string>",
"bbox": {
"[0]": 123,
"[1]": 123,
"[2]": 123,
"[3]": 123
},
"source_unit_ids": ["<string>"],
"elements": [
{
"text": "<string>",
"type": "paragraph"
}
]
}
],
"panels": [
{
"id": "<string>",
"label": "<string>",
"bbox": {
"[0]": 123,
"[1]": 123,
"[2]": 123,
"[3]": 123
},
"blocks": [
{
"id": "<string>",
"label": "<string>",
"lang": "<string>",
"bbox": {
"[0]": 123,
"[1]": 123,
"[2]": 123,
"[3]": 123
},
"source_unit_ids": ["<string>"],
"elements": [
{
"text": "<string>",
"type": "paragraph"
}
]
}
],
"skipped_source_unit_ids": ["<string>"]
}
]
}
]
},
"document_context": "<unknown>",
"objects": [
{
"content": "<string>",
"type": "image",
"ctx": None
}
],
"ctx": {
"operation": "question_about_existing_finding",
"user_message": "<string>",
"history": [
{
"text": "<string>",
"blocks": [
{
"props": { "items": [
{
"claim": "<string>",
"detail": "<string>",
"source": "<string>"
}
] },
"type": "evidence",
"sources": ["<string>"]
}
]
}
],
"document_version": 2,
"review_revision": "<string>",
"finding": {
"id": "<string>",
"content": {
"text": "<string>",
"metadata": {}
},
"description": "<string>",
"why_summary_matters": "<string>",
"action_description": "<string>",
"suggested_text": "<string>",
"grounding": [
{
"url": "<string>",
"block_id": "<string>",
"block_name": "<string>",
"group": "<string>"
}
],
"status": "active",
"user_feedback": "<string>",
"previous_summaries": [
{
"summary_id": "<string>",
"version": "<string>"
}
],
"violation_ids": ["<string>"]
},
"sources": [
{
"inspector": {
"id": 123,
"name": "<string>",
"type": "<string>",
"short_name": "<string>",
"description": "",
"short_description": "<string>",
"imageUrl": "<string>",
"is_shared": False,
"requested_context": "all_data"
},
"violation": {
"id": "<string>",
"content": {
"text": "<string>",
"metadata": {}
},
"issues": [
{
"rule": {
"name": "<string>",
"text": "<string>",
"rule_id": 123,
"ctx": {}
},
"explanation": "<string>",
"insight": "<string>"
}
],
"violation_summary": "<string>",
"insight_summary": "<string>",
"correction": "<string>",
"violation_type": "fix",
"block_id": "<string>",
"location": "<string>",
"evidence": "<string>"
}
}
]
},
"context_selection": "requested",
"inspector_ids": [123],
"include_recommendations": False,
"organization_id": 123,
"countries": ["<string>"],
"brand_id": 123,
"product_name": "<string>",
"use_case": "<string>",
"max_recommendations": 10,
"doc_context": "<string>",
"insights_locale": "<string>",
"previous_inspections": [
{
"inspector": {
"id": 123,
"name": "<string>",
"type": "<string>",
"short_name": "<string>",
"description": "",
"short_description": "<string>",
"imageUrl": "<string>",
"is_shared": False,
"requested_context": "all_data"
},
"violation": {
"id": "<string>",
"content": {
"text": "<string>",
"metadata": {}
},
"issues": [
{
"rule": {
"name": "<string>",
"text": "<string>",
"rule_id": 123,
"ctx": {}
},
"explanation": "<string>",
"insight": "<string>"
}
],
"violation_summary": "<string>",
"insight_summary": "<string>",
"correction": "<string>",
"violation_type": "fix",
"block_id": "<string>",
"location": "<string>",
"evidence": "<string>",
"status": "active",
"user_feedback": "<string>"
},
"source_summary": {
"summary_id": "<string>",
"version": "<string>",
"description": "<string>",
"why_summary_matters": "<string>",
"action_description": "<string>",
"suggested_text": "<string>",
"previous_summaries": [
{
"summary_id": "<string>",
"version": "<string>"
}
]
}
}
],
"session_context": [
{
"question": "<string>",
"answer": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
document: {
schema_version: 1,
pages: [
{
id: '<string>',
number: 2,
grounding_metadata: {
coordinate_space: {unit: 'pixel', origin: 'top_left', width: 2, height: 2},
units: {},
panels: {}
},
width: 2,
height: 2,
blocks: [
{
id: '<string>',
label: '<string>',
lang: '<string>',
bbox: {'[0]': 123, '[1]': 123, '[2]': 123, '[3]': 123},
source_unit_ids: ['<string>'],
elements: [{text: '<string>', type: 'paragraph'}]
}
],
panels: [
{
id: '<string>',
label: '<string>',
bbox: {'[0]': 123, '[1]': 123, '[2]': 123, '[3]': 123},
blocks: [
{
id: '<string>',
label: '<string>',
lang: '<string>',
bbox: {'[0]': 123, '[1]': 123, '[2]': 123, '[3]': 123},
source_unit_ids: ['<string>'],
elements: [{text: '<string>', type: 'paragraph'}]
}
],
skipped_source_unit_ids: ['<string>']
}
]
}
]
},
document_context: '<unknown>',
objects: [{content: '<string>', type: 'image', ctx: null}],
ctx: {
operation: 'question_about_existing_finding',
user_message: '<string>',
history: [
{
text: '<string>',
blocks: [
{
props: {items: [{claim: '<string>', detail: '<string>', source: '<string>'}]},
type: 'evidence',
sources: ['<string>']
}
]
}
],
document_version: 2,
review_revision: '<string>',
finding: {
id: '<string>',
content: {text: '<string>', metadata: {}},
description: '<string>',
why_summary_matters: '<string>',
action_description: '<string>',
suggested_text: '<string>',
grounding: [
{
url: '<string>',
block_id: '<string>',
block_name: '<string>',
group: '<string>'
}
],
status: 'active',
user_feedback: '<string>',
previous_summaries: [{summary_id: '<string>', version: '<string>'}],
violation_ids: ['<string>']
},
sources: [
{
inspector: {
id: 123,
name: '<string>',
type: '<string>',
short_name: '<string>',
description: '',
short_description: '<string>',
imageUrl: '<string>',
is_shared: false,
requested_context: 'all_data'
},
violation: {
id: '<string>',
content: {text: '<string>', metadata: {}},
issues: [
{
rule: {name: '<string>', text: '<string>', rule_id: 123, ctx: {}},
explanation: '<string>',
insight: '<string>'
}
],
violation_summary: '<string>',
insight_summary: '<string>',
correction: '<string>',
violation_type: 'fix',
block_id: '<string>',
location: '<string>',
evidence: '<string>'
}
}
]
},
context_selection: 'requested',
inspector_ids: [123],
include_recommendations: false,
organization_id: 123,
countries: ['<string>'],
brand_id: 123,
product_name: '<string>',
use_case: '<string>',
max_recommendations: 10,
doc_context: '<string>',
insights_locale: '<string>',
previous_inspections: [
{
inspector: {
id: 123,
name: '<string>',
type: '<string>',
short_name: '<string>',
description: '',
short_description: '<string>',
imageUrl: '<string>',
is_shared: false,
requested_context: 'all_data'
},
violation: {
id: '<string>',
content: {text: '<string>', metadata: {}},
issues: [
{
rule: {name: '<string>', text: '<string>', rule_id: 123, ctx: {}},
explanation: '<string>',
insight: '<string>'
}
],
violation_summary: '<string>',
insight_summary: '<string>',
correction: '<string>',
violation_type: 'fix',
block_id: '<string>',
location: '<string>',
evidence: '<string>',
status: 'active',
user_feedback: '<string>'
},
source_summary: {
summary_id: '<string>',
version: '<string>',
description: '<string>',
why_summary_matters: '<string>',
action_description: '<string>',
suggested_text: '<string>',
previous_summaries: [{summary_id: '<string>', version: '<string>'}]
}
}
],
session_context: [{question: '<string>', answer: '<string>'}]
})
};
fetch('https://api.example.com/api/v1/inspector/review', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/inspector/review",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document' => [
'schema_version' => 1,
'pages' => [
[
'id' => '<string>',
'number' => 2,
'grounding_metadata' => [
'coordinate_space' => [
'unit' => 'pixel',
'origin' => 'top_left',
'width' => 2,
'height' => 2
],
'units' => [
],
'panels' => [
]
],
'width' => 2,
'height' => 2,
'blocks' => [
[
'id' => '<string>',
'label' => '<string>',
'lang' => '<string>',
'bbox' => [
'[0]' => 123,
'[1]' => 123,
'[2]' => 123,
'[3]' => 123
],
'source_unit_ids' => [
'<string>'
],
'elements' => [
[
'text' => '<string>',
'type' => 'paragraph'
]
]
]
],
'panels' => [
[
'id' => '<string>',
'label' => '<string>',
'bbox' => [
'[0]' => 123,
'[1]' => 123,
'[2]' => 123,
'[3]' => 123
],
'blocks' => [
[
'id' => '<string>',
'label' => '<string>',
'lang' => '<string>',
'bbox' => [
'[0]' => 123,
'[1]' => 123,
'[2]' => 123,
'[3]' => 123
],
'source_unit_ids' => [
'<string>'
],
'elements' => [
[
'text' => '<string>',
'type' => 'paragraph'
]
]
]
],
'skipped_source_unit_ids' => [
'<string>'
]
]
]
]
]
],
'document_context' => '<unknown>',
'objects' => [
[
'content' => '<string>',
'type' => 'image',
'ctx' => null
]
],
'ctx' => [
'operation' => 'question_about_existing_finding',
'user_message' => '<string>',
'history' => [
[
'text' => '<string>',
'blocks' => [
[
'props' => [
'items' => [
[
'claim' => '<string>',
'detail' => '<string>',
'source' => '<string>'
]
]
],
'type' => 'evidence',
'sources' => [
'<string>'
]
]
]
]
],
'document_version' => 2,
'review_revision' => '<string>',
'finding' => [
'id' => '<string>',
'content' => [
'text' => '<string>',
'metadata' => [
]
],
'description' => '<string>',
'why_summary_matters' => '<string>',
'action_description' => '<string>',
'suggested_text' => '<string>',
'grounding' => [
[
'url' => '<string>',
'block_id' => '<string>',
'block_name' => '<string>',
'group' => '<string>'
]
],
'status' => 'active',
'user_feedback' => '<string>',
'previous_summaries' => [
[
'summary_id' => '<string>',
'version' => '<string>'
]
],
'violation_ids' => [
'<string>'
]
],
'sources' => [
[
'inspector' => [
'id' => 123,
'name' => '<string>',
'type' => '<string>',
'short_name' => '<string>',
'description' => '',
'short_description' => '<string>',
'imageUrl' => '<string>',
'is_shared' => false,
'requested_context' => 'all_data'
],
'violation' => [
'id' => '<string>',
'content' => [
'text' => '<string>',
'metadata' => [
]
],
'issues' => [
[
'rule' => [
'name' => '<string>',
'text' => '<string>',
'rule_id' => 123,
'ctx' => [
]
],
'explanation' => '<string>',
'insight' => '<string>'
]
],
'violation_summary' => '<string>',
'insight_summary' => '<string>',
'correction' => '<string>',
'violation_type' => 'fix',
'block_id' => '<string>',
'location' => '<string>',
'evidence' => '<string>'
]
]
]
],
'context_selection' => 'requested',
'inspector_ids' => [
123
],
'include_recommendations' => false,
'organization_id' => 123,
'countries' => [
'<string>'
],
'brand_id' => 123,
'product_name' => '<string>',
'use_case' => '<string>',
'max_recommendations' => 10,
'doc_context' => '<string>',
'insights_locale' => '<string>',
'previous_inspections' => [
[
'inspector' => [
'id' => 123,
'name' => '<string>',
'type' => '<string>',
'short_name' => '<string>',
'description' => '',
'short_description' => '<string>',
'imageUrl' => '<string>',
'is_shared' => false,
'requested_context' => 'all_data'
],
'violation' => [
'id' => '<string>',
'content' => [
'text' => '<string>',
'metadata' => [
]
],
'issues' => [
[
'rule' => [
'name' => '<string>',
'text' => '<string>',
'rule_id' => 123,
'ctx' => [
]
],
'explanation' => '<string>',
'insight' => '<string>'
]
],
'violation_summary' => '<string>',
'insight_summary' => '<string>',
'correction' => '<string>',
'violation_type' => 'fix',
'block_id' => '<string>',
'location' => '<string>',
'evidence' => '<string>',
'status' => 'active',
'user_feedback' => '<string>'
],
'source_summary' => [
'summary_id' => '<string>',
'version' => '<string>',
'description' => '<string>',
'why_summary_matters' => '<string>',
'action_description' => '<string>',
'suggested_text' => '<string>',
'previous_summaries' => [
[
'summary_id' => '<string>',
'version' => '<string>'
]
]
]
]
],
'session_context' => [
[
'question' => '<string>',
'answer' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/inspector/review"
payload := strings.NewReader("{\n \"document\": {\n \"schema_version\": 1,\n \"pages\": [\n {\n \"id\": \"<string>\",\n \"number\": 2,\n \"grounding_metadata\": {\n \"coordinate_space\": {\n \"unit\": \"pixel\",\n \"origin\": \"top_left\",\n \"width\": 2,\n \"height\": 2\n },\n \"units\": {},\n \"panels\": {}\n },\n \"width\": 2,\n \"height\": 2,\n \"blocks\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"lang\": \"<string>\",\n \"bbox\": {\n \"[0]\": 123,\n \"[1]\": 123,\n \"[2]\": 123,\n \"[3]\": 123\n },\n \"source_unit_ids\": [\n \"<string>\"\n ],\n \"elements\": [\n {\n \"text\": \"<string>\",\n \"type\": \"paragraph\"\n }\n ]\n }\n ],\n \"panels\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"bbox\": {\n \"[0]\": 123,\n \"[1]\": 123,\n \"[2]\": 123,\n \"[3]\": 123\n },\n \"blocks\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"lang\": \"<string>\",\n \"bbox\": {\n \"[0]\": 123,\n \"[1]\": 123,\n \"[2]\": 123,\n \"[3]\": 123\n },\n \"source_unit_ids\": [\n \"<string>\"\n ],\n \"elements\": [\n {\n \"text\": \"<string>\",\n \"type\": \"paragraph\"\n }\n ]\n }\n ],\n \"skipped_source_unit_ids\": [\n \"<string>\"\n ]\n }\n ]\n }\n ]\n },\n \"document_context\": \"<unknown>\",\n \"objects\": [\n {\n \"content\": \"<string>\",\n \"type\": \"image\",\n \"ctx\": null\n }\n ],\n \"ctx\": {\n \"operation\": \"question_about_existing_finding\",\n \"user_message\": \"<string>\",\n \"history\": [\n {\n \"text\": \"<string>\",\n \"blocks\": [\n {\n \"props\": {\n \"items\": [\n {\n \"claim\": \"<string>\",\n \"detail\": \"<string>\",\n \"source\": \"<string>\"\n }\n ]\n },\n \"type\": \"evidence\",\n \"sources\": [\n \"<string>\"\n ]\n }\n ]\n }\n ],\n \"document_version\": 2,\n \"review_revision\": \"<string>\",\n \"finding\": {\n \"id\": \"<string>\",\n \"content\": {\n \"text\": \"<string>\",\n \"metadata\": {}\n },\n \"description\": \"<string>\",\n \"why_summary_matters\": \"<string>\",\n \"action_description\": \"<string>\",\n \"suggested_text\": \"<string>\",\n \"grounding\": [\n {\n \"url\": \"<string>\",\n \"block_id\": \"<string>\",\n \"block_name\": \"<string>\",\n \"group\": \"<string>\"\n }\n ],\n \"status\": \"active\",\n \"user_feedback\": \"<string>\",\n \"previous_summaries\": [\n {\n \"summary_id\": \"<string>\",\n \"version\": \"<string>\"\n }\n ],\n \"violation_ids\": [\n \"<string>\"\n ]\n },\n \"sources\": [\n {\n \"inspector\": {\n \"id\": 123,\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"short_name\": \"<string>\",\n \"description\": \"\",\n \"short_description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"is_shared\": false,\n \"requested_context\": \"all_data\"\n },\n \"violation\": {\n \"id\": \"<string>\",\n \"content\": {\n \"text\": \"<string>\",\n \"metadata\": {}\n },\n \"issues\": [\n {\n \"rule\": {\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"rule_id\": 123,\n \"ctx\": {}\n },\n \"explanation\": \"<string>\",\n \"insight\": \"<string>\"\n }\n ],\n \"violation_summary\": \"<string>\",\n \"insight_summary\": \"<string>\",\n \"correction\": \"<string>\",\n \"violation_type\": \"fix\",\n \"block_id\": \"<string>\",\n \"location\": \"<string>\",\n \"evidence\": \"<string>\"\n }\n }\n ]\n },\n \"context_selection\": \"requested\",\n \"inspector_ids\": [\n 123\n ],\n \"include_recommendations\": false,\n \"organization_id\": 123,\n \"countries\": [\n \"<string>\"\n ],\n \"brand_id\": 123,\n \"product_name\": \"<string>\",\n \"use_case\": \"<string>\",\n \"max_recommendations\": 10,\n \"doc_context\": \"<string>\",\n \"insights_locale\": \"<string>\",\n \"previous_inspections\": [\n {\n \"inspector\": {\n \"id\": 123,\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"short_name\": \"<string>\",\n \"description\": \"\",\n \"short_description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"is_shared\": false,\n \"requested_context\": \"all_data\"\n },\n \"violation\": {\n \"id\": \"<string>\",\n \"content\": {\n \"text\": \"<string>\",\n \"metadata\": {}\n },\n \"issues\": [\n {\n \"rule\": {\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"rule_id\": 123,\n \"ctx\": {}\n },\n \"explanation\": \"<string>\",\n \"insight\": \"<string>\"\n }\n ],\n \"violation_summary\": \"<string>\",\n \"insight_summary\": \"<string>\",\n \"correction\": \"<string>\",\n \"violation_type\": \"fix\",\n \"block_id\": \"<string>\",\n \"location\": \"<string>\",\n \"evidence\": \"<string>\",\n \"status\": \"active\",\n \"user_feedback\": \"<string>\"\n },\n \"source_summary\": {\n \"summary_id\": \"<string>\",\n \"version\": \"<string>\",\n \"description\": \"<string>\",\n \"why_summary_matters\": \"<string>\",\n \"action_description\": \"<string>\",\n \"suggested_text\": \"<string>\",\n \"previous_summaries\": [\n {\n \"summary_id\": \"<string>\",\n \"version\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"session_context\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/inspector/review")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document\": {\n \"schema_version\": 1,\n \"pages\": [\n {\n \"id\": \"<string>\",\n \"number\": 2,\n \"grounding_metadata\": {\n \"coordinate_space\": {\n \"unit\": \"pixel\",\n \"origin\": \"top_left\",\n \"width\": 2,\n \"height\": 2\n },\n \"units\": {},\n \"panels\": {}\n },\n \"width\": 2,\n \"height\": 2,\n \"blocks\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"lang\": \"<string>\",\n \"bbox\": {\n \"[0]\": 123,\n \"[1]\": 123,\n \"[2]\": 123,\n \"[3]\": 123\n },\n \"source_unit_ids\": [\n \"<string>\"\n ],\n \"elements\": [\n {\n \"text\": \"<string>\",\n \"type\": \"paragraph\"\n }\n ]\n }\n ],\n \"panels\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"bbox\": {\n \"[0]\": 123,\n \"[1]\": 123,\n \"[2]\": 123,\n \"[3]\": 123\n },\n \"blocks\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"lang\": \"<string>\",\n \"bbox\": {\n \"[0]\": 123,\n \"[1]\": 123,\n \"[2]\": 123,\n \"[3]\": 123\n },\n \"source_unit_ids\": [\n \"<string>\"\n ],\n \"elements\": [\n {\n \"text\": \"<string>\",\n \"type\": \"paragraph\"\n }\n ]\n }\n ],\n \"skipped_source_unit_ids\": [\n \"<string>\"\n ]\n }\n ]\n }\n ]\n },\n \"document_context\": \"<unknown>\",\n \"objects\": [\n {\n \"content\": \"<string>\",\n \"type\": \"image\",\n \"ctx\": null\n }\n ],\n \"ctx\": {\n \"operation\": \"question_about_existing_finding\",\n \"user_message\": \"<string>\",\n \"history\": [\n {\n \"text\": \"<string>\",\n \"blocks\": [\n {\n \"props\": {\n \"items\": [\n {\n \"claim\": \"<string>\",\n \"detail\": \"<string>\",\n \"source\": \"<string>\"\n }\n ]\n },\n \"type\": \"evidence\",\n \"sources\": [\n \"<string>\"\n ]\n }\n ]\n }\n ],\n \"document_version\": 2,\n \"review_revision\": \"<string>\",\n \"finding\": {\n \"id\": \"<string>\",\n \"content\": {\n \"text\": \"<string>\",\n \"metadata\": {}\n },\n \"description\": \"<string>\",\n \"why_summary_matters\": \"<string>\",\n \"action_description\": \"<string>\",\n \"suggested_text\": \"<string>\",\n \"grounding\": [\n {\n \"url\": \"<string>\",\n \"block_id\": \"<string>\",\n \"block_name\": \"<string>\",\n \"group\": \"<string>\"\n }\n ],\n \"status\": \"active\",\n \"user_feedback\": \"<string>\",\n \"previous_summaries\": [\n {\n \"summary_id\": \"<string>\",\n \"version\": \"<string>\"\n }\n ],\n \"violation_ids\": [\n \"<string>\"\n ]\n },\n \"sources\": [\n {\n \"inspector\": {\n \"id\": 123,\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"short_name\": \"<string>\",\n \"description\": \"\",\n \"short_description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"is_shared\": false,\n \"requested_context\": \"all_data\"\n },\n \"violation\": {\n \"id\": \"<string>\",\n \"content\": {\n \"text\": \"<string>\",\n \"metadata\": {}\n },\n \"issues\": [\n {\n \"rule\": {\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"rule_id\": 123,\n \"ctx\": {}\n },\n \"explanation\": \"<string>\",\n \"insight\": \"<string>\"\n }\n ],\n \"violation_summary\": \"<string>\",\n \"insight_summary\": \"<string>\",\n \"correction\": \"<string>\",\n \"violation_type\": \"fix\",\n \"block_id\": \"<string>\",\n \"location\": \"<string>\",\n \"evidence\": \"<string>\"\n }\n }\n ]\n },\n \"context_selection\": \"requested\",\n \"inspector_ids\": [\n 123\n ],\n \"include_recommendations\": false,\n \"organization_id\": 123,\n \"countries\": [\n \"<string>\"\n ],\n \"brand_id\": 123,\n \"product_name\": \"<string>\",\n \"use_case\": \"<string>\",\n \"max_recommendations\": 10,\n \"doc_context\": \"<string>\",\n \"insights_locale\": \"<string>\",\n \"previous_inspections\": [\n {\n \"inspector\": {\n \"id\": 123,\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"short_name\": \"<string>\",\n \"description\": \"\",\n \"short_description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"is_shared\": false,\n \"requested_context\": \"all_data\"\n },\n \"violation\": {\n \"id\": \"<string>\",\n \"content\": {\n \"text\": \"<string>\",\n \"metadata\": {}\n },\n \"issues\": [\n {\n \"rule\": {\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"rule_id\": 123,\n \"ctx\": {}\n },\n \"explanation\": \"<string>\",\n \"insight\": \"<string>\"\n }\n ],\n \"violation_summary\": \"<string>\",\n \"insight_summary\": \"<string>\",\n \"correction\": \"<string>\",\n \"violation_type\": \"fix\",\n \"block_id\": \"<string>\",\n \"location\": \"<string>\",\n \"evidence\": \"<string>\",\n \"status\": \"active\",\n \"user_feedback\": \"<string>\"\n },\n \"source_summary\": {\n \"summary_id\": \"<string>\",\n \"version\": \"<string>\",\n \"description\": \"<string>\",\n \"why_summary_matters\": \"<string>\",\n \"action_description\": \"<string>\",\n \"suggested_text\": \"<string>\",\n \"previous_summaries\": [\n {\n \"summary_id\": \"<string>\",\n \"version\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"session_context\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/inspector/review")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document\": {\n \"schema_version\": 1,\n \"pages\": [\n {\n \"id\": \"<string>\",\n \"number\": 2,\n \"grounding_metadata\": {\n \"coordinate_space\": {\n \"unit\": \"pixel\",\n \"origin\": \"top_left\",\n \"width\": 2,\n \"height\": 2\n },\n \"units\": {},\n \"panels\": {}\n },\n \"width\": 2,\n \"height\": 2,\n \"blocks\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"lang\": \"<string>\",\n \"bbox\": {\n \"[0]\": 123,\n \"[1]\": 123,\n \"[2]\": 123,\n \"[3]\": 123\n },\n \"source_unit_ids\": [\n \"<string>\"\n ],\n \"elements\": [\n {\n \"text\": \"<string>\",\n \"type\": \"paragraph\"\n }\n ]\n }\n ],\n \"panels\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"bbox\": {\n \"[0]\": 123,\n \"[1]\": 123,\n \"[2]\": 123,\n \"[3]\": 123\n },\n \"blocks\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"lang\": \"<string>\",\n \"bbox\": {\n \"[0]\": 123,\n \"[1]\": 123,\n \"[2]\": 123,\n \"[3]\": 123\n },\n \"source_unit_ids\": [\n \"<string>\"\n ],\n \"elements\": [\n {\n \"text\": \"<string>\",\n \"type\": \"paragraph\"\n }\n ]\n }\n ],\n \"skipped_source_unit_ids\": [\n \"<string>\"\n ]\n }\n ]\n }\n ]\n },\n \"document_context\": \"<unknown>\",\n \"objects\": [\n {\n \"content\": \"<string>\",\n \"type\": \"image\",\n \"ctx\": null\n }\n ],\n \"ctx\": {\n \"operation\": \"question_about_existing_finding\",\n \"user_message\": \"<string>\",\n \"history\": [\n {\n \"text\": \"<string>\",\n \"blocks\": [\n {\n \"props\": {\n \"items\": [\n {\n \"claim\": \"<string>\",\n \"detail\": \"<string>\",\n \"source\": \"<string>\"\n }\n ]\n },\n \"type\": \"evidence\",\n \"sources\": [\n \"<string>\"\n ]\n }\n ]\n }\n ],\n \"document_version\": 2,\n \"review_revision\": \"<string>\",\n \"finding\": {\n \"id\": \"<string>\",\n \"content\": {\n \"text\": \"<string>\",\n \"metadata\": {}\n },\n \"description\": \"<string>\",\n \"why_summary_matters\": \"<string>\",\n \"action_description\": \"<string>\",\n \"suggested_text\": \"<string>\",\n \"grounding\": [\n {\n \"url\": \"<string>\",\n \"block_id\": \"<string>\",\n \"block_name\": \"<string>\",\n \"group\": \"<string>\"\n }\n ],\n \"status\": \"active\",\n \"user_feedback\": \"<string>\",\n \"previous_summaries\": [\n {\n \"summary_id\": \"<string>\",\n \"version\": \"<string>\"\n }\n ],\n \"violation_ids\": [\n \"<string>\"\n ]\n },\n \"sources\": [\n {\n \"inspector\": {\n \"id\": 123,\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"short_name\": \"<string>\",\n \"description\": \"\",\n \"short_description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"is_shared\": false,\n \"requested_context\": \"all_data\"\n },\n \"violation\": {\n \"id\": \"<string>\",\n \"content\": {\n \"text\": \"<string>\",\n \"metadata\": {}\n },\n \"issues\": [\n {\n \"rule\": {\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"rule_id\": 123,\n \"ctx\": {}\n },\n \"explanation\": \"<string>\",\n \"insight\": \"<string>\"\n }\n ],\n \"violation_summary\": \"<string>\",\n \"insight_summary\": \"<string>\",\n \"correction\": \"<string>\",\n \"violation_type\": \"fix\",\n \"block_id\": \"<string>\",\n \"location\": \"<string>\",\n \"evidence\": \"<string>\"\n }\n }\n ]\n },\n \"context_selection\": \"requested\",\n \"inspector_ids\": [\n 123\n ],\n \"include_recommendations\": false,\n \"organization_id\": 123,\n \"countries\": [\n \"<string>\"\n ],\n \"brand_id\": 123,\n \"product_name\": \"<string>\",\n \"use_case\": \"<string>\",\n \"max_recommendations\": 10,\n \"doc_context\": \"<string>\",\n \"insights_locale\": \"<string>\",\n \"previous_inspections\": [\n {\n \"inspector\": {\n \"id\": 123,\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"short_name\": \"<string>\",\n \"description\": \"\",\n \"short_description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"is_shared\": false,\n \"requested_context\": \"all_data\"\n },\n \"violation\": {\n \"id\": \"<string>\",\n \"content\": {\n \"text\": \"<string>\",\n \"metadata\": {}\n },\n \"issues\": [\n {\n \"rule\": {\n \"name\": \"<string>\",\n \"text\": \"<string>\",\n \"rule_id\": 123,\n \"ctx\": {}\n },\n \"explanation\": \"<string>\",\n \"insight\": \"<string>\"\n }\n ],\n \"violation_summary\": \"<string>\",\n \"insight_summary\": \"<string>\",\n \"correction\": \"<string>\",\n \"violation_type\": \"fix\",\n \"block_id\": \"<string>\",\n \"location\": \"<string>\",\n \"evidence\": \"<string>\",\n \"status\": \"active\",\n \"user_feedback\": \"<string>\"\n },\n \"source_summary\": {\n \"summary_id\": \"<string>\",\n \"version\": \"<string>\",\n \"description\": \"<string>\",\n \"why_summary_matters\": \"<string>\",\n \"action_description\": \"<string>\",\n \"suggested_text\": \"<string>\",\n \"previous_summaries\": [\n {\n \"summary_id\": \"<string>\",\n \"version\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"session_context\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"state": "responded_final",
"operation": "question_about_existing_finding",
"document_version": 123,
"review_revision": "<string>",
"finding_id": "<string>",
"selected_inspectors": [
123
],
"inspector_results": [
{
"inspector": {
"description": "Checks advertising claims against substantiation rules.",
"id": 51,
"is_shared": false,
"name": "Advertising Claims",
"requested_context": "all_data",
"short_description": "Advertising claims",
"short_name": "Claims",
"type": "general"
},
"violations": [
{
"block_id": "b12",
"content": {
"text": "Quick Approval Process: Apply in just minutes."
},
"id": "0f1f6f0c-4f0a-4b0e-9a5c-1c6a2f9a7d31",
"insight_summary": "Marketing copy implies a guaranteed fast approval, which can mislead applicants and conflict with required disclosures.",
"issues": [
{
"explanation": "Marketing copy implies a guaranteed fast approval, which can mislead applicants and conflict with required disclosures.",
"insight": "Qualify the speed claim with eligibility language or remove the specific timeframe.",
"rule": {
"name": "Unsubstantiated Speed Claim",
"rule_id": 3412,
"text": "Claims about application or approval speed must include a qualifying disclaimer."
}
}
],
"severity": "MODERATE",
"type": "text",
"violation_summary": "Qualify the speed claim with eligibility language or remove the specific timeframe.",
"violation_type": "fix"
}
]
}
],
"inspector_errors": [
{
"inspector": {
"id": 123,
"name": "<string>",
"type": "<string>",
"short_name": "<string>",
"description": "",
"short_description": "<string>",
"imageUrl": "<string>",
"is_shared": false,
"requested_context": "all_data"
},
"detail": "<string>",
"rule_ids": [
123
],
"error_type": "<string>"
}
],
"summaries": [
{
"id": "<string>",
"type": "text",
"content": {
"text": "<string>",
"metadata": {}
},
"description": "<string>",
"why_summary_matters": "<string>",
"action_requirement": "required",
"action_description": "<string>",
"suggested_text": "<string>",
"grounding": [
{
"url": "<string>",
"block_id": "<string>",
"block_name": "<string>",
"group": "<string>"
}
],
"status": "active",
"user_feedback": "<string>",
"previous_summaries": [
{
"summary_id": "<string>",
"version": "<string>"
}
],
"violation_ids": [
"<string>"
]
}
],
"memory": {
"invalidated_previous_ids": [
"<string>"
],
"carried_over_previous_ids": [
"<string>"
],
"kept_active_previous_ids": [
"<string>"
],
"re_raised_previous_ids": [
"<string>"
],
"suppressed_new_ids": [
"<string>"
]
},
"blocks": [
{
"props": {
"items": [
{
"claim": "<string>",
"detail": "<string>",
"source": "<string>"
}
]
},
"type": "evidence",
"sources": [
"<string>"
]
}
]
}{
"error": "Unauthorized"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Show child attributes
Show child attributes
Optional source metadata attached to the rendered document inspector object.
Show child attributes
Show child attributes
- QuestionAboutExistingFindingContext
- SummaryExistingFindingsContext
- RegenerateExistingFindingContext
Show child attributes
Show child attributes
How inspector input is prepared from document. requested applies each inspector's requested_context and rule scopes, adding NO_REQUESTED_DATA markers for missing data. none renders the complete document to canonical inspector HTML without filtering.
Available options:
none, requested Closed leaf taxonomy of asset types a precheck can classify.
Values are identical to the DB asset_type.name so the classifier output
resolves to a row with no translation. Extend by adding a member here and
describing it in the classify prompt. Callers gate flows by comparing against
a specific member (e.g. extract routes grounded extraction on
packaging/labeling).
Available options:
ads_social_media, video_multimedia, print_materials, ads_promo_other, web_seo_content, email_crm, product_description, brief, owned_digital_product_other, packaging, labeling, master_label, retail_in_store, product_packaging_retail_other, pr_press_releases, legal_regulatory, brand_guidelines, safety_data_sheet, corporate_legal_brand_other, other Closed leaf taxonomy of industries (values == industry.name).
Available options:
FOOD_BEVERAGES, RAW_FOOD, NON_ALCOHOLIC_BEVERAGES, DIETARY_SUPPLEMENTS, FOOD_PRODUCTION, DAIRY, FARMING, RANCHING, FISHERY, RESTAURANTS, SUPERMARKETS, COSMETICS, PHARMA_AND_SUPPLEMENTS, PRESCRIPTION_DRUGS, OTC_DRUGS, SUPPLEMENTS, PHARMACEUTICALS, BIOTECHNOLOGY, ALCOHOL, DISTILLED_SPIRITS, MALT_BEVERAGES, WINE_AND_SPIRITS, TOBACCO, HOSPITAL_HEALTH_CARE, MEDICAL_DEVICES, MEDICAL_GASES, HEALTH_WELLNESS_AND_FITNESS, WEIGHT_LOSS, MEDICAL_PRACTICE, MENTAL_HEALTH_CARE, ALTERNATIVE_MEDICINE, VETERINARY, ENERGY, OIL_ENERGY, RENEWABLES_ENVIRONMENT, UTILITIES, ENVIRONMENTAL_SERVICES, GAMBLING_CASINOS, ADULT_PRODUCTS, DATING_SERVICES, RECREATIONAL_DRUGS, CANNABIS, PSYCHEDELIC_MUSHROOMS, MDMA, KETAMINE, HEC, REAL_ESTATE, STAFFING_AND_RECRUITING, CREDIT, BODY_MODIFICATION, OTHER_REGULATED, PEST_CONTROL, INFORMATION_TECHNOLOGY_AND_SERVICES, COMPUTER_SOFTWARE, COMPUTER_HARDWARE, COMPUTER_NETWORKING, COMPUTER_NETWORK_SECURITY, CONSUMER_ELECTRONICS, INFORMATION_SERVICES, INTERNET, SEMICONDUCTORS, NANOTECHNOLOGY, COMPUTER_GAMES, MOBILE_GAMES, TELECOMMUNICATIONS, WIRELESS, ENTERTAINMENT, BROADCAST_MEDIA, ONLINE_MEDIA, MEDIA_PRODUCTION, MOTION_PICTURES_AND_FILM, ANIMATION, MUSIC, PERFORMING_ARTS, PUBLISHING, NEWSPAPERS, PHOTOGRAPHY, FINE_ART, MUSEUMS_AND_INSTITUTIONS, WRITING_AND_EDITING, FINANCIAL_SERVICES, FINTECH, BANKING, CREDIT_UNIONS, CRYPTO, INSURANCE, LIFE_INSURANCE, ACCIDENT_SICKNESS_INSURANCE, ACCOUNTING, CAPITAL_MARKETS, INVESTMENT_BANKING, INVESTMENT_MANAGEMENT, VENTURE_CAPITAL_PRIVATE_EQUITY, CONSTRUCTION, ARCHITECTURE_PLANNING, CIVIL_ENGINEERING, BUILDING_MATERIALS, GLASS_CERAMICS_CONCRETE, COMMERCIAL_REAL_ESTATE, MACHINERY, INDUSTRIAL_AUTOMATION, MECHANICAL_OR_INDUSTRIAL_ENGINEERING, ELECTRICAL_ELECTRONIC_MANUFACTURING, CHEMICALS, PLASTICS, TEXTILES, PAPER_FOREST_PRODUCTS, PACKAGING_AND_CONTAINERS, PRINTING, FURNITURE, MINING_METALS, RAILROAD_MANUFACTURE, SHIPBUILDING, DEFENSE_SPACE, AVIATION_AEROSPACE, AUTOMOTIVE, TRANSPORTATION_TRUCKING_RAILROAD, LOGISTICS_AND_SUPPLY_CHAIN, WAREHOUSING, PACKAGE_FREIGHT_DELIVERY, AIRLINES_AVIATION, MARITIME, IMPORT_AND_EXPORT, CONSUMER_GOODS, RETAIL, WHOLESALE, CONSUMER_SERVICES, APPAREL_FASHION, LUXURY_GOODS_JEWELRY, SPORTING_GOODS, ARTS_AND_CRAFTS, BUSINESS_SUPPLIES_AND_EQUIPMENT, MANAGEMENT_CONSULTING, MARKETING_AND_ADVERTISING, MARKET_RESEARCH, PUBLIC_RELATIONS_AND_COMMUNICATIONS, DESIGN, GRAPHIC_DESIGN, HUMAN_RESOURCES, TRANSLATION_AND_LOCALIZATION, PROFESSIONAL_TRAINING_COACHING, OUTSOURCING_OFFSHORING, FACILITIES_SERVICES, SECURITY_AND_INVESTIGATIONS, LEGAL_SERVICES, LAW_PRACTICE, ALTERNATIVE_DISPUTE_RESOLUTION, JUDICIARY, EDUCATION_MANAGEMENT, HIGHER_EDUCATION, PRIMARY_SECONDARY_EDUCATION, E_LEARNING, RESEARCH, LIBRARIES, HOSPITALITY, LEISURE_TRAVEL_TOURISM, EVENTS_SERVICES, RECREATIONAL_FACILITIES_AND_SERVICES, SPORTS, GOVERNMENT_ADMINISTRATION, GOVERNMENT_RELATIONS, PUBLIC_POLICY, PUBLIC_SAFETY, LAW_ENFORCEMENT, MILITARY, LEGISLATIVE_OFFICE, EXECUTIVE_OFFICE, INTERNATIONAL_AFFAIRS, INTERNATIONAL_TRADE_AND_DEVELOPMENT, POLITICAL_ORGANIZATION, NON_PROFIT_ORGANIZATION_MANAGEMENT, PHILANTHROPY, FUND_RAISING, CIVIC_SOCIAL_ORGANIZATION, RELIGIOUS_INSTITUTIONS, THINK_TANKS, INDIVIDUAL_FAMILY_SERVICES, PROGRAM_DEVELOPMENT Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Successful Response
Available options:
responded_final, responded_iteration Available options:
question_about_existing_finding, summarize_findings, summary_existing_findings, regenerate_existing_finding Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Bookkeeping of what memory reconciliation did with the previous violations (ENG-1787).
Show child attributes
Show child attributes
- EvidenceBlock
- ExplanationBlock
- ReviewBriefBlock
Show child attributes
Show child attributes