Create prompt

Create a new prompt with default initial version

POST /api/prompts

Python

Python

import requests

url = "https://app.langwatch.ai/api/prompts"

payload = { "handle": "<string>" }
headers = {
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

200

{
  "id": "<string>",
  "handle": "<string>",
  "scope": "ORGANIZATION",
  "name": "<string>",
  "updatedAt": "<string>",
  "projectId": "<string>",
  "organizationId": "<string>",
  "versionId": "<string>",
  "version": 123,
  "createdAt": "<string>",
  "prompt": "<string>",
  "messages": [],
  "inputs": [],
  "outputs": [
    {
      "identifier": "<string>",
      "type": "str",
      "json_schema": {
        "type": "<string>"
      }
    }
  ],
  "model": "<string>",
  "tags": [],
  "authorId": "<string>",
  "commitMessage": "<string>",
  "temperature": 123,
  "maxTokens": 123,
  "demonstrations": {
    "id": "<string>",
    "name": "<string>",
    "inline": {
      "records": {},
      "columnTypes": [
        {
          "name": "<string>",
          "type": "<string>",
          "id": "<string>"
        }
      ]
    }
  },
  "promptingTechnique": {
    "type": "few_shot",
    "demonstrations": {
      "id": "<string>",
      "name": "<string>",
      "inline": {
        "records": {},
        "columnTypes": [
          {
            "name": "<string>",
            "type": "<string>",
            "id": "<string>"
          }
        ]
      }
    }
  },
  "responseFormat": {
    "type": "json_schema",
    "json_schema": {
      "name": "<string>",
      "schema": {}
    }
  }
}

Authorizations

X-Auth-Token · string · header · required

Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.

Body

application/json

handle · string · required

Pattern: ^[a-z0-9_-]+(?:\/[a-z0-9_-]+)?$

scope · enum<string> · default: PROJECT

Available options: ORGANIZATION, PROJECT

model · string

temperature · number

maxTokens · number

commitMessage · string

authorId · string

prompt · string

messages · object[]

Show child attributes

inputs · object[]

Show child attributes

outputs · object[]

Show child attributes

schemaVersion · enum<string>

Available options: 1.0

tags · string[]

Minimum string length: 1

Response

200

application/json

Success

id · string · required

handle · string | null · required

scope · enum<string> · required

Available options: ORGANIZATION, PROJECT

name · string · required

updatedAt · string · required

projectId · string · required

organizationId · string · required

versionId · string · required

version · number · required

createdAt · string · required

prompt · string · required

messages · object[] · required

Show child attributes

inputs · object[] · required

Show child attributes

outputs · object[] · required

Minimum array length: 1

Show child attributes

model · string · required

Minimum string length: 1

tags · object[] · required

Show child attributes

authorId · string | null

commitMessage · string | null

temperature · number

maxTokens · number

demonstrations · object

Show child attributes

promptingTechnique · object

Show child attributes

responseFormat · object

Show child attributes