---
title: "POST /v1/prompt/query"
method: POST
path: "/v1/prompt/query"
tags: ["Prompt"]
---

# POST /v1/prompt/query

`POST /v1/prompt/query`

## Request body

- PromptsQueryParams
  - `filter` union, required
    - FilterLeafSubsetPromptV2 — From T, pick a set of properties whose keys are in the union K
      - `prompt_v2` PartialPromptToOperators — Make all properties in T optional
        - `id` PartialTextOperators — Make all properties in T optional
          - `not-equals` string
          - `equals` string
          - `like` string
          - `ilike` string
          - `contains` string
          - `not-contains` string
        - `user_defined_id` PartialTextOperators — Make all properties in T optional
          - `not-equals` string
          - `equals` string
          - `like` string
          - `ilike` string
          - `contains` string
          - `not-contains` string
    - PromptsFilterBranch
      - `right` PromptsFilterNode, required — recursive
      - `operator` 'or' | 'and', required
      - `left` PromptsFilterNode, required — recursive
    - 'all'

## Response `200`

Ok

- union
  - ResultSuccessPromptsResultArray
    - `data` PromptsResult[], required
      - `id` string, required
      - `user_defined_id` string, required
      - `description` string, required
      - `pretty_name` string, required
      - `created_at` string, required
      - `major_version` number, double, required
      - `metadata` RecordStringAny — Construct a type with a set of properties K of type T
    - `error` null, nullable, required
  - ResultErrorString
    - `data` null, nullable, required
    - `error` string, required

---

[API](https://skmtc.net/helicone/apis/helicone-api.md) · [All operations](https://skmtc.net/helicone/apis/helicone-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/helicone/helicone-api/versions/b369e9e3e80c/schema)