Skip to main content
POST
Create Project

Authorizations

Authorization
string
header
required

Team API key created in Team Settings. Use it with URLs for the same team.

Body

application/json
name
string
required
Maximum string length: 255
check_frequency
enum<string>
required
Available options:
manual,
monthly,
weekly,
daily
default_country_code
string
required

ISO 3166-1 alpha-2 code of an active country.

services
string[]
required

Active services (AI platforms) to monitor. Each entry may be either a service UUID or provider slug such as chatgpt or perplexity. Discover both values with GET /api/v1/platforms.

Minimum array length: 1
primary_brand
object
required
prompt_limit
integer | null

Optional per-project prompt limit. Falls back to the team default when omitted.

Required range: 1 <= x <= 1000

Response

The created project.

uuid
string<uuid>
required
name
string
required
check_frequency
enum<string>
required
Available options:
manual,
monthly,
weekly,
daily
project_type
enum<string>
required

Project type. pitch projects run a fixed 7-day collection window and do not consume credits.

Available options:
standard,
pitch
pitch_ends_at
string<date-time> | null
required

End of the 7-day pitch collection window. Only set for pitch projects once their first collection run starts; always null for standard projects. Read-only.

prompt_limit
integer
required

Resolved prompt limit. Falls back to the team default when not explicitly set on the project.

archived_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
default_country
object | null
required
primary_brand
object | null
required
services
object[]
required

Active services (AI platforms) enabled for this project.

share
object
required