Skip to main content
POST
/
api
/
v1
/
websites
/
provision
Provision Website
curl --request POST \
  --url https://api.athenahq.ai/api/v1/websites/provision \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "acme.com",
  "name": "Acme Corp",
  "description": "Enterprise widgets company",
  "country": "United States",
  "language": "English",
  "industry": "SaaS & Software",
  "identifiers": [
    "Acme",
    "Acme Corp"
  ],
  "competitors": [],
  "prompts": [],
  "schedule": {
    "days": {
      "Monday": true,
      "Wednesday": true,
      "Friday": true
    },
    "models": {
      "chatgpt": true,
      "gemini": true,
      "perplexity": true
    },
    "isActive": true,
    "processingHour": 11
  },
  "external_id": "ws_a7f3b2c9"
}
'
{
  "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
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.athenahq.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication. You can create one here.

Body

application/json

Request body for provisioning a fully configured website

​
url
string
required

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

Example:

"acme.com"

​
name
string
required

Brand name

Example:

"Acme Corp"

​
description
string
default:""

Brand description

Example:

"Enterprise widgets company"

​
country
string
default:United States

Base country for the website

Example:

"United States"

​
language
string

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

Example:

"English"

​
industry
string

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.

Example:

"SaaS & Software"

​
identifiers
string[]

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

Example:
["Acme", "Acme Corp"]
​
competitors
object[]

Competitors to track. Deduplicated by URL.

​
prompts
object[]

Prompts (queries) to monitor across AI models. Deduplicated by text.

​
schedule
object

Processing schedule configuration. If omitted entirely, no schedule is created — the user can configure one via the UI. All fields within the schedule are optional with sensible defaults.

​
external_id
string

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.

Minimum string length: 1
Example:

"ws_a7f3b2c9"

Response

Website provisioned successfully

​
website
object
required

The provisioned website response