Skip to main content
POST
Create Project

Authorizations

X-API-Key
string
header
required

Body

name
string
required
Minimum string length: 1
domain
string
required
Minimum string length: 1
Example:

"peec.ai"

country_code
enum<string>
required

The country the project's prompts run from.

Available options:
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
Example:

"US"

language_code
enum<string>

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

Available options:
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
Example:

"en"

model_channel_ids
enum<string>[]

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

Available options:
openai-0,
openai-1,
qwen-0,
openai-2,
perplexity-0,
perplexity-1,
google-0,
google-1,
google-2,
google-3,
google-4,
anthropic-0,
anthropic-1,
anthropic-2,
anthropic-3,
deepseek-0,
meta-0,
meta-1,
xai-0,
xai-1,
microsoft-0,
amazon-0,
mistral-0,
mistral-1,
naver-0,
openai-3,
openai-4,
openai-5
allocated_credits
number

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_pitch
boolean

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_pitch
boolean

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

timezone
string

IANA timezone. Defaults to the company's timezone.

Example:

"Europe/Berlin"

chat_interval_weekdays
number[]

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

Required range: 1 <= x <= 7

Response

Project created successfully

Project created successfully

id
string
required
Example:

"or_915e742b-396d-4a86-ad57-8bc84e8c2232"