Skip to main content
POST
/
api-key
/
evaluations
/
batch
{
  "job_id": "<string>",
  "status": "<string>",
  "total_items": 123,
  "processed_items": 123,
  "judge_id": "<string>",
  "estimated_completion_time": {},
  "created_at": {},
  "webhook_url": "<string>"
}

​
Overview

Submits multiple content items for batch evaluation using API key authentication. This endpoint is designed for high-volume processing and programmatic access without user authentication.

​
Headers

​
X-API-Key
string
required
Organization API key for authentication

​
Request Body

​
judge_id
string
required
ID of the judge to use for evaluation
​
items
array
required
List of content items to evaluate
​
batch_options
object
Batch processing options

​
Response

​
job_id
string
required
Unique identifier for the batch evaluation job
​
status
string
required
Initial job status
  • queued - Job queued for processing
  • processing - Job is being processed
  • completed - All items evaluated
  • failed - Job failed
  • cancelled - Job was cancelled
​
total_items
integer
required
Total number of items in the batch
​
processed_items
integer
required
Number of items processed so far
​
judge_id
string
required
ID of the judge being used
​
estimated_completion_time
datetime
Estimated completion time for the job
​
created_at
datetime
required
Job creation timestamp
​
webhook_url
string
Configured webhook URL (if provided)

​
Examples

curl -X POST https://api.judge.example.com/api-key/evaluations/batch \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "judge_id": "jdg_xyz789",
    "items": [
      {
        "content": "This is the first piece of content to evaluate",
        "external_id": "content_001",
        "metadata": {
          "source": "user_submission",
          "category": "feedback"
        }
      },
      {
        "content": "This is the second piece of content",
        "external_id": "content_002",
        "metadata": {
          "source": "social_media",
          "platform": "twitter"
        }
      },
      {
        "content_id": "cnt_existing123",
        "external_id": "content_003"
      }
    ],
    "batch_options": {
      "priority": "high",
      "webhook_url": "https://your-app.com/webhooks/evaluations",
      "webhook_secret": "your_webhook_secret",
      "timeout_seconds": 600
    }
  }'

curl -X POST https://api.judge.example.com/api-key/evaluations/batch \
  -H "X-API-Key: invalid_key" \
  -H "Content-Type: application/json" \
  -d '{
    "judge_id": "jdg_xyz789",
    "items": [{"content": "test"}]
  }'

curl -X POST https://api.judge.example.com/api-key/evaluations/batch \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "judge_id": "jdg_xyz789",
    "items": [/* 150 items - exceeds limit */]
  }'