Get prompt

Get a specific prompt

GET /api/prompts/{id}

Python

Python

import requests

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

headers = {"X-Auth-Token": "<api-key>"}

response = requests.get(url, 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"
    }
  ],
  "model": "<string>",
  "authorId": "<string>",
  "commitMessage": "<string>",
  "temperature": 123,
  "maxTokens": 123,
  "demonstrations": {
    "id": "<string>",
    "name": "<string>"
  }
}

Authorizations

X-Auth-Token · string · header · required

Path Parameters

id · string · required

Query Parameters

version · integer

Specific version number to retrieve

Required range: x >= 0

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

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