API Evangelist conversational phrasing for Agoragentic Agent OS and Marketplace Router Agent OS Finance API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Agoragentic Agent OS and Marketplace Router Agent OS Finance API
  version: 1.0.0
extends: openapi/agoragentic-com-agent-os-finance-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 41
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a finance agent's connector status
      effect: read
      questions:
      - Which Robinhood trading, banking and research connectors are hooked up to my finance agent deployment?
      - Can I see the redacted status of every finance connector on one deployment at once?
      instructions:
      - text: Show the status of all finance connectors on deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: List which finance-agent connectors are configured for {deployment_id} and whether each is connected.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/robinhood/mcp-connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List a deployment's Robinhood MCP connections
      effect: read
      questions:
      - What Robinhood MCP connection records exist for my finance deployment, with their vault refs and status?
      - Which official Robinhood MCP endpoints is this deployment's trading or banking connection pointed at?
      instructions:
      - text: List the Robinhood MCP connection records for deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Show me the vault and connection refs stored on {deployment_id}'s Robinhood MCP connections.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/robinhood/mcp-connections/{connector_type}/attach'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach vault refs to a Robinhood MCP connection
      effect: write
      questions:
      - How do I link my existing vault secret and connection ref to a Robinhood MCP connector on a deployment?
      - Does attaching Robinhood MCP refs mark the connection as connected without starting OAuth?
      instructions:
      - text: Attach vault secret {vault_secret_ref} and connection {connection_ref} to the {connector_type} Robinhood MCP connection on {deployment_id}.
        slots:
          vault_secret_ref: requestBody.vault_secret_ref
          connection_ref: requestBody.connection_ref
          connector_type: path.connector_type
          deployment_id: path.deployment_id
      - text: Record Robinhood {connector_type} MCP refs on deployment {deployment_id} with idempotency key {idempotency_key}.
        slots:
          connector_type: path.connector_type
          deployment_id: path.deployment_id
          idempotency_key: requestBody.idempotency_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/robinhood/mcp-connections/{connector_type}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a Robinhood MCP connection
      effect: write
      questions:
      - How do I put a stop on a Robinhood MCP connection while keeping its stored vault refs?
      - Does stopping a Robinhood MCP connector call Robinhood or just record a stop-control receipt?
      instructions:
      - text: Stop the {connector_type} Robinhood MCP connection on deployment {deployment_id}.
        slots:
          connector_type: path.connector_type
          deployment_id: path.deployment_id
      - text: Pause Robinhood MCP connector {connector_type} for {deployment_id} because {reason}.
        slots:
          connector_type: path.connector_type
          deployment_id: path.deployment_id
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/robinhood/mcp-connections/{connector_type}/disconnect'].post
  update:
    x-apievangelist-phrasing:
      intent: Disconnect a Robinhood MCP connection
      effect: destructive
      questions:
      - How do I disconnect a Robinhood MCP connection and clear its stored vault and connection refs?
      - What happens to the saved refs when I disconnect a Robinhood connector from a deployment?
      instructions:
      - text: Disconnect the {connector_type} Robinhood MCP connection on {deployment_id} and clear its refs.
        slots:
          connector_type: path.connector_type
          deployment_id: path.deployment_id
      - text: 'Fully disconnect Robinhood {connector_type} from deployment {deployment_id}, reason: {reason}.'
        slots:
          connector_type: path.connector_type
          deployment_id: path.deployment_id
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/robinhood/live-read-beta/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check Robinhood live-read beta readiness
      effect: read
      questions:
      - Is my deployment ready for the Robinhood live-read beta, and what gates are still missing?
      - Can I see the stop state, policy enablement and schema-proof evidence for Robinhood live reads?
      instructions:
      - text: Show the Robinhood live-read beta readiness status for deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Tell me whether {deployment_id} passes the live-read beta gates for Robinhood.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/robinhood/live-read-beta/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: View the Robinhood live-read beta tool mapping
      effect: read
      questions:
      - Which Robinhood read tools and scopes are allowlisted for the live-read beta on my deployment?
      - What Robinhood tool families are blocked in the live-read beta schema summary?
      instructions:
      - text: Show the allowlisted Robinhood live-read tools and scopes for {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Get the live-read beta schema summary for deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/robinhood/live-read-beta/read-preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview whether a Robinhood live read would pass
      effect: read
      questions:
      - Can I dry-run a Robinhood read tool to see which gates would block it, without calling Robinhood?
      - Would a given Robinhood live-read tool call be eligible on my deployment right now?
      instructions:
      - text: Preview whether tool {tool_name} would be allowed as a Robinhood live read on {deployment_id}.
        slots:
          tool_name: requestBody.tool_name
          deployment_id: path.deployment_id
      - text: Check live-read beta eligibility for deployment {deployment_id} on connector {connector_type} without calling Robinhood.
        slots:
          deployment_id: path.deployment_id
          connector_type: requestBody.connector_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/robinhood/live-read-beta/reads'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a gated Robinhood live read
      effect: write
      questions:
      - How do I actually call an allowlisted Robinhood read tool through the live-read beta?
      - What gates must pass before my finance agent may perform a real Robinhood read?
      instructions:
      - text: Run Robinhood read tool {tool_name} on connector {connector_type} for deployment {deployment_id}.
        slots:
          tool_name: requestBody.tool_name
          connector_type: requestBody.connector_type
          deployment_id: path.deployment_id
      - text: Perform a live Robinhood read with {tool_name} on {deployment_id} using idempotency key {idempotency_key}.
        slots:
          tool_name: requestBody.tool_name
          deployment_id: path.deployment_id
          idempotency_key: requestBody.idempotency_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/robinhood/live-read-beta/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop Robinhood live-read beta reads
      effect: write
      questions:
      - How do I block any further Robinhood live-read beta calls on a deployment?
      - Is there a kill switch for live reads that doesn't touch Robinhood itself?
      instructions:
      - text: Stop Robinhood live-read beta dispatch for deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Halt live reads on {deployment_id} for connector {connector_type} because {reason}.
        slots:
          deployment_id: path.deployment_id
          connector_type: requestBody.connector_type
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/policy'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a deployment's finance policy
      effect: read
      questions:
      - What owner-approved finance policy is currently stored for my deployment?
      - If I never set a finance policy, what does the default disabled policy look like?
      instructions:
      - text: Show the finance policy for deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Get the currently stored finance-agent policy on {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/policy'].put
  update:
    x-apievangelist-phrasing:
      intent: Save an owner-approved finance policy
      effect: write
      questions:
      - How do I store an approved finance policy for my finance agent deployment?
      - Which fields get rejected when I save a finance policy, like account or card details?
      instructions:
      - text: Save finance policy {policy} on deployment {deployment_id}.
        slots:
          policy: requestBody.policy
          deployment_id: path.deployment_id
      - text: Replace the finance-agent policy for {deployment_id} using idempotency key {idempotency_key}.
        slots:
          deployment_id: path.deployment_id
          idempotency_key: requestBody.idempotency_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/readiness-proofs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a finance-agent readiness proof
      effect: write
      questions:
      - How do I generate a no-action readiness proof for a finance agent's launch mode?
      - Can I bundle connector status, policy, and compliance approval into one readiness proof?
      instructions:
      - text: Create a readiness proof for deployment {deployment_id} in launch mode {launch_mode}.
        slots:
          deployment_id: path.deployment_id
          launch_mode: requestBody.launch_mode
      - text: Build a no-action readiness proof for {deployment_id} with approval mode {approval_mode}.
        slots:
          deployment_id: path.deployment_id
          approval_mode: requestBody.approval_mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/mcp-schema-proofs'].post
  update:
    x-apievangelist-phrasing:
      intent: Record Robinhood MCP schema-proof evidence
      effect: write
      questions:
      - How do I record a redacted Robinhood MCP schema-proof artifact for one connector?
      - Where do I store evidence that I probed the Robinhood MCP schema myself?
      instructions:
      - text: Record MCP schema-proof evidence for connector {connector_type} on deployment {deployment_id}.
        slots:
          connector_type: requestBody.connector_type
          deployment_id: path.deployment_id
      - text: Save probe status {mcp_probe_status} as schema proof for {deployment_id}.
        slots:
          mcp_probe_status: requestBody.mcp_probe_status
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/compliance-approvals'].post
  update:
    x-apievangelist-phrasing:
      intent: Record compliance approval evidence
      effect: write
      questions:
      - How do I log legal and compliance sign-off evidence for my finance agent's readiness?
      - Can I record brokerage-options review approval refs for a finance deployment?
      instructions:
      - text: Record compliance approval {compliance_approval} for deployment {deployment_id}.
        slots:
          compliance_approval: requestBody.compliance_approval
          deployment_id: path.deployment_id
      - text: Store owner and legal approval evidence on {deployment_id} with idempotency key {idempotency_key}.
        slots:
          deployment_id: path.deployment_id
          idempotency_key: requestBody.idempotency_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/gate-evidence-records'].post
  update:
    x-apievangelist-phrasing:
      intent: Record supporting gate evidence refs
      effect: write
      questions:
      - Where do I record refs for my stop-control drill or data-minimization plan?
      - How do I attach an owner approval checklist or external-gate bundle as evidence?
      instructions:
      - text: Record gate evidence {gate_evidence} on finance deployment {deployment_id}.
        slots:
          gate_evidence: requestBody.gate_evidence
          deployment_id: path.deployment_id
      - text: Log the stop-control drill evidence refs for {deployment_id} using key {idempotency_key}.
        slots:
          deployment_id: path.deployment_id
          idempotency_key: requestBody.idempotency_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/readiness-requirements'].get
  update:
    x-apievangelist-phrasing:
      intent: List finance-agent readiness requirements
      effect: read
      questions:
      - What does my finance agent still need, mode by mode, before it can launch?
      - Which blockers and required external evidence are listed for each finance launch mode?
      instructions:
      - text: Show the readiness requirements and blockers for finance deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: List what evidence {deployment_id} is missing for each launch mode.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/version-c-audit-map'].get
  update:
    x-apievangelist-phrasing:
      intent: View the Version C audit map
      effect: read
      questions:
      - What does the Version C audit map list for hard external gates and launch modes?
      - Where can I see the options review packet contract for my finance deployment?
      instructions:
      - text: Get the Version C audit map for deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Show the schema refs and hard gates in {deployment_id}'s Version C audit map.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/research-agent/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check Finance Research Agent status
      effect: read
      questions:
      - Is my private Finance Research Agent configured, and how many approved domains does it have?
      - How many research runs has my finance research agent done so far?
      instructions:
      - text: Show the Finance Research Agent status for deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Tell me the research agent's policy decision and run counts on {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/research-agent/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview a finance research run
      effect: read
      questions:
      - Can I see the plan and blockers for a research question before the finance agent searches anything?
      - Does previewing a finance research run use any sources or model calls?
      instructions:
      - text: 'Preview a research run on {deployment_id} for the question: {research_question}.'
        slots:
          deployment_id: path.deployment_id
          research_question: requestBody.research_question
      - text: Dry-run finance research on ticker {ticker} asking {research_question} for deployment {deployment_id}.
        slots:
          ticker: requestBody.ticker
          research_question: requestBody.research_question
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/research-agent/runs'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a finance research run
      effect: write
      questions:
      - How do I kick off a real public-source research run on a stock with my finance agent?
      - Can I cap how many sources a finance research run uses?
      instructions:
      - text: 'Start a finance research run on {deployment_id} answering: {research_question}.'
        slots:
          deployment_id: path.deployment_id
          research_question: requestBody.research_question
      - text: Research {ticker} for {research_question} on deployment {deployment_id}, using at most {max_sources} sources.
        slots:
          ticker: requestBody.ticker
          research_question: requestBody.research_question
          deployment_id: path.deployment_id
          max_sources: requestBody.max_sources
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/research-agent/runs/{run_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a finance research run's result
      effect: read
      questions:
      - How do I check the outcome of a finance research run I started?
      - What does a completed finance research run return, and are raw sources included?
      instructions:
      - text: Show research run {run_id} on deployment {deployment_id}.
        slots:
          run_id: path.run_id
          deployment_id: path.deployment_id
      - text: Get the status and findings of finance research run {run_id} for {deployment_id}.
        slots:
          run_id: path.run_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/research-agent/runs/{run_id}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running finance research run
      effect: destructive
      questions:
      - How do I halt a finance research run before it fetches more sources or runs inference?
      - Can I cancel a research run that's already in progress?
      instructions:
      - text: Stop finance research run {run_id} on deployment {deployment_id}.
        slots:
          run_id: path.run_id
          deployment_id: path.deployment_id
      - text: Cancel research run {run_id} on {deployment_id} with idempotency key {idempotency_key}.
        slots:
          run_id: path.run_id
          deployment_id: path.deployment_id
          idempotency_key: requestBody.idempotency_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/research-agent/receipts/{receipt_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a finance research run receipt
      effect: read
      questions:
      - Which sources and inference calls did a finance research run actually make, according to its receipt?
      - What confidence and source domains are recorded on a research agent receipt?
      instructions:
      - text: Show Finance Research Agent receipt {receipt_id}.
        slots:
          receipt_id: path.receipt_id
      - text: Get the redacted research-run receipt {receipt_id} with its source count and artifact hash.
        slots:
          receipt_id: path.receipt_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check research alert delivery readiness
      effect: read
      questions:
      - Is my finance research alert agent ready to actually deliver alerts?
      - Why isn't my research alert setup marked live deliverable yet?
      instructions:
      - text: Show the research alert readiness for deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Check whether alerts on {deployment_id} have a confirmed canary and working scheduler.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/channels'].get
  update:
    x-apievangelist-phrasing:
      intent: List research alert delivery channels
      effect: read
      questions:
      - Which delivery channels have I registered for finance research alerts?
      - Does listing alert channels ever show the actual email address or webhook URL?
      instructions:
      - text: List the research alert channels on deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Show every alert delivery channel configured for {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/channels'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a research alert delivery channel
      effect: write
      questions:
      - How do I add a new place for finance research alerts to be delivered using a secret reference?
      - Can I paste an email or webhook URL directly when adding an alert channel?
      instructions:
      - text: Register a {channel_type} alert channel named {label} on {deployment_id} using secret ref {destination_secret_ref}.
        slots:
          channel_type: requestBody.channel_type
          label: requestBody.label
          deployment_id: path.deployment_id
          destination_secret_ref: requestBody.destination_secret_ref
      - text: Add alert channel {label} for deployment {deployment_id}.
        slots:
          label: requestBody.label
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/channels/{channel_id}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop an alert channel and its schedules
      effect: destructive
      questions:
      - How do I shut down a research alert channel along with every schedule that uses it?
      - What happens to an alert already being sent when I stop its channel?
      instructions:
      - text: Stop alert channel {channel_id} on deployment {deployment_id}.
        slots:
          channel_id: path.channel_id
          deployment_id: path.deployment_id
      - text: Turn off channel {channel_id} for {deployment_id} and stop all of its alert schedules.
        slots:
          channel_id: path.channel_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List research alert schedules
      effect: read
      questions:
      - What hourly, daily or weekly research alert schedules are set up on my deployment?
      - Which research requests are my alert schedules running?
      instructions:
      - text: List the research alert schedules for deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Show every scheduled finance research alert on {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a recurring research alert
      effect: write
      questions:
      - How do I schedule a weekly finance research alert to a channel I've set up?
      - Can a research alert run hourly, or only daily and weekly?
      instructions:
      - text: Create a {cadence} research alert on {deployment_id} sent to channel {channel_id}.
        slots:
          cadence: requestBody.cadence
          deployment_id: path.deployment_id
          channel_id: requestBody.channel_id
      - text: Schedule research request {research_request} weekly on {day_of_week} at {run_at_utc} UTC to channel {channel_id} for {deployment_id}.
        slots:
          research_request: requestBody.research_request
          day_of_week: requestBody.day_of_week
          run_at_utc: requestBody.run_at_utc
          channel_id: requestBody.channel_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/schedules/{schedule_id}/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a research alert schedule
      effect: write
      questions:
      - How do I temporarily pause a finance research alert schedule so I can resume it later?
      - Can a paused alert schedule be turned back on?
      instructions:
      - text: Pause alert schedule {schedule_id} on deployment {deployment_id}.
        slots:
          schedule_id: path.schedule_id
          deployment_id: path.deployment_id
      - text: Temporarily suspend research alert schedule {schedule_id} for {deployment_id}.
        slots:
          schedule_id: path.schedule_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/schedules/{schedule_id}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused research alert schedule
      effect: write
      questions:
      - How do I restart a paused research alert schedule and get its next run time?
      - What happens if I resume an alert schedule that's already active?
      instructions:
      - text: Resume paused alert schedule {schedule_id} on deployment {deployment_id}.
        slots:
          schedule_id: path.schedule_id
          deployment_id: path.deployment_id
      - text: Turn research alert schedule {schedule_id} back on for {deployment_id}.
        slots:
          schedule_id: path.schedule_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/schedules/{schedule_id}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Permanently stop a research alert schedule
      effect: destructive
      questions:
      - How do I end a research alert schedule for good so it never runs again?
      - Can a permanently stopped alert schedule ever be resumed?
      instructions:
      - text: Permanently stop alert schedule {schedule_id} on deployment {deployment_id}.
        slots:
          schedule_id: path.schedule_id
          deployment_id: path.deployment_id
      - text: Kill research alert schedule {schedule_id} for {deployment_id} for good.
        slots:
          schedule_id: path.schedule_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/canary'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test research alert canary
      effect: write
      questions:
      - How do I send one test finance research alert to prove a channel actually delivers?
      - Does a canary alert count as delivered just because the provider accepted it?
      instructions:
      - text: Send a canary research alert to channel {channel_id} on deployment {deployment_id}.
        slots:
          channel_id: requestBody.channel_id
          deployment_id: path.deployment_id
      - text: Deliver one test alert for {research_request} through channel {channel_id} on {deployment_id}.
        slots:
          research_request: requestBody.research_request
          channel_id: requestBody.channel_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/canary/{receipt_id}/confirm'].post
  update:
    x-apievangelist-phrasing:
      intent: Confirm a canary alert reached its recipient
      effect: write
      questions:
      - How do I confirm that the test research alert actually arrived at the right recipient?
      - What is checked when I confirm a delivered canary receipt?
      instructions:
      - text: Confirm canary receipt {receipt_id} was received for deployment {deployment_id}.
        slots:
          receipt_id: path.receipt_id
          deployment_id: path.deployment_id
      - text: Mark the canary alert {receipt_id} on {deployment_id} as delivered to the intended recipient.
        slots:
          receipt_id: path.receipt_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/finance/research-agent/alert-receipts/{receipt_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a research alert delivery receipt
      effect: read
      questions:
      - Did a specific finance research alert get delivered, according to its receipt?
      - What does an alert delivery receipt show, and does it include the alert text?
      instructions:
      - text: Show research alert delivery receipt {receipt_id}.
        slots:
          receipt_id: path.receipt_id
      - text: Get the delivery status and hashes on alert receipt {receipt_id}.
        slots:
          receipt_id: path.receipt_id
      method: generated
      generated: '2026-09-26'


# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/agoragentic-com/refs/heads/main/overlays/agoragentic-com-agent-os-finance-api-phrasing-overlay.yaml