Skip to content
Aivah

Developers

Your AI employees, in your app.

Faces, voices, knowledge and memory for your product, from one API key.

terminal
# The AI employees you set up in Aivah
curl https://api.aivah.ai/v1/platform/agents \
  -H "AIVAH_API_KEY: $AIVAH_API_KEY"

# Every reply has the same shape
{
  "message": "…",
  "statusCode": 200,
  "results": [ … ]
}
Employees
Employees in the app: a searchable list of AI employees, each with its kind and a Ready status, and a Hire employee button.
Employees in the app: a searchable list of AI employees, each with its kind and a Ready status, and a Hire employee button.

Platform API

One key, not a vendor stack.

List your AI employees, create one, then start a live, face-to-face session.

  • Create a key under API keys in the account menu.
  • Send it in the AIVAH_API_KEY header with every request.
  • Replies come back as { message, statusCode, results }.
API quickstart
terminal
# List your AI employees
curl https://api.aivah.ai/v1/platform/agents \
  -H "AIVAH_API_KEY: $AIVAH_API_KEY"

# Hire one and teach it from a web page
curl -X POST https://api.aivah.ai/v1/platform/agents \
  -H "AIVAH_API_KEY: $AIVAH_API_KEY" \
  -F name="Front desk" \
  -F agentPrompt="Answer questions about our services and opening hours." \
  -F urls='[{"websiteUrl":"https://yourcompany.com/faq","noOfPages":1}]'

# Start a live, face-to-face session with one
curl -X POST https://api.aivah.ai/v1/platform/sessions/token \
  -H "AIVAH_API_KEY: $AIVAH_API_KEY" \
  -H "content-type: application/json" \
  -d "{\"agentId\": $AGENT_ID, \"llmId\": $MODEL_ID, \"voiceId\": $VOICE_ID}"

In the API

What you build, by API.

The same employees, faces and memory you set up in the workspace.

  • An employee's Knowledge tab in the app: text snippets and web pages it answers from, each Ready.

    AI employees and knowledge.

    Create employees and teach them from files, web pages and text.

  • A presenter in the app: a slide on screen, the presenter beside it, and the transcript of the session.

    Presenters.

    Create presenters and give them the PDFs or videos to present.

  • A live session ready to start: the healthcare demo's character at a clinic front desk.

    Live sessions.

    Get a token for a live conversation with a face and a voice.

  • Characters in the app: Aivah's own character in several styles.

    Voices and characters.

    List or clone voices, and manage characters and backgrounds.

  • Content studio in the app: choose an employee and an output, beside generated slide decks.

    Content.

    Generate slide decks, podcasts and mind maps from what an employee knows.

  • Memory.

    Search, save, update and delete the memory your employees share.

Phone lines, voice agents, messaging apps and meetings are set up in the workspace, not the API. API quickstart

Aivah Assistant

Aivah Assistant, in your app.

Add it with one script tag and one server route.

  • It reads the page, then clicks, fills in fields and navigates for your users.
  • Filling in a field never submits the form.
  • Add your own tools with window.AivahAssistant.registerTool.
See it in the starter kit
index.html
<!-- 1. Add the script -->
<script
  src="https://storage.googleapis.com/aivah-share/aivah-assistant.js"
  data-session="/api/realtime/ai-assistant"
  data-config="/aivah-assistant/assistant.json"
  async
></script>

<!-- 2. Your route at /api/realtime/ai-assistant calls
     POST https://api.aivah.ai/v1/platform/assistant/sessions
     with your AIVAH_API_KEY and returns the session. -->

Website embeds

Or embed it. No code.

Publish a link, a chat bubble or an inline embed from the workspace.

  • One snippet.

    Paste it into any page or app.

  • Browser events.

    Opens, unread messages and call state.

  • Lead capture.

    Details first, then the conversation.

  • Call results, signed.

    Campaigns can send each call's result by webhook.

Add Aivah to your website
Deploy › Web & embeds › Appearance
Editing a web experience in the app: pick a character for the Kestrel Bay Dental demo, see the website preview with a Start voice button, and choose a background.
Editing a web experience in the app: pick a character for the Kestrel Bay Dental demo, see the website preview with a Start voice button, and choose a background.

MCP

MCP, both ways.

Your AI tools share Aivah's memory. Your employees use your MCP servers.

Aivah MCP

One memory across your AI tools.

Claude, ChatGPT and other MCP clients share your employees’ memory.

  • Remote: add connect.aivah.ai/mcp, then sign in.
  • Local: run it with your API key.
mcp.json
{
  "mcpServers": {
    "aivah": {
      "command": "npx",
      "args": ["-y", "@aivahmk/mcp"],
      "env": {
        "AIVAH_API_KEY": "sk_aivah_…",
        "AIVAH_PLATFORM_API_BASE": "https://api.aivah.ai/v1/platform"
      }
    }
  }
}
How shared memory works

MCP tools

Your MCP servers, with approval.

Enable toolkits such as Gmail, GitHub and Notion, or add a custom MCP.

  • Write actions still wait for your approval.
Library › MCP tools
MCP tools in the app: search toolkits, and enable Gmail, GitHub, Google Calendar, Notion or Google Sheets, each with its number of actions. Write actions still need approval.
MCP tools in the app: search toolkits, and enable Gmail, GitHub, Google Calendar, Notion or Google Sheets, each with its number of actions. Write actions still need approval.

Keys and credits

Know the rules up front.

  • Keys stay on your server.

    Call the API from your backend, never from the browser.

    header: AIVAH_API_KEY
  • Shown once.

    Copy the key when you create it, because you won't see it again.

    prefix: sk_aivah_
  • One active key.

    Each account has one active key at a time.

    keys: 1 active per account
  • Expiry you choose.

    Pick 30, 60 or 90 days, or no expiry, and switch a key off any time.

    expiry: 30 | 60 | 90 days | none
  • Room to rotate.

    Regenerate a key and the old one works for 6 more hours.

    overlap: 6 h
  • One credit balance.

    API requests use the same usage credits as the rest of your account.

    billing: usage credits

Questions

Before you build.

  • What isn't in the API?

    Phone lines, voice agents and messaging apps aren't in it, and neither are meetings, publishing or connected apps. You set those up in the workspace.

  • How do I create a presenter through the API?

    Set isPresentationAgent when you create the AI employee, then add the PDFs or videos it presents, up to 10 at a time.

  • Are there webhooks?

    Only voice-agent campaigns send results, by signed webhook. For everything else, call the API from your server, and use the embed's browser events for opens, unread messages and call state.

  • Can my AI employees use my own MCP server?

    Yes. Add a custom MCP in Library › MCP tools. Your employees can then use its actions, and write actions still wait for approval.

Build on Aivah.

Join the waitlist for an API key. The starter kit is on GitHub now.

Free plan · Invites go out a few at a time

Chat with Aivah