Sign in

v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB
Basics

Provision Website

Creates a fully configured website in a single call, skipping the onboarding wizard. Optionally configures competitors, prompts, and a processing schedule. Requires a global API key. Partner integrations may include an external_id to map their own identifier onto the new Athena website.

Beta: This endpoint is in beta. The request and response schemas may change.

post/api/v1/websites/provision

Request body

urlstring required

Website URL. Protocol (https://) is stripped automatically.

namestring required

Brand name

descriptionstring

Brand description

countrystring

Base country for the website

languagestring

Default language. If omitted, derived from country (e.g., Germany → German). Falls back to English.

industrystring

Industry category. Common values: SaaS & Software, E-commerce & Retail, Healthcare & Medical, Information Technology, Banking & Financial Services, Education & E-learning, Consulting, Manufacturing, Hospitality & Travel, Real Estate, and more. Accepts any string.

identifiersstring[]

Brand names, aliases, and abbreviations used for mention detection. If empty, auto-generated by AI on the first processing run.

external_idstring

Partner-only. An identifier from your own system to map to this Athena website. Accepted only when authenticating with an API key for an organization flagged as a partner. Sending this field as a direct customer returns 403 Forbidden. Must be unique per resource type within your organization — duplicates return 409 with the existing resource in the payload.

Example request

{
  "url": "acme.com",
  "name": "Acme Corp",
  "description": "Enterprise widgets company",
  "country": "United States",
  "language": "English",
  "industry": "SaaS & Software",
  "identifiers": [
    "Acme",
    "Acme Corp"
  ],
  "competitors": [
    {
      "name": "WidgetCo",
      "url": "widgetco.com",
      "identifiers": [
        "WidgetCo"
      ]
    }
  ],
  "prompts": [
    {
      "text": "best widget software",
      "topic": "Products",
      "type": "discovery"
    }
  ],
  "schedule": {
    "days": {
      "Monday": true,
      "Wednesday": true,
      "Friday": true
    },
    "models": {
      "chatgpt": true,
      "gemini": true,
      "perplexity": true
    }
  },
  "external_id": "ws_a7f3b2c9"
}

Response

Website provisioned successfully

billingEntityCreatedboolean required

Whether the billing entity exists after provisioning. When false, entity creation failed even after a retry: the website exists but has no credits, and setting credits fails with a 400 until it is repaired. Contact AthenaHQ support in that case.

Example response

{
  "website": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "url": "acme.com",
    "name": "Acme Corp",
    "orgId": "987e6543-e21b-12d3-a456-426614174000",
    "promptCount": 2,
    "competitorCount": 1,
    "hasSchedule": true,
    "externalId": "ws_a7f3b2c9"
  }
}