Cuenta y agente

Lee la cuenta y configura el empleado de IA: perfil del negocio, tono y apariencia.

Cuenta

GET/v1/account

Plan, interacciones usadas en el periodo actual, bono de desarrollador, si los canales web (chat del sitio y API) están incluidos, dominios autorizados y un resumen del agente.

{
  "object": "account",
  "plan": "growth",
  "interactions": { "used_this_period": 412, "plan_limit": 2000, "period": "30 days" },
  "developer_bonus": { "active": false },
  "web_channels_available": true,
  "business": { "name": "Quinta do Vale", "email": "[email protected]" },
  "allowed_domains": ["quintadovale.pt"],
  "agent": {
    "business_name": "Quinta do Vale",
    "agent_name": "ORYKSA",
    "has_description": true,
    "services": ["Wine tasting", "Winery visits"],
    "languages": "pt,en",
    "site_content_chars": 22915,
    "site_pages": 5,
    "faq_items": 4
  }
}

Perfil del negocio

PATCH/v1/agent

Envía solo los campos que quieras cambiar. Los que no envíes mantienen su valor.

Campo	Descripción
`business_name`	Nombre del negocio
`agent_name`	Nombre que usa el empleado de IA
`business_description`	Qué hace el negocio (hasta 6000 caracteres)
`services`	Lista de servicios o productos
`prices`	Objeto: elemento a texto del precio
`languages`	Códigos de idioma, p. ej. ["es", "en"] (hasta 6)
`tone`	friendly o formal
`message_style`	short, conversational o detailed
`conversation_goal`	Qué debe lograr cada conversación
`restrictions`	Lo que el agente nunca puede hacer
`timezone`	Zona horaria IANA, p. ej. Europe/Madrid
`country`	País del negocio

curl -X PATCH https://api.oryksa.com/v1/agent \
  -H "Authorization: Bearer oryk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "business_name": "Quinta do Vale",
    "agent_name": "ORYKSA",
    "business_description": "Family winery in the Douro valley, Portugal.",
    "services": ["Wine tasting", "Winery visits", "Online shop"],
    "prices": {"Tasting": "15 EUR per person"},
    "languages": ["pt", "en", "es"],
    "tone": "friendly",
    "message_style": "conversational",
    "conversation_goal": "Book visits and sell wine.",
    "restrictions": "Never promise delivery dates outside the EU."
  }'

Apariencia del chat

PATCH/v1/agent/appearance

Nombre, género (usado en la gramática en portugués y español), foto, saludo, subtítulo y hasta 4 sugerencias rápidas por idioma (claves pt, br, en, es).

curl -X PATCH https://api.oryksa.com/v1/agent/appearance \
  -H "Authorization: Bearer oryk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_name": "ORYKSA",
    "gender": "female",
    "avatar_url": "https://quintadovale.pt/oena.png",
    "greeting": {"en": "Hi! I am ORYKSA, the wine expert. How can I help?", "pt": "Olá! Sou a ORYKSA. Em que posso ajudar?"},
    "suggestions": {"en": ["Book a visit", "Which wines do you make?"]}
  }'