RErespan
Prompts

Deploy a prompt version

Changed on

Deploy a committed version as the live version for this prompt.

post/api/prompts/{prompt_id}/deployments/

Request

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

Path parameters

prompt_idstring required

The unique prompt identifier.

Request body

versioninteger required

Version number to deploy as live.

Example request

{
  "version": 3
}

Response

Version deployed successfully.

idstring
prompt_version_idstring
versioninteger
descriptionstring nullable
messagesobject[]
modelstring
readonlyboolean
created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "pv_abc123",
  "prompt_version_id": "pv_abc123",
  "version": 3,
  "description": "Improved system prompt for better context handling",
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant. Context: {{context}}"
    }
  ],
  "model": "gpt-4o",
  "readonly": true,
  "is_deployed": true,
  "edited_by": {
    "id": 123,
    "email": "user@example.com",
    "first_name": "John",
    "last_name": "Doe"
  },
  "created_at": "2026-02-27T10:00:00Z",
  "updated_at": "2026-02-27T10:00:00Z"
}

Changes

  • c30bcb383ee8Revision changes
    • breaking

      request body became required

    • breaking

      the response property became nullable for the status

    • info

      api operation id prompts_deployPromptVersion removed and replaced with deployPromptVersion

    • info

      the endpoint scheme security DashboardJwt was added to the API

    • info

      api tag Prompts added

    • info

      api tag prompts removed

  • 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