Skip to main content

Prompts

The Prompts screen lets you store versioned prompt templates with variables, read their versions and render them with values. Portal path: /data/prompts. Developers and tenant administrators use it to share prompts between agents and applications.

What the screen shows​

The Prompts table lists the prompts of the tenant by name: Name, Latest version, Description, Updated.

The New prompt form has Name (required), Template (required, example Summarize {{document}} in {{language}}.), Variables (comma separated, for example document, language), Description and Model hint. Each variable is sent as required.

The row menu offers Versions and Render; their answers open in a side panel as JSON.

Actions​

Button or actionWhat it doesAPI callRoles
Refresh iconReloads the listGET /v1/promptsany tenant user
New prompt > CreateCreates the prompt, or publishes a new version when the name exists (an identical template is not duplicated)POST /v1/promptstenant_admin, developer
Versions (row menu)Shows every version with its template, variables, model hint and digestGET /v1/prompts/{name}/versionsany tenant user
Render (row menu)Opens a dialog with Variables (JSON, required), then renders the latest versionPOST /v1/prompts/{name}/renderany tenant user

Roles​

The portal shows every button. In services/control-plane/src/eai/domains/prompts/__init__.py publishing needs tenant_admin or developer; reading and rendering need a user of the tenant.

Typical tasks​

Publish a prompt and a new version​

  1. Create the prompt. The name is the stable key that agents reference. Click New prompt, fill Name (lowercase, digits, ., _, -), Template and Variables, then Create.

    Expected result: the toast "Created" and the row with Latest version 1.

    If it fails: template_error means a placeholder is unbalanced or not declared in Variables.

  2. Publish a change. Create the prompt again with the same Name and the new Template.

    Expected result: Latest version goes to 2; the same template again changes nothing.

    If it fails: forbidden means you are neither tenant_admin nor developer.

Check the text sent to the model​

  1. Render the prompt. Rendering applies the values to the latest version. Open the row menu, choose Render and type the values:

    {"document": "the attached report", "language": "English"}

    Expected result: the panel shows text, chars, estimated_tokens, version and digest.

    If it fails: missing_variables lists the required variables that have no value.

Troubleshooting​

SymptomCauseFix
forbidden (403) on CreateYou are neither tenant_admin nor developerAsk for the developer role
invalid_request (400) with nameThe name has capitals, spaces or other charactersUse lowercase letters, digits, ., _ and -
template_error (422)Unbalanced placeholder, invalid variable type or undeclared variableDeclare every {{variable}} in Variables
missing_variables (422) on RenderA required variable has no valueAdd it to the JSON of Variables
not_found (404) with prompt_versionThe requested version does not existRead Versions first