Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getpique.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Introduction

The Pique API provides programmatic access to create and manage judges, and submit content for evaluation.

​
Base URLs

https://api.getpique.ai
https://api-sandbox.getpique.ai

​
API Key Authentication

Include your API key in the X-API-Key header: 
curl -H "X-API-Key: your-api-key" https://api.getpique.ai/v1/endpoint

​
Available Endpoints

​
Judges

MethodEndpointDescription
GET/v1/judgesList all judges for your organization
GET/v1/judges/{judge_id}Get details of a specific judge
POST/v1/judgesCreate a new judge with evaluation criteria
POST/v1/judges/reference_contentGenerate pre-signed upload URL for reference content

​
Evaluations

MethodEndpointDescription
POST/v1/evaluations/presigned-uploadRequest pre-signed upload URL for content evaluation
POST/v1/evaluations/social-mediaSubmit social media video URLs for evaluation
GET/v1/evaluations/results/{job_id}Get evaluation results by job ID

​
Response Format

All API responses are returned in JSON format with appropriate HTTP status codes:
  • 2xx - Success
  • 4xx - Client errors (invalid requests, authentication issues)
  • 5xx - Server errors

​
Success Response Example

{
  "id": "resource_123",
  "created_at": "2024-01-15T10:30:00Z",
  // ... resource-specific fields
}

​
Error Response Example

{
  "detail": "Error message describing what went wrong"
}

​
Webhooks

Many asynchronous operations support webhook notifications. Configure your webhook URL in your organization settings to receive real-time updates about:
  • Evaluation completion
  • Processing errors
  • Status changes
Webhook requests include an X-Webhook-Signature header for request validation using HMAC-SHA256 with your organization’s webhook secret.