RErespan
Prompts

Get a prompt

Changed on

Returns the prompt template with its current and live versions.

get/api/prompts/{prompt_id}/

Request

  • Base URL
    https://api.respan.ai
  • URL
    https://api.respan.ai/api/prompts/{prompt_id}/
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

prompt_idstring required

The unique prompt identifier.

Response

Prompt details.

idstring

The unique prompt identifier.

namestring
descriptionstring nullable
prompt_slugstring nullable

Example response

{
  "id": "prompt_abc123",
  "name": "Customer Support Assistant",
  "description": "Handles customer support queries with empathy",
  "prompt_slug": "customer-support-assistant",
  "tags": [
    {
      "id": "tag_abc123",
      "name": "support",
      "color": "#3B82F6",
      "created_at": "2026-01-01T00:00:00Z",
      "updated_at": "2026-01-01T00:00:00Z"
    }
  ],
  "current_version": {
    "version": 3,
    "model": "gpt-4o",
    "updated_at": "2026-01-20T10:30:00Z"
  },
  "live_version": {
    "version": 2,
    "model": "gpt-4o-mini",
    "updated_at": "2026-01-15T08:00:00Z"
  },
  "created_at": "2026-01-01T00:00:00Z",
  "updated_at": "2026-01-20T10:30:00Z"
}

Changes

  • c30bcb383ee8Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response's property type changed from no type to object for status

    • breaking

      the response's property type changed from no type to object for status

    • info

      api operation id prompts_retrievePrompt removed and replaced with retrievePrompt

    • info

      the endpoint scheme security DashboardJwt was added to the API

    • info

      api tag Prompts added

    • info

      api tag prompts removed

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      removed subschema #2 from the response property oneOf list for the response status

    • info

      removed subschema #2 from the response property oneOf list for the response status

  • b830b79cfd52Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the required property to the response with the status