Saltar al contenido principal
POST
Iniciar obtención de respuestas

Autorizaciones

x-api-key
string
header
requerido

Clave de API para autenticarse. Puedes crear una aquí.

Cuerpo

application/json
website_id
string<uuid>
requerido

Sitio web en el que se obtendrán respuestas.

schedule_id
string<uuid>

UUID de la programación a la que se atribuirá la ejecución y de la que se tomarán los selectores de consultas. Una selección prompt_ids no vacía los sustituye. Omítelo para atribuirla a la predeterminada y ejecutar todas las consultas activas, salvo que se indique prompt_ids. Las opciones explícitas de modelos, expansión, perfiles y ubicaciones se aplican a esta ejecución. La programación debe pertenecer al sitio y no estar archivada.

prompt_ids
string<uuid>[]

UUID de consultas monitorizadas que se ejecutarán, entre 1 y 1.000. Si se indican, sustituyen a los selectores de la programación. Omítelos para usar los de schedule_id, o todas las consultas activas si también se omite schedule_id. Se omiten las pausadas.

selected_models
object

Mapa de ID de modelo a indicador de activación (p. ej., { "ai_overview": true, "ai_mode": false }). ID: chatgpt, ai_overview (Google AI Overviews; también acepta google_ai_overview, su nombre en los filtros), perplexity, gemini, copilot, ai_mode, grok, claude, deepseek, meta_ai, mistral. Omítelo para ejecutar todos los modelos activos; no es la selección predeterminada guardada del panel. Un ID desconocido con true devuelve 400, al igual que una selección explícita sin modelos disponibles.

prompt_variations
integer

Número de variantes parafraseadas que se generarán por consulta (0–10).

Rango requerido: 0 <= x <= 10
use_personas
boolean

Indica si las consultas se ejecutarán con los perfiles de audiencia configurados.

use_locations
boolean

Indica si las consultas se ejecutarán en las ubicaciones configuradas del sitio web.

only_locations
boolean

Si es true, omite la ejecución base (sin localización) y ejecuta solo las variantes por ubicación. Requiere use_locations: true: enviar only_locations: true sin use_locations: true no encola nada (se omite la base y no se añaden variantes), así que la ejecución termina sin realizar operaciones.

Respuesta

Ejecución iniciada

workflow_id
string
requerido
status
enum<string>
requerido
Opciones disponibles:
running