Create a prompt

POST/v1/prompts

Create a prompt.

Creates an empty prompt (no versions yet) in a workspace and returns it with its slug. Add versions with POST /v1/prompts/{slug/versions}. Requires an organization admin, or an admin of the workspace in workspace_id.

Errors: 402 when the plan's prompt limit for the workspace is reached; 403 without access; 409 when the organization already has a prompt with this name.

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.

Request body application/json

the prompt to create

namestringrequired
Display name (required), unique within the organization (409 otherwise). The slug is derived from it.
organizationstringrequired
Slug of the organization that will own the prompt (required).
workspace_idstring<uuid>required
Id (UUID) of the workspace the prompt belongs to (required). It must belong to the organization.
descriptionstring
Free-text description. Optional.

Responses

201application/json

Created

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 POST "https://api.vectoraxis.ai/v1/prompts" \
  -H "Authorization: Bearer $VECTORAXIS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "organization": "string",
  "workspace_id": "3f6c1a2e-8b4d-4c1e-9a7f-2d5e6b8c9a01"
}'

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