PEpeec
Project

List Chats

Changed on

List the chats of a project

get/chats

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/chats
  • 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
limitinteger
offsetinteger
start_datestring date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

Example:2025-09-22
end_datestring date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

Example:2025-09-22
brand_idstring
prompt_idstring
model_id'chatgpt-scraper' | 'gpt-4o' | 'gpt-4o-search' | 'gpt-3.5-turbo' | 'llama-sonar' | 'perplexity-scraper' | 'sonar' | 'gemini-2.5-flash' | 'gemini-3.1-flash-lite-search' | 'gemini-scraper' | 'google-ai-overview-scraper' | 'google-ai-mode-scraper' | 'llama-3.3-70b-instruct' | 'deepseek-r1' | 'deepseek-v4-pro' | 'claude-3.5-haiku' | 'claude-haiku-4.5' | 'claude-sonnet-4' | 'grok-scraper' | 'microsoft-copilot-scraper' | 'grok-4' | 'grok-4.3' | 'grok-4.6' | 'qwen-3-6-plus' | 'qwen-3-7-plus' | 'amazon-rufus-scraper' | 'mistral-small-4' | 'mistral-medium-3-5' | 'muse-spark-1.2' | 'muse-spark-1.3' | 'muse-wonder-1.0' | 'gemini-4-argon' | 'naver-ai-briefing-scraper' | 'claude-opus-5' | 'claude-fable-5.1' | 'gpt-6-astra' | 'gpt-5.6-sol' | 'gpt-5.6-terra' | 'ernie-scraper' | 'exa-answer'

Deprecated: use model_channel_id instead

model_channel_id'openai-0' | 'openai-1' | 'qwen-0' | 'openai-2' | 'perplexity-0' | 'perplexity-1' | 'google-0' | 'google-1' | 'google-2' | 'google-3' | 'google-4' | 'google-5' | 'anthropic-0' | 'anthropic-1' | 'anthropic-2' | 'anthropic-3' | 'deepseek-0' | 'meta-0' | 'meta-1' | 'meta-2' | 'xai-0' | 'xai-1' | 'microsoft-0' | 'amazon-0' | 'mistral-0' | 'mistral-1' | 'naver-0' | 'openai-3' | 'openai-4' | 'openai-5' | 'baidu-0' | 'exa-0'
featuresstring[]
include_archived_promptsstring
sort'asc' | 'desc'

Sort order by chat creation time. Defaults to asc (oldest first); use desc to get the most recent chats first.

Response

Success

total_countnumber required

Total number of matching chats, ignoring pagination

totalCountnumber required

Total number of matching chats, ignoring pagination

Example response

{
  "data": [
    {
      "id": "ch_61184892-36ad-4e1a-8178-3a83608f7711",
      "prompt": {
        "id": "pr_93f790de-5b7a-45ee-b782-61103c81f20d"
      },
      "model": {
        "id": "gpt-4o-search"
      },
      "model_channel": {
        "id": "openai-1"
      },
      "date": "2025-09-17"
    }
  ],
  "total_count": 42,
  "totalCount": 42
}

Changes

  • 9d774600c8ebRevision changes
    • info

      added the new enum value exa-0 to the query request parameter model_channel_id

    • info

      added the new enum value exa-answer to the query request parameter model_id

  • 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 CHART enum value to the /// response property for the response status

    • warning

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

    • info

      added the new enum value anthropic-2 to the query request parameter model_channel_id

    • info

      added the new enum value anthropic-3 to the query request parameter model_channel_id

    • info

      added the new enum value baidu-0 to the query request parameter model_channel_id

    • info

      added the new enum value claude-fable-5.1 to the query request parameter model_id

    • info

      added the new enum value claude-opus-5 to the query request parameter model_id

    • info

      added the new enum value ernie-scraper to the query request parameter model_id

    • info

      added the new enum value gemini-4-argon to the query request parameter model_id

    • info

      added the new enum value google-5 to the query request parameter model_channel_id

    • info

      added the new enum value gpt-5.6-sol to the query request parameter model_id

    • info

      added the new enum value gpt-5.6-terra to the query request parameter model_id

    • info

      added the new enum value gpt-6-astra to the query request parameter model_id

    • info

      added the new enum value grok-4.6 to the query request parameter model_id

    • info

      added the new enum value meta-1 to the query request parameter model_channel_id

    • info

      added the new enum value meta-2 to the query request parameter model_channel_id

    • info

      added the new enum value muse-spark-1.2 to the query request parameter model_id

    • info

      added the new enum value muse-spark-1.3 to the query request parameter model_id

    • info

      added the new enum value muse-wonder-1.0 to the query request parameter model_id

    • info

      added the new enum value naver-0 to the query request parameter model_channel_id

    • info

      added the new enum value naver-ai-briefing-scraper to the query request parameter model_id

    • info

      added the new enum value openai-3 to the query request parameter model_channel_id

    • info

      added the new enum value openai-4 to the query request parameter model_channel_id

    • info

      added the new enum value openai-5 to the query request parameter model_channel_id

    • info

      added the enum value CHART to the property items/ of the query request parameter features

    • info

      added the enum value LINKS to the property items/ of the query request parameter features