Get prompt

Get a specific prompt by slug, with optional shorthand syntax for tags and versions. Pass a bare slug like “pizza-prompt” to get the latest version, “pizza-prompt:production” to resolve a tagged version, or “pizza-prompt:2” to fetch version 2. Alternatively, use the tag or version query parameters with a bare slug.

GET /api/v1/prompts/{id}

Python

Python

import requests

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

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

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "id": "<string>",
  "handle": "<string>",
  "scope": "PROJECT",
  "name": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "projectId": "<string>",
  "organizationId": "<string>",
  "versionId": "<string>",
  "version": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "prompt": "<string>",
  "messages": [],
  "inputs": [],
  "outputs": [
    {
      "identifier": "<string>",
      "type": "str",
      "json_schema": {
        "type": "<string>"
      }
    }
  ],
  "model": "<string>",
  "tags": [],
  "parameters": {},
  "platformUrl": "<string>",
  "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.

Path Parameters

id · string · required

Query Parameters

version · integer

Required range: 0 <= x <= 9007199254740991

tag · string

Response

200

application/json

Success

id · string · required

handle · string | null · required

scope · enum<string> · required

Available options: PROJECT, ORGANIZATION

name · string · required

updatedAt · string<date-time> · required

projectId · string · required

organizationId · string · required

versionId · string · required

version · number · required

createdAt · string<date-time> · 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

parameters · object · required

Show child attributes

platformUrl · string · required

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