PEpeec
Company

Create Project

Changed on

Create a project in the company, under the same plan limits and credit pool as creating it in the app. Add brands and prompts to it afterwards.

post/projects

Request

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

Request body

namestring required
domainstring required
country_code'AE' | 'AL' | 'AM' | 'AR' | 'AT' | 'AU' | 'BA' | 'BE' | 'BG' | 'BH' | 'BO' | 'BR' | 'BS' | 'BY' | 'CA' | 'CH' | 'CL' | 'CN' | 'CO' | 'CR' | 'CY' | 'CZ' | 'DE' | 'DK' | 'DO' | 'EC' | 'EE' | 'EG' | 'ES' | 'FI' | 'FR' | 'GB' | 'GE' | 'GH' | 'GR' | 'GT' | 'HK' | 'HN' | 'HR' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IQ' | 'IS' | 'IT' | 'JO' | 'JP' | 'KR' | 'KW' | 'LB' | 'LI' | 'LT' | 'LU' | 'LV' | 'MA' | 'MD' | 'ME' | 'MK' | 'MN' | 'MT' | 'MX' | 'MY' | 'NG' | 'NI' | 'NL' | 'NO' | 'NZ' | 'OM' | 'PK' | 'PA' | 'PE' | 'PH' | 'PL' | 'PT' | 'PY' | 'PS' | 'QA' | 'RO' | 'RS' | 'SA' | 'SE' | 'SG' | 'SI' | 'SK' | 'SV' | 'TH' | 'TN' | 'TR' | 'TW' | 'UA' | 'US' | 'UY' | 'VE' | 'VN' | 'ZA' | 'AD' | 'AF' | 'AS' | 'AZ' | 'BB' | 'BQ' | 'CG' | 'CI' | 'CM' | 'CW' | 'DM' | 'DZ' | 'FO' | 'GF' | 'GP' | 'JM' | 'KG' | 'KH' | 'KI' | 'KZ' | 'LK' | 'LR' | 'LS' | 'MW' | 'NC' | 'PG' | 'TD' | 'TF' | 'UG' | 'VU' | 'ZW' required

The country the project's prompts run from.

language_code'ar' | 'az' | 'bg' | 'bn' | 'bs' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'es' | 'et' | 'fi' | 'fr' | 'he' | 'hi' | 'hr' | 'hu' | 'hy' | 'id' | 'it' | 'ja' | 'ko' | 'lt' | 'lv' | 'mk' | 'mn' | 'ms' | 'no' | 'nl' | 'pl' | 'pt' | 'ro' | 'ru' | 'sk' | 'sl' | 'sq' | 'sr' | 'sv' | 'th' | 'tl' | 'tr' | 'uk' | 'ur' | 'vi' | 'zh'

ISO 639-1 language code the project's prompts run in.

model_channel_idsstring[]

Model channels to track. Defaults to the company's default channels. Not allowed on a pitch project, which uses the company's pitch models.

allocated_creditsnumber

Credits to allocate to the project from the company's pool. Required for every project except an onboarding one, the first project of a company that has no plan yet, and a pitch project, which takes none.

is_pitchboolean

Create a pitch project, available to agency and partner companies. It runs under the company's pitch project and prompt limits and ends after the company's pitch period.

is_instant_pitchboolean

Make the pitch project an instant pitch, which does not run on the daily schedule. Requires is_pitch.

timezonestring

IANA timezone. Defaults to the company's timezone.

chat_interval_weekdaysnumber[]

ISO 8601 weekdays: 1 is monday, 7 is sunday. Defaults to the company's schedule, and not set means daily.

Example request

{
  "domain": "peec.ai",
  "country_code": "US",
  "language_code": "en",
  "timezone": "Europe/Berlin"
}

Response

Project created successfully

idstring required

Example response

{
  "id": "or_915e742b-396d-4a86-ad57-8bc84e8c2232"
}

Changes

  • 9d774600c8ebRevision changes
    • info

      added the new exa-0 enum value to the request property / (media type: application/json)

    • info

      added the new exa-0 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new exa-0 enum value to the request property / (media type: multipart/form-data)

  • 9fdffdff48a5Revision changes
    • info

      endpoint added