KEkeywordsai
Prompts

Update a prompt

Changed on

Update prompt metadata such as its name or description.

patch/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.

Request body

namestring

Updated prompt name.

descriptionstring

Updated prompt description.

Example request

{
  "name": "enhanced_customer_support",
  "description": "Improved version with better context handling"
}

Response

Prompt updated successfully.

idstring
namestring
descriptionstring nullable

Example response

{
  "id": "prompt_abc123",
  "name": "Enhanced Customer Support Assistant",
  "description": "Improved version with better context handling",
  "updated_at": "2026-01-21T12:30:00Z"
}

Changes

  • c30bcb383ee8Revision changes
    • breaking

      request body became required

    • breaking

      the response property became nullable for the status

    • info

      api operation id prompts_updatePrompt removed and replaced with updatePrompt

    • 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

    • 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