Passer au contenu principal
POST
Provisionner un site

Autorisations

x-api-key
string
header
requis

Clé API d’authentification. Créez-en une ici.

Corps

application/json

Corps de provisionnement d’un site entièrement configuré

url
string
requis

URL du site. Le protocole (https://) est retiré automatiquement. Les e-mails et URL avec nom d’utilisateur (name@example.com) sont refusés avec 400.

Maximum string length: 2048
Exemple:

"acme.com"

name
string
requis

Nom de marque

Maximum string length: 255
Exemple:

"Acme Corp"

description
string
défaut:""

Description de marque

Exemple:

"Enterprise widgets company"

country
string
défaut:United States

Pays de base du site web

Exemple:

"United States"

language
string

Langue par défaut, déduite du pays si omise (Allemagne → allemand, par exemple), puis anglais en repli.

Exemple:

"English"

industry
string

Catégorie sectorielle. Valeurs courantes : SaaS & Software, E-commerce & Retail, Healthcare & Medical, Information Technology, Banking & Financial Services, Education & E-learning, Consulting, Manufacturing, Hospitality & Travel, Real Estate, etc. Accepte toute chaîne.

Exemple:

"SaaS & Software"

identifiers
string[]

Noms, alias et abréviations de marque pour détecter les mentions. Si vide, générés par IA lors du premier traitement.

Maximum array length: 200
Maximum string length: 500
Exemple:
competitors
object[]

Concurrents à suivre, dédupliqués par URL. L’URL du site lui-même et ses sous-chemins sont ignorés.

Maximum array length: 500
prompts
object[]

Prompts (requêtes) à suivre sur les modèles IA, dédupliqués par texte.

Maximum array length: 10000
schedule
object

Configuration de planification du traitement. Si entièrement omise, aucune planification créée ; l’utilisateur peut la configurer dans l’interface. Tous ses champs sont facultatifs avec des valeurs par défaut adaptées.

external_id
string

Partenaires uniquement. Un identifiant de votre propre système à associer à ce site Athena. Accepté uniquement avec une clé API d’une organisation marquée comme partenaire. L’envoi de ce champ par un client direct renvoie 403 Forbidden. Doit être unique par type de ressource dans votre organisation — les doublons renvoient 409 avec la ressource existante dans la charge utile.

Minimum string length: 1
Exemple:

"ws_a7f3b2c9"

Réponse

Site web provisionné

website
object
requis

Réponse du site provisionné

billingEntityCreated
boolean
requis

Indique si l’entité de facturation existe après provisionnement. Si faux, sa création a échoué même après une nouvelle tentative : le site existe mais n’a pas de crédits, et leur définition échoue avec un statut 400 jusqu’à réparation. Contactez alors l’assistance AthenaHQ.