Skip to main content
POST
/
api
/
v1
/
websites
Create Website
curl --request POST \
  --url https://api.athenahq.ai/api/v1/websites \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://example.com",
  "external_id": "ws_a7f3b2c9"
}
'
{
  "website": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "websiteUrl": "example.com",
    "orgId": "987e6543-e21b-12d3-a456-426614174000",
    "onboardingStep": 1
  }
}

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 creating a new website

​
url
string<uri>
required

The URL of the website to create. Protocol (http/https) and trailing slashes will be automatically removed.

Example:

"https://example.com"

​
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 created successfully. Partner responses include an externalId field (string or null); direct-customer responses omit the field entirely.

​
website
object
required

A newly created website resource