LLM prompts

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

GET
POST
GET
PATCH
POST
POST
DELETE
POST
GET

List all llm prompts

Required API key scopes

llm_prompt:read

Query parameters

  • archived
    boolean
    Default: false
  • content
    string
    Default: full
    One of: "full""preview""none"
  • created_by_id
    integer
  • label
    string
  • limit
    integer
  • offset
    integer
  • order_by
    string
    Default: -created_at
    One of: "name""-name""created_at""-created_at""updated_at""-updated_at""version""-version""latest_version""-latest_version""version_count""-version_count""first_version_created_at""-first_version_created_at""prompt_size_bytes""-prompt_size_bytes"
  • resolve
    boolean
    Default: true
  • search
    string

Response


Example request

GET /api/projects/:project_id/llm_prompts
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/llm_prompts/

Example response

Status 200
RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "prompt": null,
      "config": {},
      "version": 0,
      "version_description": "string",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "engineering"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted": true,
      "is_latest": true,
      "latest_version": 0,
      "version_count": 0,
      "first_version_created_at": "string",
      "outline": [
        {
          "level": 1,
          "text": "string"
        }
      ],
      "labels": [
        "string"
      ],
      "activity_item_id": "string",
      "prompt_preview": "string",
      "prompt_size_bytes": 0,
      "all_labels": [
        {
          "name": "string",
          "version": 0
        }
      ],
      "resolved_references": [
        {
          "name": "string",
          "version": 0,
          "label": "string"
        }
      ]
    }
  ]
}

Create llm prompts

Required API key scopes

llm_prompt:write

Request parameters

  • name
    string
  • prompt
  • config
    object | null
  • version_description
    string | null

Response


Example request

POST /api/projects/:project_id/llm_prompts
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/llm_prompts/\
	-d name="string",\
	-d prompt=undefined

Example response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "prompt": null,
  "config": {},
  "version": 0,
  "version_description": "string",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "deleted": true,
  "is_latest": true,
  "latest_version": 0,
  "version_count": 0,
  "first_version_created_at": "string",
  "outline": [
    {
      "level": 1,
      "text": "string"
    }
  ],
  "labels": [
    "string"
  ],
  "activity_item_id": "string"
}

Retrieve llm prompts name

Required API key scopes

llm_prompt:read

Path parameters

  • prompt_name
    string

Query parameters

  • content
    string
    Default: full
    One of: "full""preview""none"
  • label
    string
  • resolve
    boolean
    Default: true
  • version
    integer

Response


Example request

GET /api/projects/:project_id/llm_prompts/name/:prompt_name
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/llm_prompts/name/:prompt_name/

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "prompt": null,
  "config": {},
  "prompt_preview": "string",
  "outline": [
    {
      "level": 1,
      "text": "string"
    }
  ],
  "version": 0,
  "label": "string",
  "resolved_references": [
    {
      "name": "string",
      "version": 0,
      "label": "string"
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "deleted": true,
  "is_latest": true,
  "latest_version": 0,
  "version_count": 0,
  "first_version_created_at": "2019-08-24T14:15:22Z"
}

Update llm prompts name

Required API key scopes

llm_prompt:write

Path parameters

  • prompt_name
    string

Request parameters

  • prompt
  • edits
    Click to open
    array
  • config
    object | null
  • base_version
    integer
  • version_description
    string

Response


Example request

PATCH /api/projects/:project_id/llm_prompts/name/:prompt_name
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/llm_prompts/name/:prompt_name/\
	-d prompt=undefined

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "prompt": null,
  "config": {},
  "version": 0,
  "version_description": "string",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "deleted": true,
  "is_latest": true,
  "latest_version": 0,
  "version_count": 0,
  "first_version_created_at": "string",
  "outline": [
    {
      "level": 1,
      "text": "string"
    }
  ],
  "labels": [
    "string"
  ],
  "activity_item_id": "string"
}

Create llm prompts name archive

Required API key scopes

llm_prompt:write

Path parameters

  • prompt_name
    string

Example request

POST /api/projects/:project_id/llm_prompts/name/:prompt_name/archive
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/llm_prompts/name/:prompt_name/archive/

Example response

Status 204 No response body
Status 409 The prompt is referenced by other prompts and cannot be archived.
RESPONSE
{
  "detail": "string",
  "referencing_prompts": [
    "string"
  ]
}

Create llm prompts name duplicate

Required API key scopes

llm_prompt:write

Path parameters

  • prompt_name
    string

Request parameters

  • new_name
    string

Response


Example request

POST /api/projects/:project_id/llm_prompts/name/:prompt_name/duplicate
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/llm_prompts/name/:prompt_name/duplicate/\
	-d new_name="string"

Example response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "prompt": null,
  "config": {},
  "version": 0,
  "version_description": "string",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "deleted": true,
  "is_latest": true,
  "latest_version": 0,
  "version_count": 0,
  "first_version_created_at": "string",
  "outline": [
    {
      "level": 1,
      "text": "string"
    }
  ],
  "labels": [
    "string"
  ],
  "activity_item_id": "string"
}

Delete llm prompts name labels

Required API key scopes

llm_prompt:write

Path parameters

  • label_name
    string
  • prompt_name
    string

Example request

DELETE /api/projects/:project_id/llm_prompts/name/:prompt_name/labels/:label_name
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/llm_prompts/name/:prompt_name/labels/:label_name/

Example response

Status 204 No response body
Status 409 The label is referenced by other prompts and cannot be deleted.
RESPONSE
{
  "detail": "string",
  "referencing_prompts": [
    "string"
  ]
}

Create llm prompts name unarchive

Required API key scopes

llm_prompt:write

Path parameters

  • prompt_name
    string

Response


Example request

POST /api/projects/:project_id/llm_prompts/name/:prompt_name/unarchive
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/llm_prompts/name/:prompt_name/unarchive/

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "prompt": null,
  "config": {},
  "version": 0,
  "version_description": "string",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "deleted": true,
  "is_latest": true,
  "latest_version": 0,
  "version_count": 0,
  "first_version_created_at": "string",
  "outline": [
    {
      "level": 1,
      "text": "string"
    }
  ],
  "labels": [
    "string"
  ],
  "activity_item_id": "string"
}
Status 409 An active prompt with this name already exists, or the archived versions overlap.

Retrieve llm prompts resolve name

Required API key scopes

llm_prompt:read

Path parameters

  • prompt_name
    string

Query parameters

  • before_version
    integer
  • limit
    integer
    Default: 50
  • offset
    integer
  • version
    integer
  • version_id
    string

Response


Example request

GET /api/projects/:project_id/llm_prompts/resolve/name/:prompt_name
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/llm_prompts/resolve/name/:prompt_name/

Example response

Status 200
RESPONSE
{
  "prompt": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "prompt": null,
    "config": {},
    "version": 0,
    "version_description": "string",
    "created_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted": true,
    "is_latest": true,
    "latest_version": 0,
    "version_count": 0,
    "first_version_created_at": "string",
    "outline": [
      {
        "level": 1,
        "text": "string"
      }
    ],
    "labels": [
      "string"
    ],
    "activity_item_id": "string"
  },
  "versions": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "version": 0,
      "version_description": "string",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "engineering"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "is_latest": true,
      "labels": [
        "string"
      ]
    }
  ],
  "has_more": true,
  "labels": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "prompt_name": "string",
      "version": 0,
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "engineering"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "referenced_by": [
    {
      "name": "string",
      "label": "string",
      "version": 0
    }
  ]
}