Create a new version for the prompt

Endpoint to Create a new version for the prompt with the given name

POST /api/public/v2/prompts

Payload Example

{
  "type": "chat",
  "name": "string",
  "prompt": [
    {
      "role": "string",
      "content": "string"
    }
  ],
  "config": null,
  "labels": [
    "string"
  ],
  "tags": [
    "string"
  ]
}

200

{
  "type": "<string>",
  "name": "<string>",
  "version": 123,
  "config": null,
  "labels": [
    {
      "label": "<string>"
    }
  ],
  "tags": [
    {
      "tag": "<string>"
    }
  ],
  "prompt": [
    {
      "role": "<string>",
      "content": "<string>"
    }
  ]
}

Payload Example

{
  "type": "chat",
  "name": "string",
  "prompt": [
    {
      "role": "string",
      "content": "string"
    }
  ],
  "config": null,
  "labels": [
    "string"
  ],
  "tags": [
    "string"
  ]
}

Show Request Description

type · string · required

Type of the interaction (e.g., “chat”).

name · string · required

Name of the interaction or entity.

prompt · array · required

List of prompts containing roles and content.

Show items

role · string · required

Role of the participant in the interaction (e.g., “user”, “assistant”).

content · string · required

Content of the prompt or message.

config · null

Configuration details (nullable).

labels · array · required

List of labels associated with the interaction.

Show items

label · string · required

A single label.

tags · array · required

List of tags associated with the interaction.

Show items

tag · string · required

A single tag.

Response Description

Below you will see the description of the create response

type · string · required

Type of the interaction (e.g., “chat”).

name · string · required

Name of the interaction or entity.

version · integer · required

Version of the configuration.

config · null

Configuration details (nullable).

labels · array · required

List of labels associated with the interaction.

Show items

label · string · required

A single label.

tags · array · required

List of tags associated with the interaction.

Show items

tag · string · required

A single tag.

prompt · array · required

List of prompts containing roles and content.

Show items

role · string · required

Role of the participant in the interaction (e.g., “user”, “assistant”).

content · string · required

Content of the prompt or message.

Code Response

Exemples of Response Code

200

Request Successful Response

400

Request Failure