PEpeec
Project

Create Prompt

Changed on

Create a new prompt within a project. Without a country_code the prompt takes the market of its topic, or the project's market when the topic has none.

post/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

Request body

textstring 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'

The market to track the prompt from, as an ISO 3166-1 alpha-2 code. Omit it to use the topic's market, or the project's market when the topic has none.

tag_idsstring[]
topic_idstring

Example request

{
  "country_code": "US"
}

Response

Prompt created successfully

idstring required
warningstring

Warning message regarding the created prompt

Example response

{
  "id": "pr_93f790de-5b7a-45ee-b782-61103c81f20d"
}

Changes

  • 9fdffdff48a5Revision changes
    • info

      the request property became optional (media type: application/json)

    • info

      the request property became optional (media type: application/x-www-form-urlencoded)

    • info

      the request property became optional (media type: multipart/form-data)

    • info

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

    • info

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

    • info

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

    • info

      added the non-success response with the status