Skip to main content
GET
/
evaluations
/
{job_id}
{
  "job_id": "<string>",
  "status": "<string>",
  "total_items": 123,
  "processed_items": 123,
  "failed_items": 123,
  "progress_percentage": 123,
  "judge_id": "<string>",
  "created_at": {},
  "started_at": {},
  "completed_at": {},
  "estimated_completion_time": {},
  "error_message": "<string>",
  "results": [
    {
      "item_id": "<string>",
      "external_id": "<string>",
      "status": "<string>",
      "overall_score": 123,
      "criteria_scores": [
        {
          "criterion_name": "<string>",
          "score": 123,
          "feedback": "<string>"
        }
      ],
      "summary": "<string>",
      "strengths": [
        {}
      ],
      "weaknesses": [
        {}
      ],
      "suggestions": [
        {}
      ],
      "evaluated_at": {},
      "error_message": "<string>"
    }
  ]
}

Overview

Retrieves the status, progress, and results of a batch evaluation job submitted via API key. This endpoint provides detailed information about job execution and individual item results.

Headers

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

Path Parameters

job_id
string
required
Unique identifier of the evaluation job

Query Parameters

include_results
boolean
default:"true"
Include individual item evaluation results
results_limit
integer
default:"100"
Maximum number of individual results to return
results_offset
integer
default:"0"
Number of results to skip for pagination
status_filter
string
Filter results by evaluation status
  • completed - Only completed evaluations
  • failed - Only failed evaluations
  • processing - Only processing evaluations

Response

job_id
string
required
Unique identifier for the evaluation job
status
string
required
Current 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 successfully
failed_items
integer
required
Number of items that failed processing
progress_percentage
number
required
Job completion percentage (0-100)
judge_id
string
required
ID of the judge used for evaluation
created_at
datetime
required
Job creation timestamp
started_at
datetime
Job processing start timestamp
completed_at
datetime
Job completion timestamp (if completed)
estimated_completion_time
datetime
Estimated completion time (if still processing)
error_message
string
Error description (if job failed)
results
array
Individual evaluation results (if include_results=true)

Examples

curl -X GET "https://api.judge.example.com/evaluations/job_batch_456?include_results=true&results_limit=10" \
  -H "X-API-Key: YOUR_API_KEY"
curl -X GET "https://api.judge.example.com/evaluations/job_batch_789" \
  -H "X-API-Key: YOUR_API_KEY"
curl -X GET "https://api.judge.example.com/evaluations/invalid_job_id" \
  -H "X-API-Key: YOUR_API_KEY"
curl -X GET "https://api.judge.example.com/evaluations/job_failed_123" \
  -H "X-API-Key: YOUR_API_KEY"