Skip to main content
This guide walks you through creating a new prompt for your endpoint.

Prerequisites

Before creating a prompt, ensure you have:
  • An endpoint created
  • Input schema defined (so you know what data you’ll receive)
  • Output schema defined (optional, but recommended)

Creating a Prompt

1

Navigate to the Endpoint

Open the endpoint you want to add a prompt to.
2

Go to Prompts Tab

Click the Prompts tab in the endpoint workspace.
3

Click Create Prompt

Click the Create Prompt button.
4

Configure Basic Settings

Fill in the prompt details:
5

Write the Template

Enter your prompt template using Liquid syntax.
6

Save

Click Save to create the prompt as a Draft.

Prompt Settings Explained

Model Selection

Choose from available models:
Start with GPT-4o or Claude 3 Sonnet for the best balance of quality and speed. For image generation, use gpt-image-1.
Select an image generation model when your endpoint has image output fields. Select a vision model (GPT-4o, Claude 3, Gemini) when your endpoint has image inputs with text/JSON outputs.

Temperature

Controls randomness in responses:

Max Tokens

Maximum tokens in the response:
  • Short responses (100-500): Classifications, extractions
  • Medium responses (500-2000): Summaries, analyses
  • Long responses (2000+): Detailed reports, long-form content
Higher max tokens = higher costs. Set appropriate limits for your use case.

Custom Parameters for Image Generation

When using an image generation model, use the Custom Parameters panel to configure provider-specific options like size, quality, and background. Custom Parameters are defined as a JSON array of name/value pairs:
Parameter precedence: Hardcoded defaults → Output Field Example Value → Custom Parameters
These parameters are model/provider-specific. Check your provider’s API documentation for supported values. For example, background is an OpenAI-specific parameter.
Image generation prompts don’t need JSON output instructions — the prompt itself is the image description sent to the generation API.
A system-level instruction that sets context:
Not all models support system prompts. When unsupported, it’s prepended to the main prompt.

Writing Effective Templates

Structure Your Prompt

A well-structured prompt typically includes:
  1. Role/Context — Who is the AI in this scenario
  2. Instructions — What to do, step by step
  3. Input Data — The user’s data to process
  4. Output Format — How to structure the response

Example: Complete Prompt

Common Patterns

Classification

Extraction

Generation

Transformation

Testing Your Prompt

After saving, test immediately:
  1. Click the Test button next to your prompt
  2. Fill in the auto-generated form with sample data
  3. Click Run Test
  4. Review the response
  5. Iterate on your template as needed
Test with edge cases: empty optional fields, very long inputs, unusual values. Your prompt should handle them gracefully.

Best Practices

If you need JSON, say so explicitly and provide an example structure.
LLMs follow numbered steps more reliably than prose paragraphs.
Tell the model what NOT to do: “Do not include explanations outside the JSON.”
Few-shot examples dramatically improve consistency for complex tasks.
Use conditionals to handle missing data: {% if inputs.optional_field %}

Next Steps

Testing Prompts

Learn to test prompts thoroughly

Prompt Versions

Understand versioning and promotion