API Reference
Complete reference for the CheckYourAI API endpoints.
Base URL
https://checkyour.ai/api/v1
https://checkyour.ai/api/v1
Submit Content for Review
POST
/api/v1/reviews
Request Headers
| Header | Value | Required |
|---|---|---|
Authorization
|
Bearer YOUR_API_TOKEN
|
Required |
Content-Type
|
application/json
|
Required |
Required Fields
| Field | Type | Description |
|---|---|---|
input
|
string |
The original prompt or question given to the AI.
Min: 1 character
|
output
|
string |
The AI-generated response that needs review.
Min: 1 character
|
context
|
string |
Situational information about this content.
Min: 1 character, Max: 2000 characters
|
model
|
string |
The AI model used to generate the content (e.g., "gpt-4", "claude-3-opus").
Min: 1 character, Max: 100 characters
|
app_name
|
string |
Your application identifier.
Min: 1 character, Max: 100 characters
|
webhook_url
|
string |
URL to receive the review result when complete.
Must be valid HTTP or HTTPS URL
|
Optional Fields
| Field | Type | Description |
|---|---|---|
external_id
|
string |
Your internal reference ID (ticket number, order ID, etc.). This will be returned in the webhook response.
Max: 255 characters
|
category
|
string |
Type of content for routing to specialized reviewers.
Suggested: customer_support, legal, medical, marketing, technical, general
|
review_focus
|
enum | How the content should be reviewed. |
language
|
string |
Language/locale of the content.
ISO language code recommended (e.g., "en-US", "es-MX")
|
confidence
|
float |
AI's confidence score in its response.
Must be between 0.0 and 1.0
|
content_type
|
enum |
Content type for editor selection.
Values: json, markdown, rich_text, plain_text (default: plain_text)
|
metadata
|
object |
Any additional data you want passed through unchanged. Returned in webhook.
Valid JSON object
|
Example Request
curl -X POST https://checkyour.ai/api/v1/reviews \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"input": "Customer asked: How do I return my order?",
"output": "To return your order, visit our returns page...",
"context": "VIP customer support inquiry",
"model": "gpt-4",
"app_name": "my-app",
"webhook_url": "https://myapp.com/webhooks/review-completed",
"external_id": "TICKET-1234",
"category": "customer_support",
"review_focus": "accuracy",
"language": "en-US",
"confidence": 0.92,
"metadata": {
"ticket_id": "1234",
"customer_id": "CUST-789"
}
}'
curl -X POST https://checkyour.ai/api/v1/reviews \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"input": "Customer asked: How do I return my order?",
"output": "To return your order, visit our returns page...",
"context": "VIP customer support inquiry",
"model": "gpt-4",
"app_name": "my-app",
"webhook_url": "https://myapp.com/webhooks/review-completed",
"external_id": "TICKET-1234",
"category": "customer_support",
"review_focus": "accuracy",
"language": "en-US",
"confidence": 0.92,
"metadata": {
"ticket_id": "1234",
"customer_id": "CUST-789"
}
}'
Success Response (201 Created)
{
"review_id": 42,
"status": "pending",
"created_at": "2025-01-15T10:30:00Z",
"external_id": "TICKET-1234"
}
{
"review_id": 42,
"status": "pending",
"created_at": "2025-01-15T10:30:00Z",
"external_id": "TICKET-1234"
}
Response Fields:
-
review_id- Unique ID for this review -
status- Current status (in_review) -
created_at- ISO 8601 timestamp -
external_id- Your reference ID (if provided)