PEpeec
Project

List Prompt Suggestions

Changed on

List the prompt suggestions of a project

get/prompts/suggestions

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/prompts/suggestions
  • 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
limitinteger
offsetinteger
legacystring

Which suggestions to return. true (the default) returns the project's standard prompt suggestions. false returns Prompt discovery suggestions — the generated set awaiting review, which is accepted through the Prompt discovery rather than the accept/reject endpoints below, and whose ids are prefixed pr_ rather than ps_.

Response

Success

Example response

{
  "data": [
    {
      "id": "ps_93f790de-5b7a-45ee-b782-61103c81f20d",
      "messages": [
        {
          "content": "What is the best SEO tool?"
        }
      ],
      "tags": [
        {
          "id": "tg_23abec5b-100a-4261-9ee7-1effe68f0149"
        }
      ],
      "topic": {
        "id": "to_e6b8cdd3-a51b-4d94-a866-28dbe6b830a6"
      }
    }
  ]
}

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

    • info

      added the new optional query request parameter legacy