MCPBundler Docs
MCPBundler Docs
Back to marketplaceGetting StartedAuthenticationTutorial - Bundle to Connected Agent
API Reference
Agent A2A Tools
Agent Channels
Agent Configuration (Staging)
Agent Configuration (Versions)
Agent Tools
agents
Agents
Attachments
Auth
Billing
bundler
Bundler
Append Conversation Messages (M2M)Append Workflow Run Trace Step (M2M, fail-open)Close Conversation (M2M)Commit Pending Page Action (M2M)Commit Workflow Run Turn (M2M)Create Conversation (M2M)Create Workflow Run (M2M)Dispatch a Matched Tool-Call Webhook (M2M)Exchange A Run Token For A Hand-off Target's Token (M2M)Exchange A Widget Session For A Run Token (M2M)Finalize Call Recording (M2M)Finalize Workflow Run Outputs (M2M, fail-closed on the caller's side)Forget Web Visitor (M2M)Ingest Remote Attachment (M2M)Ingest Request TelemetryLoad Workflow Run State (M2M)Mint Widget Session Token (M2M)Read Own Attachment (M2M)Read Held Original (M2M)Read Web Visitor Thread (M2M)Reconcile Token LedgerRelease Attachments (M2M)Report An Outbound Call Outcome (M2M)Report Per-Leg Latency Samples (M2M)Report Observed Widget Host (M2M)Request Recording Chunk Upload URL (M2M)Resolve Agent (M2M)Resolve Agent Config Snapshot (M2M)Resolve Agent for Inbound A2A (M2M, conditionally authenticated)Resolve Attachments (M2M)Resolve BundleResolve Inbound Channel Credentials (M2M)Resolve Inbound Channel (M2M)Resolve Page Action (M2M)Resolve An Agent's S2S Decision Model (M2M)Resolve Genesys Probe Credentials (M2M)Resolve An Agent's LLM Config (M2M)Resolve The Run's Own Agent (M2M)Resolve Telephony Credential For Outbound Origination (M2M)Resolve Tool-Call Override Bindings (M2M)Resolve Tool-Call Webhook Bindings (M2M)Resolve Visitor Context (M2M)Resolve Public Widget Embed Key (M2M)Resolve Agent Workflow (M2M)Search Agent Knowledge Bases (M2M)Start Call Recording (M2M)Store Conversation Output Variables (M2M)Store Reply Timings (M2M)Store Workflow Node Samples (M2M, fail-open)Submit Conversation Extraction (M2M)Supersede Pending Page Action (M2M)Update Conversation Status (M2M)Upload Attachment (M2M)Search the Web for an Agent (M2M)Record Channel Status (M2M)
Bundler Tool
Bundles
Call Campaigns
Catalog
Conversations
Credentials
Deployments
Discover
Fleet
Genesys
Insights
internal
Knowledge Base Website Sources
Knowledge Bases
MCP Listings
Media
OAuth Clients
OAuth2
Observability
Organisation roles
Organisations
Providers
Reviews
Roadmap
SCIM
Simulation Tests
Suppression
Triggers
TTS
Users
Utils
Visitors
Voices
Webhooks
Workflows
API ReferenceBundler

Exchange A Widget Session For A Run Token (M2M)

POST
/v1/bundler/widget-session/exchange

Issue the widget run token agent-runtime runs a widget conversation with, from the session the browser holds: a signed widget session token, or a legacy widget session BundleAccessToken. The run acts as the session's subject and carries its end user.

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Body of POST /v1/bundler/widget-session/exchange: the agent the session is presented for, which must be the agent it was minted for, and the modality of the run it starts (which bounds the run's life).

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/bundler/widget-session/exchange" \  -H "Content-Type: application/json" \  -d '{    "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",    "modality": "text"  }'
{  "run": {    "token": "string",    "run_id": "string",    "expires_at": "2019-08-24T14:15:22Z",    "deadline_at": "2019-08-24T14:15:22Z"  },  "agent": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "deployment_id": "6ef0ac85-9892-4664-a2a5-58bf2af5a8a6",    "llm_provider_id": "01f100ab-eef6-496a-9799-f8fbf49c6288",    "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",    "system_prompt": "string",    "has_workflow": false,    "event_org_id": "38381290-8ff7-413c-a0d2-e750a21c5122",    "creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",    "first_message": "string",    "state_schema": {},    "evaluation_criteria_defs": []  }}
Empty
Empty
Empty
Empty
{  "detail": [    {      "loc": [        "string"      ],      "msg": "string",      "type": "string"    }  ]}

Exchange A Run Token For A Hand-off Target's Token (M2M)

Previous Page

Finalize Call Recording (M2M)

Next Page

agent_id*Agent Id
Formatuuid
modality*Modality

Value in

  • "text"
  • "voice"