Pique API Documentation

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

Method	Endpoint	Description
GET	`/v1/judges`	List all judges for your organization
GET	`/v1/judges/{judge_id}`	Get details of a specific judge
POST	`/v1/judges`	Create a new judge with evaluation criteria
POST	`/v1/judges/reference_content`	Generate pre-signed upload URL for reference content

Evaluations

Method	Endpoint	Description
POST	`/v1/evaluations/presigned-upload`	Request pre-signed upload URL for content evaluation
POST	`/v1/evaluations/social-media`	Submit 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.

​Introduction

​Base URLs

​API Key Authentication

​Available Endpoints

​Judges

​Evaluations

​Response Format

​Success Response Example

​Error Response Example

​Webhooks