Configurar sitio web
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"
}
'import requests
url = "https://api.athenahq.ai/api/v1/websites/provision"
payload = {
"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"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};
fetch('https://api.athenahq.ai/api/v1/websites/provision', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.athenahq.ai/api/v1/websites/provision",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.athenahq.ai/api/v1/websites/provision"
payload := strings.NewReader("{\n \"url\": \"acme.com\",\n \"name\": \"Acme Corp\",\n \"description\": \"Enterprise widgets company\",\n \"country\": \"United States\",\n \"language\": \"English\",\n \"industry\": \"SaaS & Software\",\n \"identifiers\": [\n \"Acme\",\n \"Acme Corp\"\n ],\n \"competitors\": [],\n \"prompts\": [],\n \"schedule\": {\n \"days\": {\n \"Monday\": true,\n \"Wednesday\": true,\n \"Friday\": true\n },\n \"models\": {\n \"chatgpt\": true,\n \"gemini\": true,\n \"perplexity\": true\n },\n \"isActive\": true,\n \"processingHour\": 11\n },\n \"external_id\": \"ws_a7f3b2c9\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.athenahq.ai/api/v1/websites/provision")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"acme.com\",\n \"name\": \"Acme Corp\",\n \"description\": \"Enterprise widgets company\",\n \"country\": \"United States\",\n \"language\": \"English\",\n \"industry\": \"SaaS & Software\",\n \"identifiers\": [\n \"Acme\",\n \"Acme Corp\"\n ],\n \"competitors\": [],\n \"prompts\": [],\n \"schedule\": {\n \"days\": {\n \"Monday\": true,\n \"Wednesday\": true,\n \"Friday\": true\n },\n \"models\": {\n \"chatgpt\": true,\n \"gemini\": true,\n \"perplexity\": true\n },\n \"isActive\": true,\n \"processingHour\": 11\n },\n \"external_id\": \"ws_a7f3b2c9\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/websites/provision")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"acme.com\",\n \"name\": \"Acme Corp\",\n \"description\": \"Enterprise widgets company\",\n \"country\": \"United States\",\n \"language\": \"English\",\n \"industry\": \"SaaS & Software\",\n \"identifiers\": [\n \"Acme\",\n \"Acme Corp\"\n ],\n \"competitors\": [],\n \"prompts\": [],\n \"schedule\": {\n \"days\": {\n \"Monday\": true,\n \"Wednesday\": true,\n \"Friday\": true\n },\n \"models\": {\n \"chatgpt\": true,\n \"gemini\": true,\n \"perplexity\": true\n },\n \"isActive\": true,\n \"processingHour\": 11\n },\n \"external_id\": \"ws_a7f3b2c9\"\n}"
response = http.request(request)
puts response.read_body{
"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
},
"billingEntityCreated": true
}
Sitios web
Configurar sitio web
Crea un sitio web totalmente configurado en una llamada, omitiendo el asistente inicial. Opcionalmente configura competidores, consultas y programación de procesamiento. Requiere una clave global. Las integraciones de socios pueden incluir external_id para vincular su identificador al nuevo sitio de Athena. La creación también aprovisiona su programación predeterminada de consultas en la misma transacción.
Beta: Este endpoint está en beta. Los esquemas de solicitud y respuesta pueden cambiar. Los patrones de monitorización del sitio y competidores conservan host, mayúsculas de ruta y restricciones de consulta. Los dominios raíz incluyen su forma www; los hosts www explícitos siguen siendo distintos. Las rutas delimitan secciones por barras.
POST
/
api
/
v1
/
websites
/
provision
Configurar sitio web
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"
}
'import requests
url = "https://api.athenahq.ai/api/v1/websites/provision"
payload = {
"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"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};
fetch('https://api.athenahq.ai/api/v1/websites/provision', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.athenahq.ai/api/v1/websites/provision",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.athenahq.ai/api/v1/websites/provision"
payload := strings.NewReader("{\n \"url\": \"acme.com\",\n \"name\": \"Acme Corp\",\n \"description\": \"Enterprise widgets company\",\n \"country\": \"United States\",\n \"language\": \"English\",\n \"industry\": \"SaaS & Software\",\n \"identifiers\": [\n \"Acme\",\n \"Acme Corp\"\n ],\n \"competitors\": [],\n \"prompts\": [],\n \"schedule\": {\n \"days\": {\n \"Monday\": true,\n \"Wednesday\": true,\n \"Friday\": true\n },\n \"models\": {\n \"chatgpt\": true,\n \"gemini\": true,\n \"perplexity\": true\n },\n \"isActive\": true,\n \"processingHour\": 11\n },\n \"external_id\": \"ws_a7f3b2c9\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.athenahq.ai/api/v1/websites/provision")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"acme.com\",\n \"name\": \"Acme Corp\",\n \"description\": \"Enterprise widgets company\",\n \"country\": \"United States\",\n \"language\": \"English\",\n \"industry\": \"SaaS & Software\",\n \"identifiers\": [\n \"Acme\",\n \"Acme Corp\"\n ],\n \"competitors\": [],\n \"prompts\": [],\n \"schedule\": {\n \"days\": {\n \"Monday\": true,\n \"Wednesday\": true,\n \"Friday\": true\n },\n \"models\": {\n \"chatgpt\": true,\n \"gemini\": true,\n \"perplexity\": true\n },\n \"isActive\": true,\n \"processingHour\": 11\n },\n \"external_id\": \"ws_a7f3b2c9\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/websites/provision")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"acme.com\",\n \"name\": \"Acme Corp\",\n \"description\": \"Enterprise widgets company\",\n \"country\": \"United States\",\n \"language\": \"English\",\n \"industry\": \"SaaS & Software\",\n \"identifiers\": [\n \"Acme\",\n \"Acme Corp\"\n ],\n \"competitors\": [],\n \"prompts\": [],\n \"schedule\": {\n \"days\": {\n \"Monday\": true,\n \"Wednesday\": true,\n \"Friday\": true\n },\n \"models\": {\n \"chatgpt\": true,\n \"gemini\": true,\n \"perplexity\": true\n },\n \"isActive\": true,\n \"processingHour\": 11\n },\n \"external_id\": \"ws_a7f3b2c9\"\n}"
response = http.request(request)
puts response.read_body{
"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
},
"billingEntityCreated": true
}
Cuerpo
application/json
Cuerpo de la solicitud para aprovisionar un sitio web totalmente configurado
URL del sitio web. El protocolo (https://) se elimina automáticamente. Las direcciones de correo y otras URL con nombre de usuario (name@example.com) se rechazan con 400.
Maximum string length:
2048Ejemplo:
"acme.com"
Nombre de la marca
Maximum string length:
255Ejemplo:
"Acme Corp"
Descripción de la marca
Ejemplo:
"Enterprise widgets company"
País de base del sitio web
Ejemplo:
"United States"
Idioma predeterminado. Si se omite, se deduce del país (p. ej., Alemania → alemán). Como alternativa, se utiliza el inglés.
Ejemplo:
"English"
Categoría del sector. Valores habituales: SaaS & Software, E-commerce & Retail, Healthcare & Medical, Information Technology, Banking & Financial Services, Education & E-learning, Consulting, Manufacturing, Hospitality & Travel, Real Estate, entre otros. Acepta cualquier cadena.
Ejemplo:
"SaaS & Software"
Nombres, alias y abreviaturas de marca utilizados para detectar menciones. Si está vacío, la IA los genera automáticamente en la primera ejecución del procesamiento.
Maximum array length:
200Maximum string length:
500Ejemplo:
["Acme", "Acme Corp"]
Competidores que se monitorizarán. Se eliminan duplicados por URL. Se omiten las entradas con la URL del propio sitio web o una ruta suya.
Maximum array length:
500Show child attributes
Show child attributes
Consultas que se monitorizarán en los modelos de IA. Se eliminan duplicados por texto.
Maximum array length:
10000Show child attributes
Show child attributes
Configuración de la programación del procesamiento. Si se omite por completo, no se crea ninguna programación; el usuario puede configurarla en la interfaz. Todos sus campos son opcionales y tienen valores predeterminados adecuados.
Show child attributes
Show child attributes
Solo socios. Identificador de tu sistema que se vinculará a este sitio web de Athena. Solo se admite con una clave de API de una organización marcada como socio. Los clientes directos reciben 403 Forbidden. Debe ser único por tipo de recurso en tu organización; los duplicados devuelven 409 con el recurso existente en los datos de respuesta.
Minimum string length:
1Ejemplo:
"ws_a7f3b2c9"
Respuesta
Sitio web configurado correctamente
Respuesta del sitio web configurado
Show child attributes
Show child attributes
Indica si existe la entidad de facturación tras el aprovisionamiento. Si es false, su creación ha fallado incluso tras reintentar: el sitio existe sin créditos y configurarlos devuelve 400 hasta repararlo. En ese caso, contacta con soporte de AthenaHQ.
¿Esta página le ayudó?