Conta e agente

Lê a conta e configura o colaborador de IA: perfil do negócio, tom e aparência.

Conta

GET/v1/account

Plano, interações usadas no período atual, bónus de developer, se os canais web (chat do site e API) estão incluídos, domínios autorizados e um resumo do 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 do negócio

PATCH/v1/agent

Envia só os campos que queres mudar. Os que ficarem de fora mantêm o valor.

Campo	Descrição
`business_name`	Nome do negócio
`agent_name`	Nome que o colaborador de IA usa
`business_description`	O que o negócio faz (até 6000 caracteres)
`services`	Lista de serviços ou produtos
`prices`	Objeto: item para texto do preço
`languages`	Códigos de língua, ex.: ["pt", "en"] (até 6)
`tone`	friendly ou formal
`message_style`	short, conversational ou detailed
`conversation_goal`	O que cada conversa deve alcançar
`restrictions`	O que o agente nunca pode fazer
`timezone`	Fuso horário IANA, ex.: Europe/Lisbon
`country`	País do negócio

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."
  }'

Aparência do chat

PATCH/v1/agent/appearance

Nome, género (usado na gramática em português e espanhol), foto, saudação, subtítulo e até 4 sugestões rápidas por língua (chaves 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?"]}
  }'