List prompts

GET/v1/prompts

List prompts.

Returns a page of the organization's prompts. With workspace_id the list holds that workspace's prompts and needs membership of the workspace; without it the list covers the whole organization and needs an organization admin.

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.

Query parameters

organizationstringrequired
slug of the organization
workspace_idstring<uuid>
id (UUID) of a workspace, to list only its prompts
searchstring
keeps the prompts on the returned page whose name or description contains this text (any case). It filters the page, not the whole list: total still counts every prompt
pageinteger<int32>
page number, from 1. Default 1
page_sizeinteger<int32>
prompts per page. Default 20, at most 100

Responses

200application/json

totalinteger<int64>
Number of prompts in the organization, or in the workspace when workspace_id was given. It does not apply search.
pageinteger<int32>
The page number, from 1.
page_sizeinteger<int32>
Prompts per page.
dataobject[]
The prompts on this page, after search is applied to the page.
Child attributes
- 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.

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