AgenticUniverse - Previously Formi
  1. Signals
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
      • Post Call Email Configuration
        • Check Email Configuration
        • Set Email Configuration
    • Signals
      • Get Signals List
        GET
      • Add Signal - LEAD
        POST
      • Add Signal - INTERACTION
        POST
    • Get Interaction Summary
      GET
    • Resolve an Escalated Interaction
      POST
    • Get the Interaction list
      GET
    • Get Information regarding Single Interaction
      GET
    • End Interaction
      POST
  • Agent Utilisation
    • Get Credits Available
    • Interaction Utilisation
    • Model Utilisation
  • Webhooks
    • Get webhook URL
    • Update webhook URL
    • Get webhook metadata
    • Modify webhook metadata
    • Get reservation ingestion metadata
  • Reachout Mechanism
    • Campaign Management
      • Campaigns List
      • Campaign Details
      • Create Campaign
      • Batch Schedule Interaction for Leads
      • Quick Schedule
      • Single Campaign Report
    • Lead Management
      • Upload Leads
      • Upload Leads - Status
      • Get Leads List
  • Untitled Endpoint
    GET
  • Add Signal
    POST
  • Schemas
    • Schemas
      • Schemas
        • CreateEdgeWithTemplateDTO
        • UpdateEdgeWithTemplateDTO
        • EdgeDetails
      • WebhookUrlRequest
      • InteractionSummaryCard
      • InteractionInfo
      • CreateVendorPayload
      • WebhookMetadataRequest
      • InteractionSummaryPayload
      • CustomerDetails
      • Vendor
      • SuccessResponse
      • InteractionSummaryResponse
      • InteractionDetails
      • ConnectionConfig
      • ErrorResponse
      • GenericSuccessResponse
      • SuccessResponseVendorList
      • SuccessResponseSingleVendor
      • SuccessResponseAgentConfig
    • Response
      • Unauthorized
      • NotFound
      • ServerError
    • Add Calls Payload
  1. Signals

Add Signal - INTERACTION

Developing
Staging Env
https://staging-api.formi.co.in
Staging Env
https://staging-api.formi.co.in
POST
https://staging-api.formi.co.in
/v2/signals/agents/{agent_id}/signals
Last modified:2025-12-29 07:19:07
Maintainer:Not configured

Request

Path Params

Header Params

Body Params application/json

Example
{
    "name":"Agreed to Share Media",
    "prompt":"## Parameter to Evaluate:\n**Parameter Name:** `agreed_to_share_media`\n**Type:** Boolean (True/False)\n**Definition:** Identify if the prospect disputes the technician's on-site evaluation and then gives a clear, affirmative response to the agent's suggestion to send photos or videos via whatsapp for a re-evaluation.\n\n## Cues to Detect:\n- Prospect disagrees with the damage/condition report (e.g., \"The screen is not damaged\"\").\n- Agent proposes an email-based review/re-evaluation.\n- Prospect explicitly agrees to send the requested evidence on whatsapp\n\n## INCLUDE:\n- Agent: \"Could you please send some photos to our email?\" Prospect: \"Yes, I will do that.\"\n- \"Okay, tell me the email address. I will send the video right now.\"\n- \"Sure, I can send the pictures to you.\"\n\n## EXCLUDE:\n- Disputing the report but refusing to send images on whatsapp.\n- No requesting of media over whatsapp made by the agent.\n\n## Instructions:\n1.  **Analyze the Transcript:** Ensure a dispute exists first, followed by an agent's suggestion for email evidence.\n2.  **Determine the Value:** Assign **True** only if the prospect confirms they will send the media/images on whatsapp. Assign **False** if they hesitate, refuse, or if the offer was never made.\n3.  **Formulate Reasoning:** Quote the prospect's affirmative agreement to send the photos/videos.\n\n## Output Instructions:\nReturn a dictionary containing exactly two keys. The **\"reason\"** key must come first, followed by the **\"value\"**.\n- 'reason': A short text explanation (String).\n- 'value': The result of the evaluation (Boolean).\n\n### Example Output:\n\n{\n  \"reason\": \"The prospect disputed the screen damage report and explicitly agreed to send photos for review by saying 'Yes, I will do that.'\",\n  \"value\": true\n}\n",
    "type":"CUSTOM_INTERACTION",
    "description":"Whether the person agreed to share media or not."
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://staging-api.formi.co.in/v2/signals/agents/64/signals' \
--header 'token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTQ4N30.5C1-y4YCN6XvBEYXr1oRKLNUXfwbGch9DqyIiplzU70' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name":"Agreed to Share Media",
    "prompt":"## Parameter to Evaluate:\n**Parameter Name:** `agreed_to_share_media`\n**Type:** Boolean (True/False)\n**Definition:** Identify if the prospect disputes the technician'\''s on-site evaluation and then gives a clear, affirmative response to the agent'\''s suggestion to send photos or videos via whatsapp for a re-evaluation.\n\n## Cues to Detect:\n- Prospect disagrees with the damage/condition report (e.g., \"The screen is not damaged\"\").\n- Agent proposes an email-based review/re-evaluation.\n- Prospect explicitly agrees to send the requested evidence on whatsapp\n\n## INCLUDE:\n- Agent: \"Could you please send some photos to our email?\" Prospect: \"Yes, I will do that.\"\n- \"Okay, tell me the email address. I will send the video right now.\"\n- \"Sure, I can send the pictures to you.\"\n\n## EXCLUDE:\n- Disputing the report but refusing to send images on whatsapp.\n- No requesting of media over whatsapp made by the agent.\n\n## Instructions:\n1.  **Analyze the Transcript:** Ensure a dispute exists first, followed by an agent'\''s suggestion for email evidence.\n2.  **Determine the Value:** Assign **True** only if the prospect confirms they will send the media/images on whatsapp. Assign **False** if they hesitate, refuse, or if the offer was never made.\n3.  **Formulate Reasoning:** Quote the prospect'\''s affirmative agreement to send the photos/videos.\n\n## Output Instructions:\nReturn a dictionary containing exactly two keys. The **\"reason\"** key must come first, followed by the **\"value\"**.\n- '\''reason'\'': A short text explanation (String).\n- '\''value'\'': The result of the evaluation (Boolean).\n\n### Example Output:\n\n{\n  \"reason\": \"The prospect disputed the screen damage report and explicitly agreed to send photos for review by saying '\''Yes, I will do that.'\''\",\n  \"value\": true\n}\n",
    "type":"CUSTOM_INTERACTION",
    "description":"Whether the person agreed to share media or not."
}'

Responses

🟢200Success
application/json
Body

Example
{}
Modified at 2025-12-29 07:19:07
Previous
Add Signal - LEAD
Next
Get Interaction Summary
Built with