What is an Endpoint?
An endpoint is a stable API contract that defines:- URL Path — Where your API lives (e.g.,
/api/v1/summarize) - Input Schema — What data your API accepts
- Output Schema — What data your API returns
- Default Prompt — Which prompt handles requests
Why Endpoints Matter
Stable Integration
Your application code calls the same URL forever. Change prompts without deployments.
Schema Validation
Invalid requests are rejected before hitting the LLM, saving costs and preventing errors.
Multiple Prompts
Attach multiple prompts to one endpoint. A/B test, version, and rollback independently.
Auto-Generated Docs
Every endpoint gets OpenAPI documentation with code samples automatically.
Endpoint Properties
Endpoint Lifecycle
1
Create
Define the endpoint with a name, path, and description.
2
Configure Schema
Add input fields with types and validation rules. Optionally define output schema.
3
Attach Prompts
Create one or more prompts with different models or approaches.
4
Test
Use the built-in test runner to validate your prompts work correctly.
5
Set Default
Promote a prompt to Live status and set it as the endpoint default.
6
Deploy
Your endpoint is ready! Call it from your application.
Organizing Endpoints
Categories
Group related endpoints with categories:Content— Summarization, rewriting, translationAnalysis— Sentiment, classification, extractionGeneration— Creative writing, code generationConversation— Chatbots, Q&A systems
Naming Conventions
We recommend these patterns:Viewing Endpoints
The Endpoints page shows all your endpoints in a list or grid view:- Search — Find endpoints by name or path
- Filter by Category — Show only specific categories
- Sort — By name, creation date, or recent activity
- Quick Stats — See request counts and success rates at a glance
Next Steps
Create an Endpoint
Step-by-step guide to creating your first endpoint
Define Input Schema
Learn to specify what data your endpoint accepts

