Quickstart

Create a prompt

In the platform, go to Gateway › Prompts and click New prompt (or press C). Respan creates Untitled prompt and opens it in the editor. To rename it, hover its tab and click the pencil.

Write the messages

Fill in the System and User messages. Wrap anything that changes per request in double braces, like {{customer_name}}. Each variable gets a field in the Variables tab. Click Add message to add more turns.

Pick a model and test

Click Open side panel (the icon at the top right), or press .:

• Settings: choose the Model, click Add fallback model for a backup, and tune Model settings such as temperature and max tokens.
• Variables: enter a test value for each variable.

Click Run (⌘ ↵). The reply shows in the Test run tab.

Commit and deploy

Click Commit (⌘ S), type a message (or press Tab to generate one), and click Commit + Deploy. Commit alone saves a version without making it live.

Respan shows Your prompt was deployed with the Prompt ID. Copy it. To find it later, click the copy icon next to the prompt name in the side panel and choose Copy ID.

Call the prompt

Send a prompt object with the prompt ID and your variables. Respan fills the variables into the deployed version and uses that version’s messages, model, and settings. You need a Respan API key and credits or a provider key; see the Gateway quickstart.

import os
from openai import OpenAI
client = OpenAI(
    base_url="https://api.respan.ai/api/",
    api_key=os.environ["RESPAN_API_KEY"],
)
response = client.chat.completions.create(
    model="gpt-5.5",  # the prompt's saved model is used
    messages=[],
    extra_body={
        "prompt": {
            "prompt_id": "YOUR_PROMPT_ID",
            "schema_version": 2,
            "variables": {
                "customer_name": "Maya Patel",
                "plan": "Team",
                "ticket_body": "Reset link opens a blank page.",
            },
        }
    },
)
print(response.choices[0].message.content)

To see the calls, click Logs next to the prompt’s tab at the top (or press L). Logs opens filtered to this prompt.