API Reference

This section provides comprehensive documentation for Ema's Builder Platform APIs. Use these references to integrate with Ema programmatically, manage AI Employees, orchestrate workflows, handle chat interactions, operate dashboards, and generate documents.

Getting Started

• Getting Started -- REST API quickstart covering authentication, tenant setup, AI Employee creation, chat, and dashboard interaction.
• Authentication -- How to generate API keys and access tokens.
• Tenant Management -- Create and manage tenants in Ema's hierarchy.

AI Employees

• AI Employee Overview -- Core concepts: AI Employees, templates, categories, behavior types, widgets, and trigger types.
• AI Employee Data Model -- PersonaConfig, Widget, WidgetType enum, DisplaySettings, and ProjectSettings structures.
• AI Employee API -- Create, update, retrieve, and manage AI Employees.
• Template API -- Create, update, and manage AI Employee templates with access control.

Workflows

• Workflow Overview -- Core concepts: workflows, actions, input bindings, execution flow, and outputs.
• Workflow Data Model -- WorkflowDef, ActionInstance, InputBinding, Tool, Condition, TypeReference, and EnumType structures.
• Action Data Model -- ActionType, ActionCategory, InputDef, OutputDef, WellKnownType, and Value system.
• Workflow API -- List actions, query workflow structure, and retrieve edge candidates.

Chat

• Chat Overview -- Conversations, messages, snippets, source attribution, and platform integrations.
• Chat Data Model -- ChatbotMessage, MessageType, TextMessage, ButtonsMessage, FormMessage, FeedbackMessage, and Snippet types.
• Chat API -- Create conversations, send messages, retrieve history, and collect feedback.

Dashboard

• Dashboard Overview -- Structure, rows, columns, states, HITL support, and use cases.
• Dashboard Data Model -- DashboardRow, DashboardRowState, ColumnValue, ColumnDetails, ColumnType, and DashboardSchema.
• Dashboard HTTP API -- REST endpoints for row upload, triggering, results, and HITL continuation.
• Dashboard RPC Calls -- gRPC-Web endpoints for dashboard row and workflow operations.

Document Generation

• Document Generation Overview -- Async document lifecycle, statuses, and use cases.
• Document Generation API -- Create, retrieve, regenerate, and update documents.

Miscellaneous

• Miscellaneous APIs -- File upload and pre-signed URL endpoints.
• Handling gRPC-Web Requests -- Step-by-step guide for making gRPC-Web calls with curl.
• Access Token for Root Tenant API Key -- How to obtain an initial access token for first-time API setup.
• Debug Worklogs API -- Retrieve workflow-level debug logs and show-work data.

Triggers

• Triggering AI Employees -- Set up recurring and event-based triggers to invoke AI Employees from external platforms.