Skip to navigation
API ReferencePromptsPrompts

Update a prompt

Update prompt metadata such as its name or description.

Authentication

AuthorizationBearer

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

OR
AuthorizationBearer

Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

Path parameters

prompt_idstringRequired
The unique prompt identifier.

Request

This endpoint expects an object.
namestringOptional
Updated prompt name.
descriptionstringOptional
Updated prompt description.

Response

Prompt updated successfully.
idstringOptional
namestringOptional
descriptionstring or nullOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error