OpenAI-compatible chat completions, model and dataset management, training jobs, criteria-based judging, request reporting (OpenAI and Anthropic), tag/metadata updates, caching, and Anthropic proxying. Base URL https://api.openpipe.ai/api/v1.
{
"openapi": "3.0.3",
"info": {
"title": "OpenPipe API",
"description": "The public API for reporting API calls to OpenPipe",
"version": "0.1.1"
},
"servers": [
{
"url": "https://api.openpipe.ai/api/v1"
}
],
"paths": {
"/check-cache": {
"post": {
"operationId": "checkCache",
"description": "DEPRECATED: we no longer support prompt caching.",
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"requestedAt": {
"type": "number",
"description": "Unix timestamp in milliseconds"
},
"reqPayload": {
"description": "JSON-encoded request payload"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Extra tags to attach to the call for filtering. Eg { \"userId\": \"123\", \"prompt_id\": \"populate-title\" }",
"default": {}
}
},
"required": [
"requestedAt"
],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"respPayload": {
"description": "JSON-encoded response payload"
}
},
"additionalProperties": false
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"deprecated": true
}
},
"/chat/completions": {
"post": {
"operationId": "createChatCompletion",
"description": "OpenAI-compatible route for generating inference and optionally logging the request.",
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"messages": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"system"
]
},
"content": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"text"
]
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
}
}
],
"default": ""
},
"name": {
"type": "string"
}
},
"required": [
"role"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"user"
]
},
"content": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"text"
]
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image_url"
]
},
"image_url": {
"type": "object",
"properties": {
"detail": {
"anyOf": [
{
"type": "string",
"enum": [
"auto"
]
},
{
"type": "string",
"enum": [
"low"
]
},
{
"type": "string",
"enum": [
"high"
]
}
]
},
"url": {
"type": "string"
}
},
"required": [
"url"
],
"additionalProperties": false
}
},
"required": [
"type",
"image_url"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"input_audio"
]
},
"input_audio": {
"type": "object",
"properties": {
"data": {
"type": "string"
},
"format": {
"type": "string",
"enum": [
"wav",
"mp3"
]
}
},
"required": [
"data",
"format"
],
"additionalProperties": false
}
},
"required": [
"type",
"input_audio"
],
"additionalProperties": false
}
]
}
}
],
"default": ""
},
"name": {
"type": "string"
}
},
"required": [
"role"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"assistant"
]
},
"audio": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"additionalProperties": false,
"nullable": true
},
"content": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"text"
]
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"refusal"
]
},
"refusal": {
"type": "string"
}
},
"required": [
"type",
"refusal"
],
"additionalProperties": false
}
]
}
},
{
"enum": [
"null"
],
"nullable": true
}
],
"default": null
},
"function_call": {
"type": "object",
"properties": {
"name": {
"type": "string",
"default": ""
},
"arguments": {
"type": "string",
"default": ""
}
},
"additionalProperties": false,
"nullable": true
},
"tool_calls": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"function": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"arguments": {
"type": "string"
}
},
"required": [
"name",
"arguments"
],
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"function"
]
}
},
"required": [
"id",
"function",
"type"
],
"additionalProperties": false
},
"nullable": true
},
"name": {
"type": "string"
},
"refusal": {
"type": "string",
"nullable": true
},
"annotations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"url_citation"
]
},
"url_citation": {
"type": "object",
"properties": {
"start_index": {
"type": "number"
},
"end_index": {
"type": "number"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"start_index",
"end_index",
"title",
"url"
],
"additionalProperties": false
}
},
"required": [
"type",
"url_citation"
],
"additionalProperties": false
}
}
},
"required": [
"role"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"developer"
]
},
"content": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"text"
]
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
}
}
],
"default": ""
},
"name": {
"type": "string"
}
},
"required": [
"role"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"tool"
]
},
"content": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"text"
]
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
}
}
],
"default": ""
},
"tool_call_id": {
"type": "string"
}
},
"required": [
"role",
"tool_call_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"function"
]
},
"name": {
"type": "string"
},
"content": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"null"
],
"nullable": true
}
]
}
},
"required": [
"role",
"name",
"content"
],
"additionalProperties": false
}
]
}
},
"model": {
"type": "string"
},
"audio": {
"type": "object",
"properties": {
"format": {
"type": "string",
"enum": [
"wav",
"mp3",
"flac",
"opus",
"pcm16"
]
},
"voice": {
"type": "string",
"enum": [
"alloy",
"ash",
"ballad",
"coral",
"echo",
"sage",
"shimmer",
"verse"
]
}
},
"required": [
"format",
"voice"
],
"additionalProperties": false,
"nullable": true
},
"function_call": {
"anyOf": [
{
"type": "string",
"enum": [
"none"
]
},
{
"type": "string",
"enum": [
"auto"
]
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"additionalProperties": false
}
]
},
"functions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"parameters": {
"type": "object",
"additionalProperties": {}
},
"description": {
"type": "string"
},
"strict": {
"type": "boolean",
"nullable": true
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"tool_choice": {
"anyOf": [
{
"type": "string",
"enum": [
"none"
]
},
{
"type": "string",
"enum": [
"auto"
]
},
{
"type": "string",
"enum": [
"required"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"function"
],
"default": "function"
},
"function": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"additionalProperties": false,
"default": {
"name": ""
}
}
},
"additionalProperties": false
}
]
},
"tools": {
"type": "array",
"items": {
"type": "object",
"properties": {
"function": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"parameters": {
"type": "object",
"additionalProperties": {}
},
"description": {
"type": "string"
},
"strict": {
"type": "boolean",
"nullable": true
}
},
"required": [
"name"
],
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"function"
]
}
},
"required": [
"function",
"type"
],
"additionalProperties": false
}
},
"n": {
"type": "number"
},
"max_tokens": {
"type": "number",
"nullable": true
},
"max_completion_tokens": {
"type": "number",
"nullable": true
},
"temperature": {
"type": "number"
},
"top_p": {
"type": "number",
"nullable": true
# --- truncated at 32 KB (460 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpipe/refs/heads/main/openapi/openpipe-openapi.json