Compte et agent

Lisez le compte et configurez l'employé IA : profil entreprise, ton et apparence.

Compte

GET/v1/account

Forfait, interactions utilisées dans la période en cours, bonus développeur, si les canaux web (chat site et API) sont inclus, domaines autorisés et résumé de l'agent.

{
  "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
  }
}

Profil entreprise

PATCH/v1/agent

Envoyez uniquement les champs à modifier. Les champs omis gardent leur valeur.

Champ	Description
`business_name`	Nom de l'entreprise
`agent_name`	Nom utilisé par l'employé IA
`business_description`	Activité de l'entreprise (jusqu'à 6000 caractères)
`services`	Liste de services ou produits
`prices`	Objet : texte de tarification de l'article
`languages`	Codes langue, par ex. ["pt", "en"] (jusqu'à 6)
`tone`	amical ou formel
`message_style`	court, conversationnel ou détaillé
`conversation_goal`	Objectif de chaque conversation
`restrictions`	Choses que l'agent ne doit jamais faire
`timezone`	Fuseau horaire IANA, par ex. Europe/Lisbon
`country`	Pays de l'entreprise

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

Apparence du chat

PATCH/v1/agent/appearance

Nom, genre (utilisé pour la grammaire en portugais et espagnol), photo, salutation, sous-titre et jusqu'à 4 suggestions rapides par langue (clés 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?"]}
  }'