Update a prompt

PUT/v1/prompts/{slug}

Update a prompt.

Changes the prompt's name and description; versions are not affected. The description is always replaced, so leaving it out clears it. Requires an admin of the prompt's workspace, or an organization admin. 404 when the prompt does not exist.

Authorization

AuthorizationBearer va_
A platform API key (va_...), created under Settings > API keys. Scoped to an organization or one workspace, with an admin or member role. Used by the management API.

Path parameters

slugstringrequired
the prompt's slug

Query parameters

organizationstringrequired
slug of the organization that owns it

Request body application/json

the new name and description

namestring
New display name. Omit it to keep the current name.
descriptionstring
New description. It replaces the current one, so omitting it (or sending null) clears the description.

Responses

200application/json

idstring
The prompt's unique id (UUID).
slugstring
The prompt's identifier in URLs and in the x-prompt-slug header. Generated at creation from the name (lower case, every run of other characters as one dash, at most 40 characters) plus a dash and 8 random hex characters, for example support-reply-3f9a1c2b. It never changes.
namestring
Display name, unique within the organization.
descriptionstring
Free-text description. Null when none is set.
organizationstring
Slug of the organization that owns the prompt.
workspace_idstring<uuid>
Id (UUID) of the workspace the prompt belongs to.
created_atstring<date-time>
When the prompt was created (ISO 8601).
updated_atstring<date-time>
When the prompt was created or its name or description last changed (ISO 8601). Saving versions does not change it.

Request

curl -X PUT "https://api.vectoraxis.ai/v1/prompts/{slug}?organization=string" \
  -H "Authorization: Bearer $VECTORAXIS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string"
}'

VectorAxis is built by GK Labs, a member of NVIDIA Inception.