API Reference Overview
Detailed reference for all Proxed.AI API endpoints, including authentication, request/response formats, and examples.
API Reference Overview
Welcome to the Proxed.AI API reference documentation. These pages provide detailed information about each available API endpoint, including how to authenticate, structure your requests, and interpret responses.
All API endpoints are versioned under /v1/.
Authentication
All API endpoints (except for /health) require authentication. Please refer to our API Authentication guide for detailed information on how to authenticate your requests.
Error Handling
Consistent error responses are provided across the API. See the API Errors guide for a comprehensive list of error codes and how to handle them.
Available Endpoints
Select an endpoint from the navigation sidebar to view its specific documentation, including:
- Structured Vision Analysis:
/v1/vision - Structured Text Analysis:
/v1/text - Structured PDF Analysis:
/v1/pdf - OpenAI Proxy:
/v1/openai/{projectId}/* - Anthropic Proxy:
/v1/anthropic/{projectId}/*
API Errors
Find comprehensive documentation of Proxed API error codes and messages. Understand HTTP status codes, error response formats, and troubleshooting steps for authentication, validation, rate limiting, and server-side errors.
Vision Analysis API
API reference for performing structured vision analysis using the /v1/vision endpoint. Submit images and receive schema-defined JSON outputs.