AgenticUniverse - Previously Formi
  1. Interactions
AgenticUniverse - Previously Formi
  • Our Technical Note
    • Why Open AI is not Enough
    • How business Outcomes would Change Radically with AgenticUniverse
    • Our Research
      • STT - Nuances and Insights
      • Solving for STT Constraints
  • Generate Token
    • Login/Generate Token
      POST
  • Agent Configuration
    • Model Configuration
      • Configuration Helpers
        • Supported Providers
        • Supported Models
        • Supported Parameters
      • Get Model Configuration
      • Set Model Configuration
    • State Machine
      • Edge
        • Legacy
          • Create Edge
          • Edge Details
          • Update Edge
          • Delete Edge
        • Update edge properties
        • Get edge details
        • Delete an edge
        • Create an edge (transition) between two states
      • State
        • Create State from Template
        • Get State Information
        • Update State
        • Delete State
      • Get State Machine Structure
    • Prompt Templates
      • Get All Templates
      • Render Template
    • Tools
      • Get Tools List
      • Add Tool
      • Update Tool
      • Delete Tool
    • Get All Agents
      GET
    • Single Agent Details
      GET
    • Create Agent
      POST
    • Update Agent Details
      PUT
    • Enable Dashboard For An Outlet
      POST
    • Disable Dashboard For An Outlet
      POST
    • Get Call queue Sheet ID
      GET
  • Interactions
    • Pre-Interaction Context
      • Schedule an Interaction
      • Update an Interaction Id
      • Delete an Interaction Id
      • Clear all interactions
      • Get Summarized Interaction Info
    • Interaction Modalities
      • Video
        • Generation
          • Generate Welcome Video
      • Text
        • Start Interaction
        • Create Response
        • End Interaction
      • Voice
        • Connection Configuration
          • Quickstart
          • Connecting Twilio
          • Connecting Exotel
          • Formi WebSocket Configuration Guide
          • Create a New Connection Vendor
          • Get All Connection Vendors
          • Update a Connection Vendor
          • Delete a Connection Vendor
          • Get Agent's Connection Config
          • Add or Update Agent's Connection Config
    • Post Interaction Configuration
      • Email Destination Configuration
      • Variables CRUD
        • Get all required variables for the outlet with map
        • Modify variable definition for outlet
        • Add a new variable for the outlet
        • DELETE variable for outlet
        • Connect Variable to a destination
      • Destinations CRUD
        • Get all destinations for the outlet
        • Modify Destination for outlet
        • Add a new Destination for the outlet
        • DELETE Destinations for outlet
    • Get Interaction Summary
      GET
    • Resolve an Escalated Interaction
      POST
    • Get the Interaction list
      GET
    • Get Information regarding Single Interaction
      GET
  • Agent Utilisation
    • Get Credits Available
      GET
    • Interaction Utilisation
      GET
    • Model Utilisation
      GET
  • Webhooks
    • Get webhook URL
    • Update webhook URL
    • Get webhook metadata
    • Modify webhook metadata
    • Get reservation ingestion metadata
  • Untitled Endpoint
    POST
  1. Interactions

Pre-Interaction Context

1. Overview#

Pre-Call Configuration is essentially context provided to the agent before a conversation begins. It integrates data from external sources like CRMs, Excel sheets, or APIs, enabling Formi agents to automate retries, schedule follow-ups, and send updates—all without engineering support.

2. Purpose#

The goal of this system is to enhance the personalization of customer interactions by:
Enabling context-aware interactions where the AI agent knows the user's name and preferences beforehand
Facilitating outbound calls by an AI agent that can adapt to user-specific contexts
Reducing manual pre-call setup through reusable configurations
Streamlining integration with third-party systems via webhooks and APIs
This ensures every interaction is personalized, engaging, and aligned with user expectations.

3. Data Flow Overview#

Pre-Call Ingestion Flow
1.
Source (CRM/API/Excel) pushes context to Formi via an API call.
2.
Formi creates an interaction record with the specified schedule and retry logic.
3.
The interaction is executed at the scheduled time using an AUTO_START (refers to follow up interactions ) or BIZ_START(refers to the ones triggered thru /schedule API) trigger.
4.
After the interaction concludes, outcomes are logged and shared with configured destination systems.

4. Configurable Fields (CRUD Endpoints)#

Refer this API endpoint for understanding the configurable fields:
POST /v2/pre_call/data/schedule
Refer the Webhook documentation for understanding the events that are sent to track the Call Queue System
Webhook Documentation

5. Source Integration and Sheet Logic#

Excel Sheet Structure#

PENDING: Contains all new leads that need to be called.
ONGOING: Contains all interactions that are currently in progress or require a follow-up.
COMPLETE: Contains all interactions that have been resolved or marked as closed.
Refer this example sheet for getting an overview of this Google Sheets System

7. API Contracts#

1. Schedule API#

[POST /v2/pre_call/data/schedule](Schedule an Interaction)
Adds a new interaction to the queue with all required context and scheduling information.

2. Get Interaction List API#

[GET /v2/pre_call/data/list](Get the Interaction list)
Retrieves a list of interactions, with filters for contact_id, name, phone_number, etc.

3. Update Interaction API#

[PUT /v2/pre_call/data/update](Update an Interaction Id)
Modifies an existing interaction, such as changing the scheduled time or updating metadata.

4. Delete Interaction API#

[DELETE /v2/pre_call/data/delete](Delete an Interaction Id)
Removes a scheduled interaction from the queue.

5. Clear Interactions API#

[POST /v2/interactions/clear](Clear all interactions)
Clears all interactions for a given outlet that occurred before a specified interaction ID.

6. Get Interaction by ID API#

[GET /v2/interactions/{interaction_id}](Get Information regarding Single Interaction)
Retrieves detailed information for a specific interaction using its unique interaction ID.
Modified at 2025-07-04 12:11:04
Previous
Get Call queue Sheet ID
Next
Schedule an Interaction
Built with