{ "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 }, "presence_penalty": { "type": "number", "nullable": true }, "frequency_penalty": { "type": "number", "nullable": true }, "stop": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "nullable": true }, "response_format": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text" ] } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "json_object" ] } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "json_schema" ] }, "json_schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "schema": { "type": "object", "additionalProperties": {} }, "strict": { "type": "boolean", "nullable": true } }, "required": [ "name" ], "additionalProperties": false } }, "required": [ "type", "json_schema" ], "additionalProperties": false } ] }, "logprobs": { "type": "boolean" }, "top_logprobs": { "type": "number", "nullable": true }, "stream_options": { "type": "object", "properties": { "include_usage": { "type": "boolean" } }, "required": [ "include_usage" ], "additionalProperties": false }, "store": { "type": "boolean" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "stream": { "type": "boolean", "default": false } }, "required": [ "messages", "model" ], "additionalProperties": true } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string", "enum": [ "chat.completion" ] }, "created": { "type": "number" }, "model": { "type": "string" }, "choices": { "type": "array", "items": { "type": "object", "properties": { "finish_reason": { "anyOf": [ { "type": "string", "enum": [ "length" ] }, { "type": "string", "enum": [ "function_call" ] }, { "type": "string", "enum": [ "tool_calls" ] }, { "type": "string", "enum": [ "stop" ] }, { "type": "string", "enum": [ "content_filter" ] } ] }, "index": { "type": "number" }, "message": { "type": "object", "properties": { "reasoning_content": { "type": "string", "nullable": true }, "content": { "type": "string", "nullable": true, "default": null }, "refusal": { "type": "string", "nullable": true }, "role": { "type": "string", "enum": [ "assistant" ] }, "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 } }, "required": [ "role" ], "additionalProperties": false }, "logprobs": { "type": "object", "properties": { "content": { "type": "array", "items": { "type": "object", "properties": { "token": { "type": "string" }, "bytes": { "type": "array", "items": { "type": "number" }, "nullable": true }, "logprob": { "type": "number" }, "top_logprobs": { "type": "array", "items": { "type": "object", "properties": { "token": { "type": "string" }, "bytes": { "type": "array", "items": { "type": "number" }, "nullable": true }, "logprob": { "type": "number" } }, "required": [ "token", "bytes", "logprob" ], "additionalProperties": false } } }, "required": [ "token", "bytes", "logprob", "top_logprobs" ], "additionalProperties": false }, "nullable": true, "default": null }, "refusal": { "type": "array", "items": { "type": "object", "properties": { "token": { "type": "string" }, "bytes": { "type": "array", "items": { "type": "number" }, "nullable": true }, "logprob": { "type": "number" }, "top_logprobs": { "type": "array", "items": { "type": "object", "properties": { "token": { "type": "string" }, "bytes": { "type": "array", "items": { "type": "number" }, "nullable": true }, "logprob": { "type": "number" } }, "required": [ "token", "bytes", "logprob" ], "additionalProperties": false } } }, "required": [ "token", "bytes", "logprob", "top_logprobs" ], "additionalProperties": false }, "nullable": true, "default": null } }, "additionalProperties": false, "nullable": true, "default": null }, "content_filter_results": { "type": "object", "properties": {}, "additionalProperties": true }, "criteria_results": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success" ] }, "score": { "type": "number" }, "explanation": { "type": "string" }, "errorCode": { "type": "number" }, "errorMessage": { "type": "string" } }, "required": [ "status", "score" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "score": { "type": "number" }, "explanation": { "type": "string" }, "errorCode": { "type": "number" }, "errorMessage": { "type": "string" } }, "required": [ "status", "errorCode", "errorMessage" ], "additionalProperties": false } ] } } }, "required": [ "finish_reason", "index", "message" ], "additionalProperties": false } }, "usage": { "type": "object", "properties": { "prompt_tokens": { "type": "number" }, "completion_tokens": { "type": "number" }, "total_tokens": { "type": "number" }, "prompt_cache_hit_tokens": { "type": "number" }, "prompt_cache_miss_tokens": { "type": "number" }, "completion_tokens_details": { "type": "object", "properties": { "reasoning_tokens": { "type": "number", "nullable": true }, "audio_tokens": { "type": "number", "nullable": true }, "text_tokens": { "type": "number", "nullable": true }, "accepted_prediction_tokens": { "type": "number", "nullable": true }, "rejected_prediction_tokens": { "type": "number", "nullable": true } }, "additionalProperties": false, "nullable": true }, "prompt_tokens_details": { "type": "object", "properties": { "cached_tokens": { "type": "number", "nullable": true }, "audio_tokens": { "type": "number", "nullable": true } }, "additionalProperties": false, "nullable": true }, "criteria": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total_tokens": { "type": "number", "description": "The total number of tokens used to generate the criterion judgement. Only returned for OpenPipe-trained reward models currently." } }, "required": [ "total_tokens" ], "additionalProperties": false } } }, "required": [ "prompt_tokens", "completion_tokens", "total_tokens" ], "additionalProperties": false } }, "required": [ "id", "object", "created", "model", "choices" ], "additionalProperties": false, "nullable": true }, {} ] } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/report": { "post": { "operationId": "report", "description": "Record request logs from OpenAI models", "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "requestedAt": { "type": "number", "description": "Unix timestamp in milliseconds" }, "receivedAt": { "type": "number", "description": "Unix timestamp in milliseconds" }, "reqPayload": { "description": "JSON-encoded request payload" }, "respPayload": { "description": "JSON-encoded response payload" }, "statusCode": { "type": "number", "description": "HTTP status code of response" }, "errorMessage": { "type": "string", "description": "User-friendly error message" }, "tags": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, "description": "DEPRECATED: use \"reqPayload.metadata\" to attach extra metadata tags to the call for filtering. Eg { \"userId\": \"123\", \"prompt_id\": \"populate-title\" }", "default": {} } }, "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "anyOf": [ { "type": "string", "enum": [ "ok" ] }, { "type": "string", "enum": [ "error" ] } ] } }, "required": [ "status" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/report-anthropic": { "post": { "operationId": "reportAnthropic", "description": "Record request logs from Anthropic models", "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "requestedAt": { "type": "number", "description": "Unix timestamp in milliseconds" }, "receivedAt": { "type": "number", "description": "Unix timestamp in milliseconds" }, "reqPayload": { "anyOf": [ { "type": "object", "properties": { "max_tokens": { "type": "number" }, "messages": { "type": "array", "items": { "type": "object", "properties": { "content": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "text": { "type": "string" }, "type": { "type": "string", "enum": [ "text" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] }, "citations": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_char_index": { "type": "number" }, "start_char_index": { "type": "number" }, "type": { "type": "string", "enum": [ "char_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_char_index", "start_char_index", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_page_number": { "type": "number" }, "start_page_number": { "type": "number" }, "type": { "type": "string", "enum": [ "page_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_page_number", "start_page_number", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_block_index": { "type": "number" }, "start_block_index": { "type": "number" }, "type": { "type": "string", "enum": [ "content_block_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_block_index", "start_block_index", "type" ], "additionalProperties": false } ] }, "nullable": true } }, "required": [ "text", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "source": { "type": "object", "properties": { "data": { "type": "string" }, "media_type": { "anyOf": [ { "type": "string", "enum": [ "image/jpeg" ] }, { "type": "string", "enum": [ "image/png" ] }, { "type": "string", "enum": [ "image/gif" ] }, { "type": "string", "enum": [ "image/webp" ] } ] }, "type": { "type": "string", "enum": [ "base64" ] } }, "required": [ "data", "media_type", "type" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "image" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "source", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "input": {}, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "tool_use" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "id", "name", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "tool_use_id": { "type": "string" }, "type": { "type": "string", "enum": [ "tool_result" ] }, "content": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "text": { "type": "string" }, "type": { "type": "string", "enum": [ "text" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] }, "citations": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_char_index": { "type": "number" }, "start_char_index": { "type": "number" }, "type": { "type": "string", "enum": [ "char_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_char_index", "start_char_index", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_page_number": { "type": "number" }, "start_page_number": { "type": "number" }, "type": { "type": "string", "enum": [ "page_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_page_number", "start_page_number", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_block_index": { "type": "number" }, "start_block_index": { "type": "number" }, "type": { "type": "string", "enum": [ "content_block_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_block_index", "start_block_index", "type" ], "additionalProperties": false } ] }, "nullable": true } }, "required": [ "text", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "source": { "type": "object", "properties": { "data": { "type": "string" }, "media_type": { "anyOf": [ { "type": "string", "enum": [ "image/jpeg" ] }, { "type": "string", "enum": [ "image/png" ] }, { "type": "string", "enum": [ "image/gif" ] }, { "type": "string", "enum": [ "image/webp" ] } ] }, "type": { "type": "string", "enum": [ "base64" ] } }, "required": [ "data", "media_type", "type" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "image" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "source", "type" ], "additionalProperties": false } ] } } ] }, "is_error": { "type": "boolean" }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "tool_use_id", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "source": { "anyOf": [ { "type": "object", "properties": { "data": { "type": "string" }, "media_type": { "type": "string", "enum": [ "application/pdf" ] }, "type": { "type": "string", "enum": [ "base64" ] } }, "required": [ "data", "media_type", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "data": { "type": "string" }, "media_type": { "type": "string", "enum": [ "text/plain" ] }, "type": { "type": "string", "enum": [ "text" ] } }, "required": [ "data", "media_type", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "content": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "text": { "type": "string" }, "type": { "type": "string", "enum": [ "text" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] }, "citations": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_char_index": { "type": "number" }, "start_char_index": { "type": "number" }, "type": { "type": "string", "enum": [ "char_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_char_index", "start_char_index", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_page_number": { "type": "number" }, "start_page_number": { "type": "number" }, "type": { "type": "string", "enum": [ "page_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_page_number", "start_page_number", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_block_index": { "type": "number" }, "start_block_index": { "type": "number" }, "type": { "type": "string", "enum": [ "content_block_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_block_index", "start_block_index", "type" ], "additionalProperties": false } ] }, "nullable": true } }, "required": [ "text", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "source": { "type": "object", "properties": { "data": { "type": "string" }, "media_type": { "anyOf": [ { "type": "string", "enum": [ "image/jpeg" ] }, { "type": "string", "enum": [ "image/png" ] }, { "type": "string", "enum": [ "image/gif" ] }, { "type": "string", "enum": [ "image/webp" ] } ] }, "type": { "type": "string", "enum": [ "base64" ] } }, "required": [ "data", "media_type", "type" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "image" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "source", "type" ], "additionalProperties": false } ] } } ] }, "type": { "type": "string", "enum": [ "content" ] } }, "required": [ "content", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "url" ] }, "url": { "type": "string" } }, "required": [ "type", "url" ], "additionalProperties": false } ] }, "type": { "type": "string", "enum": [ "document" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] }, "citations": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false }, "context": { "anyOf": [ { "type": "string" }, { "enum": [ "null" ], "nullable": true } ] }, "title": { "anyOf": [ { "type": "string" }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "source", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "thinking": { "type": "string" }, "signature": { "type": "string" }, "type": { "type": "string", "enum": [ "thinking" ] } }, "required": [ "thinking", "signature", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "data": { "type": "string" }, "type": { "type": "string", "enum": [ "redacted_thinking" ] } }, "required": [ "data", "type" ], "additionalProperties": false } ] } } ] }, "role": { "anyOf": [ { "type": "string", "enum": [ "user" ] }, { "type": "string", "enum": [ "assistant" ] } ] } }, "required": [ "content", "role" ], "additionalProperties": false } }, "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "user_id": { "anyOf": [ { "type": "string" }, { "enum": [ "null" ], "nullable": true } ] } }, "additionalProperties": false }, "stop_sequences": { "type": "array", "items": { "type": "string" } }, "stream": { "type": "boolean", "enum": [ true ] }, "system": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "type": { "type": "string", "enum": [ "text" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] }, "citations": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_char_index": { "type": "number" }, "start_char_index": { "type": "number" }, "type": { "type": "string", "enum": [ "char_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_char_index", "start_char_index", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_page_number": { "type": "number" }, "start_page_number": { "type": "number" }, "type": { "type": "string", "enum": [ "page_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_page_number", "start_page_number", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_block_index": { "type": "number" }, "start_block_index": { "type": "number" }, "type": { "type": "string", "enum": [ "content_block_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_block_index", "start_block_index", "type" ], "additionalProperties": false } ] }, "nullable": true } }, "required": [ "text", "type" ], "additionalProperties": false } } ] }, "temperature": { "type": "number" }, "top_k": { "type": "number" }, "top_p": { "type": "number" }, "thinking": { "anyOf": [ { "type": "object", "properties": { "budget_tokens": { "type": "number" }, "type": { "type": "string", "enum": [ "enabled" ] } }, "required": [ "budget_tokens", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "disabled" ] } }, "required": [ "type" ], "additionalProperties": false } ] }, "tool_choice": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "auto" ] }, "disable_parallel_tool_use": { "type": "boolean" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "any" ] }, "disable_parallel_tool_use": { "type": "boolean" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "tool" ] }, "name": { "type": "string" }, "disable_parallel_tool_use": { "type": "boolean" } }, "required": [ "type", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "none" ] } }, "required": [ "type" ], "additionalProperties": false } ] }, "tools": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" }, "input_schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "object" ] }, "properties": {} }, "required": [ "type" ], "additionalProperties": true }, "description": { "type": "string" }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "name", "input_schema" ], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "enum": [ "bash" ] }, "type": { "type": "string", "enum": [ "bash_20250124" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "name", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "enum": [ "str_replace_editor" ] }, "type": { "type": "string", "enum": [ "text_editor_20250124" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "name", "type" ], "additionalProperties": false } ] } } }, "required": [ "max_tokens", "messages", "model", "stream" ], "additionalProperties": true }, { "type": "object", "properties": { "max_tokens": { "type": "number" }, "messages": { "type": "array", "items": { "type": "object", "properties": { "content": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "text": { "type": "string" }, "type": { "type": "string", "enum": [ "text" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] }, "citations": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_char_index": { "type": "number" }, "start_char_index": { "type": "number" }, "type": { "type": "string", "enum": [ "char_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_char_index", "start_char_index", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_page_number": { "type": "number" }, "start_page_number": { "type": "number" }, "type": { "type": "string", "enum": [ "page_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_page_number", "start_page_number", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_block_index": { "type": "number" }, "start_block_index": { "type": "number" }, "type": { "type": "string", "enum": [ "content_block_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_block_index", "start_block_index", "type" ], "additionalProperties": false } ] }, "nullable": true } }, "required": [ "text", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "source": { "type": "object", "properties": { "data": { "type": "string" }, "media_type": { "anyOf": [ { "type": "string", "enum": [ "image/jpeg" ] }, { "type": "string", "enum": [ "image/png" ] }, { "type": "string", "enum": [ "image/gif" ] }, { "type": "string", "enum": [ "image/webp" ] } ] }, "type": { "type": "string", "enum": [ "base64" ] } }, "required": [ "data", "media_type", "type" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "image" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "source", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "input": {}, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "tool_use" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "id", "name", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "tool_use_id": { "type": "string" }, "type": { "type": "string", "enum": [ "tool_result" ] }, "content": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "text": { "type": "string" }, "type": { "type": "string", "enum": [ "text" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] }, "citations": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_char_index": { "type": "number" }, "start_char_index": { "type": "number" }, "type": { "type": "string", "enum": [ "char_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_char_index", "start_char_index", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_page_number": { "type": "number" }, "start_page_number": { "type": "number" }, "type": { "type": "string", "enum": [ "page_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_page_number", "start_page_number", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_block_index": { "type": "number" }, "start_block_index": { "type": "number" }, "type": { "type": "string", "enum": [ "content_block_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_block_index", "start_block_index", "type" ], "additionalProperties": false } ] }, "nullable": true } }, "required": [ "text", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "source": { "type": "object", "properties": { "data": { "type": "string" }, "media_type": { "anyOf": [ { "type": "string", "enum": [ "image/jpeg" ] }, { "type": "string", "enum": [ "image/png" ] }, { "type": "string", "enum": [ "image/gif" ] }, { "type": "string", "enum": [ "image/webp" ] } ] }, "type": { "type": "string", "enum": [ "base64" ] } }, "required": [ "data", "media_type", "type" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "image" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "source", "type" ], "additionalProperties": false } ] } } ] }, "is_error": { "type": "boolean" }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "tool_use_id", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "source": { "anyOf": [ { "type": "object", "properties": { "data": { "type": "string" }, "media_type": { "type": "string", "enum": [ "application/pdf" ] }, "type": { "type": "string", "enum": [ "base64" ] } }, "required": [ "data", "media_type", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "data": { "type": "string" }, "media_type": { "type": "string", "enum": [ "text/plain" ] }, "type": { "type": "string", "enum": [ "text" ] } }, "required": [ "data", "media_type", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "content": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "text": { "type": "string" }, "type": { "type": "string", "enum": [ "text" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] }, "citations": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_char_index": { "type": "number" }, "start_char_index": { "type": "number" }, "type": { "type": "string", "enum": [ "char_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_char_index", "start_char_index", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_page_number": { "type": "number" }, "start_page_number": { "type": "number" }, "type": { "type": "string", "enum": [ "page_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_page_number", "start_page_number", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_block_index": { "type": "number" }, "start_block_index": { "type": "number" }, "type": { "type": "string", "enum": [ "content_block_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_block_index", "start_block_index", "type" ], "additionalProperties": false } ] }, "nullable": true } }, "required": [ "text", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "source": { "type": "object", "properties": { "data": { "type": "string" }, "media_type": { "anyOf": [ { "type": "string", "enum": [ "image/jpeg" ] }, { "type": "string", "enum": [ "image/png" ] }, { "type": "string", "enum": [ "image/gif" ] }, { "type": "string", "enum": [ "image/webp" ] } ] }, "type": { "type": "string", "enum": [ "base64" ] } }, "required": [ "data", "media_type", "type" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "image" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "source", "type" ], "additionalProperties": false } ] } } ] }, "type": { "type": "string", "enum": [ "content" ] } }, "required": [ "content", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "url" ] }, "url": { "type": "string" } }, "required": [ "type", "url" ], "additionalProperties": false } ] }, "type": { "type": "string", "enum": [ "document" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] }, "citations": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false }, "context": { "anyOf": [ { "type": "string" }, { "enum": [ "null" ], "nullable": true } ] }, "title": { "anyOf": [ { "type": "string" }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "source", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "thinking": { "type": "string" }, "signature": { "type": "string" }, "type": { "type": "string", "enum": [ "thinking" ] } }, "required": [ "thinking", "signature", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "data": { "type": "string" }, "type": { "type": "string", "enum": [ "redacted_thinking" ] } }, "required": [ "data", "type" ], "additionalProperties": false } ] } } ] }, "role": { "anyOf": [ { "type": "string", "enum": [ "user" ] }, { "type": "string", "enum": [ "assistant" ] } ] } }, "required": [ "content", "role" ], "additionalProperties": false } }, "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "user_id": { "anyOf": [ { "type": "string" }, { "enum": [ "null" ], "nullable": true } ] } }, "additionalProperties": false }, "stop_sequences": { "type": "array", "items": { "type": "string" } }, "stream": { "type": "boolean", "enum": [ false ], "default": false }, "system": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "type": { "type": "string", "enum": [ "text" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] }, "citations": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_char_index": { "type": "number" }, "start_char_index": { "type": "number" }, "type": { "type": "string", "enum": [ "char_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_char_index", "start_char_index", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_page_number": { "type": "number" }, "start_page_number": { "type": "number" }, "type": { "type": "string", "enum": [ "page_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_page_number", "start_page_number", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_block_index": { "type": "number" }, "start_block_index": { "type": "number" }, "type": { "type": "string", "enum": [ "content_block_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_block_index", "start_block_index", "type" ], "additionalProperties": false } ] }, "nullable": true } }, "required": [ "text", "type" ], "additionalProperties": false } } ] }, "temperature": { "type": "number" }, "top_k": { "type": "number" }, "top_p": { "type": "number" }, "thinking": { "anyOf": [ { "type": "object", "properties": { "budget_tokens": { "type": "number" }, "type": { "type": "string", "enum": [ "enabled" ] } }, "required": [ "budget_tokens", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "disabled" ] } }, "required": [ "type" ], "additionalProperties": false } ] }, "tool_choice": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "auto" ] }, "disable_parallel_tool_use": { "type": "boolean" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "any" ] }, "disable_parallel_tool_use": { "type": "boolean" } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "tool" ] }, "name": { "type": "string" }, "disable_parallel_tool_use": { "type": "boolean" } }, "required": [ "type", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "none" ] } }, "required": [ "type" ], "additionalProperties": false } ] }, "tools": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" }, "input_schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "object" ] }, "properties": {} }, "required": [ "type" ], "additionalProperties": true }, "description": { "type": "string" }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "name", "input_schema" ], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "enum": [ "bash" ] }, "type": { "type": "string", "enum": [ "bash_20250124" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "name", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "enum": [ "str_replace_editor" ] }, "type": { "type": "string", "enum": [ "text_editor_20250124" ] }, "cache_control": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ephemeral" ] } }, "required": [ "type" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "name", "type" ], "additionalProperties": false } ] } } }, "required": [ "max_tokens", "messages", "model" ], "additionalProperties": true } ], "description": "JSON-encoded request payload" }, "respPayload": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "text": { "type": "string" }, "type": { "type": "string", "enum": [ "text" ] }, "citations": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_char_index": { "type": "number" }, "start_char_index": { "type": "number" }, "type": { "type": "string", "enum": [ "char_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_char_index", "start_char_index", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_page_number": { "type": "number" }, "start_page_number": { "type": "number" }, "type": { "type": "string", "enum": [ "page_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_page_number", "start_page_number", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "cited_text": { "type": "string" }, "document_index": { "type": "number" }, "document_title": { "type": "string", "nullable": true }, "end_block_index": { "type": "number" }, "start_block_index": { "type": "number" }, "type": { "type": "string", "enum": [ "content_block_location" ] } }, "required": [ "cited_text", "document_index", "document_title", "end_block_index", "start_block_index", "type" ], "additionalProperties": false } ] }, "nullable": true, "default": null } }, "required": [ "text", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "tool_use" ] }, "input": {} }, "required": [ "id", "name", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "thinking": { "type": "string" }, "signature": { "type": "string" }, "type": { "type": "string", "enum": [ "thinking" ] } }, "required": [ "thinking", "signature", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "data": { "type": "string" }, "type": { "type": "string", "enum": [ "redacted_thinking" ] } }, "required": [ "data", "type" ], "additionalProperties": false } ] } }, "model": { "type": "string" }, "role": { "type": "string", "enum": [ "assistant" ] }, "stop_reason": { "anyOf": [ { "type": "string", "enum": [ "end_turn" ] }, { "type": "string", "enum": [ "max_tokens" ] }, { "type": "string", "enum": [ "stop_sequence" ] }, { "type": "string", "enum": [ "tool_use" ] }, { "enum": [ "null" ], "nullable": true } ] }, "stop_sequence": { "anyOf": [ { "type": "string" }, { "enum": [ "null" ], "nullable": true } ] }, "type": { "type": "string", "enum": [ "message" ] }, "usage": { "type": "object", "properties": { "input_tokens": { "type": "number" }, "output_tokens": { "type": "number" }, "cache_creation_input_tokens": { "type": "number", "nullable": true }, "cache_read_input_tokens": { "type": "number", "nullable": true } }, "required": [ "input_tokens", "output_tokens", "cache_creation_input_tokens", "cache_read_input_tokens" ], "additionalProperties": false } }, "required": [ "id", "content", "model", "role", "stop_reason", "stop_sequence", "type", "usage" ], "additionalProperties": false, "description": "JSON-encoded response payload" }, "statusCode": { "type": "number", "description": "HTTP status code of response" }, "errorMessage": { "type": "string", "description": "User-friendly error message" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Extra metadata tags to attach to the call for filtering. Eg { \"userId\": \"123\", \"prompt_id\": \"populate-title\" }", "default": {} }, "tags": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, "description": "Deprecated: use \"metadata\" instead", "default": {} } }, "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "anyOf": [ { "type": "string", "enum": [ "ok" ] }, { "type": "string", "enum": [ "error" ] } ] } }, "required": [ "status" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/logs/update-tags": { "post": { "operationId": "updateLogTags", "description": "DEPRECATED: use \"/logs/update-metadata\" instead", "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "The field to filter on. Possible fields include: `model`, `completionId`, and `tags.your_tag_name`." }, "equals": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "equals" ], "additionalProperties": false } }, "tags": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "enum": [ "null" ], "nullable": true } ] }, "description": "Extra tags to attach to the call for filtering. Eg { \"userId\": \"123\", \"prompt_id\": \"populate-title\" }" } }, "required": [ "filters", "tags" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "matchedLogs": { "type": "number" } }, "required": [ "matchedLogs" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } }, "deprecated": true } }, "/logs/update-metadata": { "post": { "operationId": "updateLogMetadata", "description": "Update tags metadata for logged calls matching the provided filters.", "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "The field to filter on. Possible fields include: `model`, `completionId`, and `metadata.your_tag_name`." }, "equals": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "field", "equals" ], "additionalProperties": false } }, "metadata": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "enum": [ "null" ], "nullable": true } ] }, "description": "Extra metadata to attach to the call for filtering. Eg { \"userId\": \"123\", \"prompt_id\": \"populate-title\" }" } }, "required": [ "filters", "metadata" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "matchedLogs": { "type": "number" } }, "required": [ "matchedLogs" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/local-testing-only-get-latest-logged-call": { "get": { "operationId": "localTestingOnlyGetLatestLoggedCall", "description": "Get the latest logged call (only for local testing)", "security": [ { "Authorization": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "cacheHit": { "type": "boolean" }, "statusCode": { "type": "number", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "reqPayload": {}, "respPayload": {}, "tags": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } } }, "required": [ "createdAt", "cacheHit", "statusCode", "errorMessage", "tags", "metadata" ], "additionalProperties": false, "nullable": true } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/criteria/judge": { "post": { "operationId": "getCriterionJudgement", "description": "Get a judgement of a completion against the specified criterion", "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "criterion_id": { "type": "string", "description": "The ID of the criterion to judge." }, "input": { "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 } ] }, "description": "All messages sent to the model when generating the output." }, "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 } ], "description": "The tool choice to use when generating the output, if any." }, "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 }, "description": "The tools available to the model when generating the output, if any." } }, "required": [ "messages" ], "additionalProperties": false }, "output": { "type": "object", "properties": { "reasoning_content": { "type": "string", "nullable": true }, "content": { "type": "string", "nullable": true, "default": null }, "refusal": { "type": "string", "nullable": true }, "role": { "type": "string", "enum": [ "assistant" ] }, "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 } }, "required": [ "role" ], "additionalProperties": false, "description": "The completion message of the model." } }, "required": [ "criterion_id", "output" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "score": { "type": "number", "description": "A score of 0 means the output failed this completion, and a score of 1 means it passed. A criteria may also return a decimal scores between 0 and 1, indicating the model's confidence or 'likelihood' that the criteria passed." }, "explanation": { "type": "string", "description": "An explanation of the score including the model's reasoning, if applicable." }, "usage": { "type": "object", "properties": { "total_tokens": { "type": "number", "description": "The total number of tokens used to generate the criterion judgement. Only returned for OpenPipe-trained reward models currently." } }, "required": [ "total_tokens" ], "additionalProperties": false } }, "required": [ "score" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/datasets": { "post": { "operationId": "createDataset", "description": "Create a new dataset.", "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "dataset" ] }, "id": { "type": "string" }, "name": { "type": "string" }, "created": { "type": "string" }, "updated": { "type": "string" }, "dataset_entry_count": { "type": "number" }, "fine_tune_count": { "type": "number" } }, "required": [ "object", "id", "name", "created", "updated", "dataset_entry_count", "fine_tune_count" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } }, "get": { "operationId": "listDatasets", "description": "List datasets for a project.", "security": [ { "Authorization": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "dataset" ] }, "id": { "type": "string" }, "name": { "type": "string" }, "created": { "type": "string" }, "updated": { "type": "string" }, "dataset_entry_count": { "type": "number" }, "fine_tune_count": { "type": "number" } }, "required": [ "object", "id", "name", "created", "updated", "dataset_entry_count", "fine_tune_count" ], "additionalProperties": false } } }, "required": [ "object", "data" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/datasets/{datasetId}": { "delete": { "operationId": "deleteDataset", "description": "Delete a dataset.", "security": [ { "Authorization": [] } ], "parameters": [ { "name": "datasetId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string", "enum": [ "dataset" ] }, "deleted": { "type": "boolean" } }, "required": [ "id", "object", "deleted" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/datasets/{datasetId}/entries": { "post": { "operationId": "createDatasetEntries", "description": "Add new dataset entries.", "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entries": { "type": "array", "items": { "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 } ] } }, "rejected_message": { "type": "object", "properties": { "reasoning_content": { "type": "string", "nullable": true }, "content": { "type": "string", "nullable": true, "default": null }, "refusal": { "type": "string", "nullable": true }, "role": { "type": "string", "enum": [ "assistant" ] }, "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 } }, "required": [ "role" ], "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 } }, "response_format": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text" ] } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "json_object" ] } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "json_schema" ] }, "json_schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "schema": { "type": "object", "additionalProperties": {} }, "strict": { "type": "boolean", "nullable": true } }, "required": [ "name" ], "additionalProperties": false } }, "required": [ "type", "json_schema" ], "additionalProperties": false } ] }, "split": { "type": "string", "enum": [ "TRAIN", "TEST" ] }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "messages" ], "additionalProperties": false }, "minItems": 1, "maxItems": 100 } }, "required": [ "entries" ], "additionalProperties": false } } } }, "parameters": [ { "name": "datasetId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "dataset.entries.creation" ] }, "entries_created": { "type": "number" }, "errors": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "dataset.entries.creation.error" ] }, "entry_index": { "type": "number" }, "message": { "type": "string" } }, "required": [ "object", "entry_index", "message" ], "additionalProperties": false } } }, "required": [ "object", "data" ], "additionalProperties": false } }, "required": [ "object", "entries_created", "errors" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/models": { "post": { "operationId": "createModel", "description": "Train a new model.", "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "datasetId": { "type": "string" }, "slug": { "type": "string" }, "pruningRuleIds": { "type": "array", "items": { "type": "string" }, "default": [] }, "trainingConfig": { "anyOf": [ { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "openpipe" ] }, "baseModel": { "type": "string", "description": "The base model to train from. This could be a base model name or the slug of a previously trained model. Supported base models include: `meta-llama/Meta-Llama-3.1-8B-Instruct`, `meta-llama/Meta-Llama-3.1-70B-Instruct`, `meta-llama/Llama-3.3-70B-Instruct`, `meta-llama/Llama-3.1-8B`, `meta-llama/Llama-3.1-70B`, `Qwen/Qwen2.5-72B-Instruct`, `Qwen/Qwen2.5-Coder-7B-Instruct`, `Qwen/Qwen2.5-Coder-32B-Instruct`, `Qwen/Qwen2.5-1.5B-Instruct`, `Qwen/Qwen2.5-7B-Instruct`, `Qwen/Qwen2-VL-7B-Instruct`, `Qwen/Qwen2.5-14B-Instruct`, `Qwen/Qwen3-8B`, `Qwen/Qwen3-14B`, `mistralai/Mistral-Nemo-Base-2407`, `mistralai/Mistral-Small-24B-Base-2501`, `meta-llama/Llama-3.2-1B-Instruct`, `meta-llama/Llama-3.2-3B-Instruct`, `google/gemma-3-1b-it`, `google/gemma-3-4b-it`, `google/gemma-3-12b-it`, `google/gemma-3-27b-it`" }, "enable_sft": { "type": "boolean", "default": true, "description": "Whether to enable SFT training. If true, the model will be trained using SFT. Can be used in conjunction with DPO training." }, "enable_preference_tuning": { "type": "boolean", "description": "Whether to enable DPO training. If true, the model will be trained using DPO. Can be used in conjunction with SFT training.", "default": false }, "sft_hyperparameters": { "type": "object", "properties": { "batch_size": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "number" } ] }, "learning_rate_multiplier": { "type": "number" }, "num_epochs": { "type": "number" } }, "additionalProperties": false, "default": {}, "description": "Hyperparameters for SFT training job. Ensure `enable_sft` is true. If no SFT hyperparameters are provided, default values will be used." }, "preference_hyperparameters": { "type": "object", "properties": { "variant": { "anyOf": [ { "type": "string", "enum": [ "DPO" ] }, { "type": "string", "enum": [ "APO Zero" ] } ] }, "learning_rate_multiplier": { "type": "number" }, "num_epochs": { "type": "number" }, "training_beta": { "type": "number" }, "adapter_weight": { "type": "number" } }, "additionalProperties": false, "default": {}, "description": "Hyperparameters for DPO training job. Ensure `enable_preference_tuning` is true. If no preference hyperparameters are provided, default values will be used." }, "hyperparameters": { "type": "object", "properties": { "is_sft_enabled": { "type": "boolean", "default": true }, "batch_size": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "number" } ] }, "learning_rate_multiplier": { "type": "number" }, "num_epochs": { "type": "number" }, "is_preference_tuning_enabled": { "type": "boolean" }, "preference_tuning_variant": { "anyOf": [ { "type": "string", "enum": [ "DPO" ] }, { "type": "string", "enum": [ "APO Zero" ] } ] }, "preference_tuning_learning_rate_multiplier": { "type": "number" }, "preference_tuning_num_epochs": { "type": "number" }, "preference_tuning_training_beta": { "type": "number" }, "preference_tuning_adapter_weight": { "type": "number" } }, "additionalProperties": false, "description": "DEPRECATED: Use the `sft_hyperparameters` and `preference_hyperparameters` fields instead." } }, "required": [ "provider", "baseModel" ], "additionalProperties": false }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "openpipeReward" ] }, "baseModel": { "type": "string", "description": "The base model to train from. This could be a base model name or the slug of a previously trained model. Supported base models include: `meta-llama/Llama-3.2-1B-Instruct`, `meta-llama/Llama-3.2-3B-Instruct`, `meta-llama/Meta-Llama-3.1-8B-Instruct`, `Qwen/Qwen2.5-0.5B-Instruct`, `Qwen/Qwen2.5-1.5B-Instruct`, `Qwen/Qwen2.5-3B-Instruct`, `Qwen/Qwen2.5-7B-Instruct`, `Qwen/Qwen3-8B`" }, "hyperparameters": { "type": "object", "properties": { "batch_size": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "number" } ] }, "learning_rate_multiplier": { "type": "number" }, "num_epochs": { "type": "number" } }, "additionalProperties": false, "default": {} } }, "required": [ "provider", "baseModel" ], "additionalProperties": false }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "openai" ] }, "baseModel": { "type": "string", "enum": [ "gpt-4.1-2025-04-14", "gpt-4.1-mini-2025-04-14", "gpt-4o-mini-2024-07-18", "gpt-4o-2024-08-06", "gpt-3.5-turbo-0125" ] }, "enable_sft": { "type": "boolean", "default": true, "description": "Whether to enable SFT training. If true, the model will be trained using SFT. Can be used in conjunction with DPO training." }, "enable_preference_tuning": { "type": "boolean", "description": "Whether to enable DPO training. If true, the model will be trained using DPO. Can be used in conjunction with SFT training.", "default": false }, "sft_hyperparameters": { "type": "object", "properties": { "batch_size": { "type": "number" }, "learning_rate_multiplier": { "type": "number" }, "n_epochs": { "type": "number" } }, "additionalProperties": false, "default": {}, "description": "Hyperparameters for SFT training job. Ensure `enable_sft` is true. If no SFT hyperparameters are provided, default values will be used." }, "preference_hyperparameters": { "type": "object", "properties": { "beta": { "type": "number" }, "batch_size": { "type": "number" }, "learning_rate_multiplier": { "type": "number" }, "n_epochs": { "type": "number" } }, "additionalProperties": false, "default": {}, "description": "Hyperparameters for DPO training job. Ensure `enable_preference_tuning` is true. If no preference hyperparameters are provided, default values will be used." }, "hyperparameters": { "type": "object", "properties": { "is_sft_enabled": { "type": "boolean", "default": true }, "batch_size": { "type": "number" }, "learning_rate_multiplier": { "type": "number" }, "n_epochs": { "type": "number" }, "is_preference_tuning_enabled": { "type": "boolean" }, "preference_tuning_beta": { "type": "number" }, "preference_tuning_batch_size": { "type": "number" }, "preference_tuning_learning_rate_multiplier": { "type": "number" }, "preference_tuning_n_epochs": { "type": "number" } }, "additionalProperties": false, "description": "DEPRECATED: Use the `sft_hyperparameters` and `preference_hyperparameters` fields instead." } }, "required": [ "provider", "baseModel" ], "additionalProperties": false }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "gemini" ] }, "baseModel": { "type": "string", "enum": [ "models/gemini-1.0-pro-001", "models/gemini-1.5-flash-001-tuning" ] }, "sft_hyperparameters": { "type": "object", "properties": { "epochs": { "type": "number" }, "batch_size": { "type": "number" }, "learning_rate": { "type": "number" }, "learning_rate_multiplier": { "type": "number" } }, "additionalProperties": false, "default": {}, "description": "Hyperparameters for SFT training job. If no SFT hyperparameters are provided, default values will be used." }, "hyperparameters": { "type": "object", "properties": { "epochs": { "type": "number" }, "batch_size": { "type": "number" }, "learning_rate": { "type": "number" }, "learning_rate_multiplier": { "type": "number" } }, "additionalProperties": false, "description": "DEPRECATED: Use the `sft_hyperparameters` field instead." } }, "required": [ "provider", "baseModel" ], "additionalProperties": false } ] }, "defaultTemperature": { "type": "number" } }, "required": [ "datasetId", "slug", "trainingConfig" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "object": { "type": "string", "enum": [ "model" ] }, "description": { "type": "string", "nullable": true }, "created": { "type": "string" }, "updated": { "type": "string" }, "openpipe": { "type": "object", "properties": { "baseModel": { "type": "string" }, "hyperparameters": { "type": "object", "additionalProperties": {}, "nullable": true }, "status": { "type": "string", "enum": [ "PENDING", "TRAINING", "DEPLOYED", "ERROR", "DEPRECATED", "PENDING_DEPRECATION", "QUEUED", "PROVISIONING" ] }, "datasetId": { "type": "string" }, "errorMessage": { "type": "string", "nullable": true } }, "required": [ "baseModel", "hyperparameters", "status", "datasetId", "errorMessage" ], "additionalProperties": false }, "contextWindow": { "type": "number" }, "maxCompletionTokens": { "type": "number" }, "capabilities": { "type": "array", "items": { "type": "string", "enum": [ "chat", "tools", "json" ] } }, "pricing": { "type": "object", "properties": { "chatIn": { "type": "number", "description": "$/million tokens" }, "chatOut": { "type": "number", "description": "$/million tokens" } }, "required": [ "chatIn", "chatOut" ], "additionalProperties": false }, "owned_by": { "type": "string" } }, "required": [ "id", "name", "object", "description", "created", "updated", "openpipe", "contextWindow", "maxCompletionTokens", "capabilities", "pricing", "owned_by" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } }, "get": { "operationId": "listModels", "description": "List all models for a project.", "security": [ { "Authorization": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "object": { "type": "string", "enum": [ "model" ] }, "description": { "type": "string", "nullable": true }, "created": { "type": "string" }, "updated": { "type": "string" }, "openpipe": { "type": "object", "properties": { "baseModel": { "type": "string" }, "hyperparameters": { "type": "object", "additionalProperties": {}, "nullable": true }, "status": { "type": "string", "enum": [ "PENDING", "TRAINING", "DEPLOYED", "ERROR", "DEPRECATED", "PENDING_DEPRECATION", "QUEUED", "PROVISIONING" ] }, "datasetId": { "type": "string" }, "errorMessage": { "type": "string", "nullable": true } }, "required": [ "baseModel", "hyperparameters", "status", "datasetId", "errorMessage" ], "additionalProperties": false }, "contextWindow": { "type": "number" }, "maxCompletionTokens": { "type": "number" }, "capabilities": { "type": "array", "items": { "type": "string", "enum": [ "chat", "tools", "json" ] } }, "pricing": { "type": "object", "properties": { "chatIn": { "type": "number", "description": "$/million tokens" }, "chatOut": { "type": "number", "description": "$/million tokens" } }, "required": [ "chatIn", "chatOut" ], "additionalProperties": false }, "owned_by": { "type": "string" } }, "required": [ "id", "name", "object", "description", "created", "updated", "openpipe", "contextWindow", "maxCompletionTokens", "capabilities", "pricing", "owned_by" ], "additionalProperties": false } } }, "required": [ "object", "data" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/models/{modelSlug}": { "get": { "operationId": "getModel", "description": "Get a model by ID.", "security": [ { "Authorization": [] } ], "parameters": [ { "name": "modelSlug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "object": { "type": "string", "enum": [ "model" ] }, "description": { "type": "string", "nullable": true }, "created": { "type": "string" }, "updated": { "type": "string" }, "openpipe": { "type": "object", "properties": { "baseModel": { "type": "string" }, "hyperparameters": { "type": "object", "additionalProperties": {}, "nullable": true }, "status": { "type": "string", "enum": [ "PENDING", "TRAINING", "DEPLOYED", "ERROR", "DEPRECATED", "PENDING_DEPRECATION", "QUEUED", "PROVISIONING" ] }, "datasetId": { "type": "string" }, "errorMessage": { "type": "string", "nullable": true } }, "required": [ "baseModel", "hyperparameters", "status", "datasetId", "errorMessage" ], "additionalProperties": false }, "contextWindow": { "type": "number" }, "maxCompletionTokens": { "type": "number" }, "capabilities": { "type": "array", "items": { "type": "string", "enum": [ "chat", "tools", "json" ] } }, "pricing": { "type": "object", "properties": { "chatIn": { "type": "number", "description": "$/million tokens" }, "chatOut": { "type": "number", "description": "$/million tokens" } }, "required": [ "chatIn", "chatOut" ], "additionalProperties": false }, "owned_by": { "type": "string" } }, "required": [ "id", "name", "object", "description", "created", "updated", "openpipe", "contextWindow", "maxCompletionTokens", "capabilities", "pricing", "owned_by" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } }, "delete": { "operationId": "deleteModel", "description": "Delete an existing model.", "security": [ { "Authorization": [] } ], "parameters": [ { "name": "modelSlug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string", "enum": [ "model" ] }, "deleted": { "type": "boolean" } }, "required": [ "id", "object", "deleted" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/unstable/dataset/create": { "post": { "operationId": "unstableDatasetCreate", "description": "DEPRECATED: use the `/datasets` endpoint instead", "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "datasetId": { "type": "string" } }, "required": [ "datasetId" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } }, "deprecated": true } }, "/unstable/dataset/delete": { "post": { "operationId": "unstableDatasetDelete", "description": "DEPRECATED: use the `/datasets/{dataset}` endpoint instead", "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "datasetId": { "type": "string" } }, "required": [ "datasetId" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "datasetId": { "type": "string" } }, "required": [ "datasetId" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } }, "deprecated": true } }, "/unstable/dataset/list": { "get": { "operationId": "unstableDatasetList", "description": "DEPRECATED: use the `/datasets` endpoint instead", "security": [ { "Authorization": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "datasetEntryCount": { "type": "number" }, "fineTuneCount": { "type": "number" } }, "required": [ "id", "name", "createdAt", "updatedAt", "datasetEntryCount", "fineTuneCount" ], "additionalProperties": false } } } } }, "default": { "$ref": "#/components/responses/error" } }, "deprecated": true } }, "/unstable/dataset-entry/create": { "post": { "operationId": "unstableDatasetEntryCreate", "description": "DEPRECATED: use the `/datasets/{dataset}/entries` endpoint instead", "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "datasetId": { "type": "string" }, "entries": { "type": "array", "items": { "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 } ] } }, "rejected_message": { "type": "object", "properties": { "reasoning_content": { "type": "string", "nullable": true }, "content": { "type": "string", "nullable": true, "default": null }, "refusal": { "type": "string", "nullable": true }, "role": { "type": "string", "enum": [ "assistant" ] }, "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 } }, "required": [ "role" ], "additionalProperties": false }, "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 } }, "response_format": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text" ] } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "json_object" ] } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "json_schema" ] }, "json_schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "schema": { "type": "object", "additionalProperties": {} }, "strict": { "type": "boolean", "nullable": true } }, "required": [ "name" ], "additionalProperties": false } }, "required": [ "type", "json_schema" ], "additionalProperties": false } ] }, "split": { "type": "string", "enum": [ "TRAIN", "TEST" ] }, "judgement": { "type": "string", "enum": [ "PASS", "FAIL" ] }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "messages" ], "additionalProperties": false }, "minItems": 1, "maxItems": 100 } }, "required": [ "datasetId", "entries" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "createdEntries": { "type": "number" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "message": { "type": "string" } }, "required": [ "index", "message" ], "additionalProperties": false } } }, "required": [ "createdEntries", "errors" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } }, "deprecated": true } }, "/unstable/finetune/create": { "post": { "operationId": "unstableFinetuneCreate", "description": "DEPRECATED", "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "datasetId": { "type": "string" }, "slug": { "type": "string" }, "baseModel": { "type": "string", "description": "The base model to fine-tune from. Supported models include: meta-llama/Meta-Llama-3.1-8B-Instruct, meta-llama/Meta-Llama-3.1-70B-Instruct" }, "overrides": { "type": "object", "properties": { "is_sft_enabled": { "type": "boolean", "default": true }, "batch_size": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "number" } ] }, "learning_rate_multiplier": { "type": "number" }, "num_epochs": { "type": "number" }, "is_preference_tuning_enabled": { "type": "boolean" }, "preference_tuning_variant": { "anyOf": [ { "type": "string", "enum": [ "DPO" ] }, { "type": "string", "enum": [ "APO Zero" ] } ] }, "preference_tuning_learning_rate_multiplier": { "type": "number" }, "preference_tuning_num_epochs": { "type": "number" }, "preference_tuning_training_beta": { "type": "number" }, "preference_tuning_adapter_weight": { "type": "number" } }, "additionalProperties": false, "default": {} } }, "required": [ "datasetId", "slug", "baseModel" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } }, "deprecated": true } }, "/unstable/finetune/get": { "get": { "operationId": "unstableFinetuneGet", "description": "DEPRECATED: use the `/models/{model}` endpoint instead", "security": [ { "Authorization": [] } ], "parameters": [ { "name": "id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "slug", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "anyOf": [ { "type": "string", "enum": [ "PENDING" ] }, { "type": "string", "enum": [ "STARTED" ] }, { "type": "string", "enum": [ "TRANSFERRING_TRAINING_DATA" ] }, { "type": "string", "enum": [ "TRAINING" ] }, { "type": "string", "enum": [ "DEPLOYING" ] }, { "type": "string", "enum": [ "DEPLOYED" ] }, { "type": "string", "enum": [ "ERROR" ] }, { "type": "string", "enum": [ "DEPRECATED" ] }, { "type": "string", "enum": [ "PENDING_DEPRECATION" ] }, { "type": "string", "enum": [ "QUEUED" ] }, { "type": "string", "enum": [ "PROVISIONING" ] } ] }, "slug": { "type": "string" }, "baseModel": { "type": "string" }, "errorMessage": { "type": "string", "nullable": true }, "datasetId": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "status", "slug", "baseModel", "errorMessage", "datasetId", "createdAt" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } }, "deprecated": true } }, "/unstable/finetune/delete": { "post": { "operationId": "unstableFinetuneDelete", "description": "DEPRECATED: use the `/models/{model}` endpoint instead", "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" } }, "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "string" } }, "required": [ "deleted" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } }, "deprecated": true } } }, "components": { "securitySchemes": { "Authorization": { "type": "http", "scheme": "bearer" } }, "responses": { "error": { "description": "Error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } } }, "required": [ "message", "code" ], "additionalProperties": false } } } } } } }