> ## Documentation Index
> Fetch the complete documentation index at: https://docs.endprompt.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Endpoints Overview

> Understanding endpoints and how they work

Endpoints are the foundation of Endprompt. They provide stable API URLs that your applications call, while giving you complete flexibility to change the underlying prompts and models.

## 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

```
POST https://yourcompany.api.endprompt.ai/api/v1/summarize
     └────────────────────────────────┘ └──────────────┘
              Your tenant domain           Endpoint path
```

## Why Endpoints Matter

<CardGroup cols={2}>
  <Card title="Stable Integration" icon="link">
    Your application code calls the same URL forever. Change prompts without deployments.
  </Card>

  <Card title="Schema Validation" icon="shield-check">
    Invalid requests are rejected before hitting the LLM, saving costs and preventing errors.
  </Card>

  <Card title="Multiple Prompts" icon="layer-group">
    Attach multiple prompts to one endpoint. A/B test, version, and rollback independently.
  </Card>

  <Card title="Auto-Generated Docs" icon="book">
    Every endpoint gets OpenAPI documentation with code samples automatically.
  </Card>
</CardGroup>

## 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

<Steps>
  <Step title="Create">
    Define the endpoint with a name, path, and description.
  </Step>

  <Step title="Configure Schema">
    Add input fields with types and validation rules. Optionally define output schema.
  </Step>

  <Step title="Attach Prompts">
    Create one or more prompts with different models or approaches.
  </Step>

  <Step title="Test">
    Use the built-in test runner to validate your prompts work correctly.
  </Step>

  <Step title="Set Default">
    Promote a prompt to Live status and set it as the endpoint default.
  </Step>

  <Step title="Deploy">
    Your endpoint is ready! Call it from your application.
  </Step>
</Steps>

## Organizing Endpoints

### Categories

Group related endpoints with categories:

* `Content` — Summarization, rewriting, translation
* `Analysis` — Sentiment, classification, extraction
* `Generation` — Creative writing, code generation
* `Conversation` — Chatbots, Q\&A systems

<Tip>
  Create categories that match your product domains. You can filter and search by category in the endpoints list.
</Tip>

### 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

## Next Steps

<CardGroup cols={2}>
  <Card title="Create an Endpoint" icon="plus" href="/endpoints/create-endpoint">
    Step-by-step guide to creating your first endpoint
  </Card>

  <Card title="Define Input Schema" icon="brackets-curly" href="/endpoints/input-schema">
    Learn to specify what data your endpoint accepts
  </Card>
</CardGroup>