Project

List Model Channels

Changed on

List the model channels

get/model-channels

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/model-channels
  • 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

Response

Success

Example response

{
  "data": [
    {
      "id": "openai-0",
      "description": "ChatGPT",
      "current_model": {
        "id": "chatgpt-scraper"
      },
      "is_active": true,
      "unsupported_country_codes": []
    },
    {
      "id": "amazon-0",
      "description": "Amazon Rufus UI",
      "current_model": {
        "id": "amazon-rufus-scraper"
      },
      "is_active": true,
      "unsupported_country_codes": [
        "AE",
        "AR",
        "AT"
      ]
    }
  ]
}

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