Skip to navigation
API ReferencePromptsPrompts

Create a prompt

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.

Request

This endpoint expects an object.
namestringOptional

Prompt name. Defaults to Untitled.

descriptionstringOptional
Prompt description.

Response

Prompt created successfully.
idstringOptional
The unique prompt identifier.
namestringOptional
descriptionstring or nullOptional
prompt_slugstring or nullOptional
tagslist of objectsOptional
current_versionobject or nullOptional
The prompt's current version, as the full version object that Get a prompt version returns.
live_versionobject or nullOptional

The deployed version, as the full version object that Get a prompt version returns. null until a version is deployed.

Errors

400
Bad Request Error
403
Forbidden Error