Create an Endpoint

This guide walks you through creating a new endpoint from scratch.

Before You Start

Think about:

What will this endpoint do? — Summarize text? Classify content? Generate responses?
What inputs does it need? — Text, numbers, options, files?
What outputs should it return? — Structured JSON? Simple text?

Creating the Endpoint

Navigate to Endpoints

Click Endpoints in the sidebar to open the endpoints list.

Click Create

Click the Create Endpoint button in the top-right corner.

Fill in Basic Details

Complete the form:

Field	Description	Example
Name	Human-readable name	`Email Subject Generator`
Path	API URL path (must be unique)	`/api/v1/generate-subject`
Category	Organizational group	`Email`
Description	What this endpoint does	`Generates compelling email subject lines from email body content`

Set Visibility

Choose who can see this endpoint:

Public — All team members can view and use
Internal — Only visible to you and admins

Save

Click Create to save your endpoint.

Path Requirements

Your endpoint path must follow these rules:

Must start with /api/v1/

All paths begin with /api/v1/ for consistency and future versioning.✅ /api/v1/summarize
❌ /summarize

Must be unique

No two endpoints can have the same path within your tenant.

Use lowercase and hyphens

Paths should be lowercase with hyphens separating words.✅ /api/v1/generate-subject
❌ /api/v1/GenerateSubject

Keep it short and descriptive

Good paths describe what the endpoint does.✅ /api/v1/classify-sentiment
❌ /api/v1/do-the-thing

After Creation

Once created, you’ll land on the endpoint detail page. From here you should:

Define Input Schema — Specify what data your endpoint accepts
Define Output Schema (optional) — Specify the response structure
Create a Prompt — Write the LLM instruction
Test — Verify everything works
Set Default — Promote and set the default prompt

An endpoint without a default prompt will return an error when called. Make sure to create and set a default prompt before using it in production.

Example: Building a Sentiment Analyzer

Let’s create a complete endpoint for sentiment analysis:

Step 1: Basic Details

Field	Value
Name	`Sentiment Analyzer`
Path	`/api/v1/analyze-sentiment`
Category	`Analysis`
Description	`Analyzes text and returns sentiment (positive, negative, neutral) with confidence score`

Step 2: Input Schema

Add one required field:

Field	Type	Required	Description
`text`	String	Yes	The text to analyze

Step 3: Output Schema

Define the expected response:

Field	Type	Description
`sentiment`	String	One of: positive, negative, neutral
`confidence`	Number	Confidence score between 0 and 1
`explanation`	String	Brief explanation of the classification

Step 4: Create Prompt

Analyze the sentiment of the following text and classify it as positive, negative, or neutral.

Text to analyze:
{{ inputs.text }}

Respond with a JSON object containing:
- sentiment: "positive", "negative", or "neutral"
- confidence: a number between 0 and 1 indicating your confidence
- explanation: a brief explanation of why you chose this classification

Be accurate and objective in your analysis.

Duplicating Endpoints

Need a similar endpoint? You can duplicate an existing one:

Find the endpoint in your list
Click the ⋯ menu
Select Duplicate
Modify the name and path
Adjust schema and prompts as needed

Duplicating is great for creating variations (e.g., summarize-short and summarize-detailed) that share similar structures.

Deleting Endpoints

Deleting an endpoint is permanent and will break any applications using it. Make sure nothing depends on the endpoint before deleting.

To delete:

Go to the endpoint’s Settings tab
Scroll to the Danger Zone
Click Delete Endpoint
Confirm by typing the endpoint name

Next Steps

Define Input Schema

Specify what data your endpoint accepts

Define Output Schema

Specify what data your endpoint returns

​Before You Start

​Creating the Endpoint

​Path Requirements

​After Creation

​Example: Building a Sentiment Analyzer

​Step 1: Basic Details

​Step 2: Input Schema

​Step 3: Output Schema

​Step 4: Create Prompt

​Duplicating Endpoints

​Deleting Endpoints

​Next Steps

Define Input Schema

Define Output Schema

Before You Start

Creating the Endpoint

Path Requirements

After Creation

Example: Building a Sentiment Analyzer

Step 1: Basic Details

Step 2: Input Schema

Step 3: Output Schema

Step 4: Create Prompt

Duplicating Endpoints

Deleting Endpoints

Next Steps