Account and agent

Read the account and configure the AI employee: business profile, tone and appearance.

Account

GET/v1/account

Plan, interactions used in the current period, developer bonus, whether web channels (website chat and API) are included, allowed domains and a summary of the 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
  }
}

Business profile

PATCH/v1/agent

Send only the fields you want to change. Fields you leave out keep their value.

Field	Description
`business_name`	Business name
`agent_name`	Name the AI employee uses
`business_description`	What the business does (up to 6000 characters)
`services`	List of services or products
`prices`	Object: item to price text
`languages`	Language codes, e.g. ["pt", "en"] (up to 6)
`tone`	friendly or formal
`message_style`	short, conversational or detailed
`conversation_goal`	What each conversation should achieve
`restrictions`	Things the agent must never do
`timezone`	IANA time zone, e.g. Europe/Lisbon
`country`	Country of the business

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

Appearance of the chat

PATCH/v1/agent/appearance

Name, gender (used for grammar in Portuguese and Spanish), photo, greeting, subtitle and up to 4 quick suggestions per language (keys 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?"]}
  }'