PEpeec
Project

List Prompts

Changed on

List the prompts of a project

get/prompts

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/prompts
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key
    • or HTTP bearer

Query parameters

project_idstring

Required if using a company api key

Example:or_f45b94ba-5e35-4982-93ed-285e72ee14eb
topic_idstring
tag_idstring
is_archivedstring

Filter by archived status. Omit (or false) to return only active prompts; true to return only archived prompts.

start_datestring date

Only return prompts created on or after this date (UTC).

end_datestring date

Only return prompts created on or before this date (UTC).

searchstring

Free-text search over prompt text. Fuzzy and word-order-insensitive; results are ordered by relevance (best match first).

limitinteger
offsetinteger

Response

Success

total_countnumber required

Total number of matching prompts, ignoring pagination

totalCountnumber required

Total number of matching prompts, ignoring pagination

search_truncatedboolean

Only present when search is used. True when the project has more prompts than the search scan limit (20000); only the most recent 20000 prompts were searched, so matches may be missing and total_count may undercount.

Example response

{
  "data": [
    {
      "id": "pr_93f790de-5b7a-45ee-b782-61103c81f20d",
      "messages": [
        {
          "content": "Example Prompt"
        }
      ],
      "tags": [
        {
          "id": "tg_23abec5b-100a-4261-9ee7-1effe68f0149"
        }
      ],
      "topic": {
        "id": "to_e6b8cdd3-a51b-4d94-a866-28dbe6b830a6"
      },
      "created_at": "2025-09-22"
    }
  ],
  "total_count": 42,
  "totalCount": 42
}

Changes

  • 9fdffdff48a5Revision changes
    • breaking

      for the query request parameter limit, the type changed from number to integer

    • breaking

      for the query request parameter offset, the type changed from number to integer

    • warning

      for the query request parameter offset, the max was set to 9007199254740991.00

    • warning

      added the new MN enum value to the /// response property for the response status