Getting Started
Get up and running with the CheckYourAI API in minutes.
1. Get Your API Token
First, you'll need to generate an API token from your dashboard.
Keep your API token secure!
Never expose your API token in client-side code or public repositories.
2. Make Your First Request
Submit AI-generated content for review using a simple POST request.
Quick Example
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 at...",
"context": "VIP customer support inquiry",
"model": "gpt-4",
"app_name": "my-app",
"webhook_url": "https://your-app.com/webhooks/review-completed"
}'
Success Response (201 Created)
{
"review_id": 12345,
"status": "pending",
"created_at": "2025-01-15T10:30:00Z",
"external_id": null
}
3. Handle the Response
The API returns immediately with a review ID. The actual review happens asynchronously.
Immediate Response
You'll receive a review_id immediately upon successful submission. Status will be
in_review.
Webhook Notification
When the review is complete, we'll send a webhook to your configured
webhook_url with the review results.
4. Set Up Webhooks
The webhook_url field is required.
When the review is complete, we'll POST the results to this URL.
Learn more about webhook security and verification in our Webhooks documentation .
Required Fields
| Field | Type | Description |
|---|---|---|
input
|
string | The original input/prompt given to the AI |
output
|
string | The AI-generated response to be reviewed |
context
|
string | Situational context for the content (max 2000 chars) |
model
|
string | AI model used (e.g., "gpt-4") |
app_name
|
string | Your application identifier |
webhook_url
|
string | Valid HTTP/HTTPS URL to receive results |
See the API Reference for optional fields.