Create Prompt

POST /console/v1/prompts

Create Prompt

cURL

curl --request POST \
  --url https://statsigapi.net/console/v1/prompts \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "name": "my_prompt",
  "displayName": "<string>",
  "description": "<string>",
  "targetApps": "<string>",
  "team": "<string>",
  "teamID": "<string>",
  "tags": [
    "<string>"
  ],
  "creatorID": "<string>",
  "owner": {
    "ownerID": "user123",
    "ownerType": "USER",
    "ownerName": "John Doe",
    "ownerEmail": "[e-mail]"
  },
  "creatorEmail": "<string>"
}
'

200

{
  "message": "<string>",
  "data": {
    "id": "<string>",
    "description": "<string>",
    "lastModifierID": "<string>",
    "lastModifiedTime": 123,
    "lastModifierEmail": "<string>",
    "lastModifierName": "<string>",
    "createdTime": 123,
    "creatorName": "<string>",
    "name": "<string>",
    "idType": "<string>",
    "creatorID": "<string>",
    "creatorEmail": "<string>",
    "tags": [
      "<string>"
    ],
    "targetApps": [
      "<string>"
    ],
    "holdoutIDs": [
      "<string>"
    ],
    "team": "<string>",
    "teamID": "<string>",
    "version": 123
  }
}

Authorizations

STATSIG-API-KEY · string · header · required

Headers

x-respect-review-settings · string

Optional header to respect review settings for mutation endpoints.

Body

application/json

name · string · required

Name for the AI Config.

Required string length: 3 - 100

Example:

"my_prompt"

displayName · string

Optional display name for the AI Config.

Required string length: 3 - 100

description · string

Description for the AI Config.

Maximum string length: 1000

targetApps · string string[]

List of target app names.

team · string

Team name.

teamID · string

Team ID.

tags · string[]

Optional tags to associate with the AI Config.

creatorID · string | null

owner · object

Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.

Show child attributes

Example:

{
  "ownerID": "user123",
  "ownerType": "USER",
  "ownerName": "John Doe",
  "ownerEmail": "[e-mail]"
}

creatorEmail · string | null

Response

200

application/json

Create Prompt

message · string · required

A simple string explaining the result of the operation.

data · object · required

A single result.

Show child attributes