Skip to main content
POST
/
api
/
v1
/
apps
/
{appId}
/
domains
Create App domain
curl --request POST \
  --url https://app.promptingco.com/api/v1/apps/{appId}/domains \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "domain": "<string>"
}
'
{
  "ok": true,
  "data": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "domain": "<string>",
    "scope": "app",
    "productId": null,
    "appId": "<string>",
    "cloudflareId": "<string>",
    "type": "web",
    "origin": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

Organization-scoped API key. Available scopes:

  • content:read: Read site pages, markdown content, and llms.txt files
  • content:write: Create, update, and delete site pages and content
  • prompts:read: Read prompts, topics, and prompt analysis results
  • prompts:write: Create, update, archive prompts
  • simulations:read: Read agent-simulation tasks, runs, environments, and analytics
  • simulations:write: Create and trigger simulation runs
  • logs:read: Read AI-traffic logs and request-level audit events
  • analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
  • products:read: Read product metadata and competitor data
  • products:write: Update product settings and competitor lists

Path Parameters

appId
string
required
Minimum string length: 1

Body

application/json
domain
string
required
Required string length: 1 - 253
Pattern: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$
type
enum<string>
default:web
Available options:
web,
metric,
redirect
origin
string
Required string length: 1 - 2048

Response

Successful response

ok
enum<boolean>
required
Available options:
true
data
object
required