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
| Property | Description |
|---|---|
| Name | Human-readable name (e.g., “Text Summarizer”) |
| Path | API URL path, must start with /api/v1/ |
| Category | Organizational grouping (e.g., “Content”, “Analysis”) |
| Description | What the endpoint does |
| Visibility | Public (visible to all team members) or Internal |
| Default Prompt | The prompt used when no specific prompt is requested |
Endpoint Lifecycle
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:| Pattern | Example | Use Case |
|---|---|---|
Resource + Action | text-summarizer | Single-purpose endpoints |
Domain / Action | support/classify-ticket | Domain-specific endpoints |
Version prefix | v2/enhanced-summary | When you need breaking changes |
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

