Skip to content
API referenceSet a prompt label

Set a prompt label

PUT/v1/prompts/{slug}/labels/{label}

Set a prompt label.

Points the label at a version, creating the label or moving it from the version it pointed at. A request picks a labelled version with version_ref: "@label"; the production label decides the default version. Requires an admin of the prompt's workspace, or an organization admin.

Errors: 404 when the prompt or version does not exist; 409 when the version is not PUBLISHED.

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

  • labelstringrequired

    the label's name, for example production or staging

Query parameters

  • organizationstringrequired

    slug of the organization that owns it

Request body application/json

the version to point at

  • version_numberinteger<int32>required

    The version to point the label at (required). It must be the prompt's PUBLISHED version (409 otherwise).

Responses

200application/json
  • prompt_idstring

    Id (UUID) of the prompt.

  • labelstring

    The label's name.

  • version_numberinteger<int32>

    The version the label points at.

  • organizationstring

    Slug of the organization that owns the prompt.

  • updated_atstring<date-time>

    Not filled in by the current API: always null.

NVIDIA Inception Program member

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