Agoragentic Agent OS Finance API
The Agent OS Finance API from Agoragentic — 38 operation(s) for agent os finance.
Operations 41
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/agent-os/finance/deployments/{deployment_id}/connectors
Check a finance agent's connector status · Read finance-agent connector status
#
Ask an LLM
“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?”
Tell an agent
Show the status of all finance connectors on deployment {deployment_id}.
List which finance-agent connectors are configured for {deployment_id} and whether each is connected.
GET
/agent-os/finance/deployments/{deployment_id}/robinhood/mcp-connections
List a deployment's Robinhood MCP connections · Read Robinhood MCP connection records
#
Ask an LLM
“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?”
Tell an agent
List the Robinhood MCP connection records for deployment {deployment_id}.
Show me the vault and connection refs stored on {deployment_id}'s Robinhood MCP connections.
POST
/agent-os/finance/deployments/{deployment_id}/robinhood/mcp-connections/{connector_type}/attach
Attach vault refs to a Robinhood MCP connection · Attach existing Robinhood MCP vault refs
#
Ask an LLM
“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?”
Tell an agent
Attach vault secret {vault_secret_ref} and connection {connection_ref} to the {connector_type} Robinhood MCP connection on {deployment_id}.
Record Robinhood {connector_type} MCP refs on deployment {deployment_id} with idempotency key {idempotency_key}.
POST
/agent-os/finance/deployments/{deployment_id}/robinhood/mcp-connections/{connector_type}/stop
Stop a Robinhood MCP connection · Record Robinhood MCP connection stop state
#
Ask an LLM
“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?”
Tell an agent
Stop the {connector_type} Robinhood MCP connection on deployment {deployment_id}.
Pause Robinhood MCP connector {connector_type} for {deployment_id} because {reason}.
POST
/agent-os/finance/deployments/{deployment_id}/robinhood/mcp-connections/{connector_type}/disconnect
Disconnect a Robinhood MCP connection · Record Robinhood MCP connection disconnect state
#
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Disconnect the {connector_type} Robinhood MCP connection on {deployment_id} and clear its refs.
Fully disconnect Robinhood {connector_type} from deployment {deployment_id}, reason: {reason}.
GET
/agent-os/finance/deployments/{deployment_id}/robinhood/live-read-beta/status
Check Robinhood live-read beta readiness · Read Robinhood live-read beta status
#
Ask an LLM
“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?”
Tell an agent
Show the Robinhood live-read beta readiness status for deployment {deployment_id}.
Tell me whether {deployment_id} passes the live-read beta gates for Robinhood.
GET
/agent-os/finance/deployments/{deployment_id}/robinhood/live-read-beta/schema
View the Robinhood live-read beta tool mapping · Read Robinhood live-read beta schema summary
#
Ask an LLM
“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?”
Tell an agent
Show the allowlisted Robinhood live-read tools and scopes for {deployment_id}.
Get the live-read beta schema summary for deployment {deployment_id}.
POST
/agent-os/finance/deployments/{deployment_id}/robinhood/live-read-beta/read-preview
Preview whether a Robinhood live read would pass · Preview Robinhood live-read beta eligibility
#
Ask an LLM
“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?”
Tell an agent
Preview whether tool {tool_name} would be allowed as a Robinhood live read on {deployment_id}.
Check live-read beta eligibility for deployment {deployment_id} on connector {connector_type} without calling Robinhood.
POST
/agent-os/finance/deployments/{deployment_id}/robinhood/live-read-beta/reads
Run a gated Robinhood live read · Perform gated Robinhood live-read beta call
#
Ask an LLM
“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?”
Tell an agent
Run Robinhood read tool {tool_name} on connector {connector_type} for deployment {deployment_id}.
Perform a live Robinhood read with {tool_name} on {deployment_id} using idempotency key {idempotency_key}.
POST
/agent-os/finance/deployments/{deployment_id}/robinhood/live-read-beta/stop
Stop Robinhood live-read beta reads · Stop Robinhood live-read beta dispatch
#
Ask an LLM
“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?”
Tell an agent
Stop Robinhood live-read beta dispatch for deployment {deployment_id}.
Halt live reads on {deployment_id} for connector {connector_type} because {reason}.
GET
/agent-os/finance/deployments/{deployment_id}/policy
Read a deployment's finance policy · Read finance-agent policy
#
Ask an LLM
“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?”
Tell an agent
Show the finance policy for deployment {deployment_id}.
Get the currently stored finance-agent policy on {deployment_id}.
PUT
/agent-os/finance/deployments/{deployment_id}/policy
Save an owner-approved finance policy · Store owner-approved finance policy
#
Ask an LLM
“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?”
Tell an agent
Save finance policy {policy} on deployment {deployment_id}.
Replace the finance-agent policy for {deployment_id} using idempotency key {idempotency_key}.
POST
/agent-os/finance/deployments/{deployment_id}/readiness-proofs
Create a finance-agent readiness proof · Create finance-agent no-action readiness proof
#
Ask an LLM
“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?”
Tell an agent
Create a readiness proof for deployment {deployment_id} in launch mode {launch_mode}.
Build a no-action readiness proof for {deployment_id} with approval mode {approval_mode}.
POST
/agent-os/finance/deployments/{deployment_id}/mcp-schema-proofs
Record Robinhood MCP schema-proof evidence · Record finance-agent MCP schema proof evidence
#
Ask an LLM
“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?”
Tell an agent
Record MCP schema-proof evidence for connector {connector_type} on deployment {deployment_id}.
Save probe status {mcp_probe_status} as schema proof for {deployment_id}.
POST
/agent-os/finance/deployments/{deployment_id}/compliance-approvals
Record compliance approval evidence · Record finance-agent compliance approval evidence
#
Ask an LLM
“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?”
Tell an agent
Record compliance approval {compliance_approval} for deployment {deployment_id}.
Store owner and legal approval evidence on {deployment_id} with idempotency key {idempotency_key}.
POST
/agent-os/finance/deployments/{deployment_id}/gate-evidence-records
Record supporting gate evidence refs · Record finance-agent supporting gate evidence refs
#
Ask an LLM
“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?”
Tell an agent
Record gate evidence {gate_evidence} on finance deployment {deployment_id}.
Log the stop-control drill evidence refs for {deployment_id} using key {idempotency_key}.
GET
/agent-os/finance/deployments/{deployment_id}/readiness-requirements
List finance-agent readiness requirements · Read finance-agent readiness requirements
#
Ask an LLM
“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?”
Tell an agent
Show the readiness requirements and blockers for finance deployment {deployment_id}.
List what evidence {deployment_id} is missing for each launch mode.
GET
/agent-os/finance/deployments/{deployment_id}/version-c-audit-map
View the Version C audit map · Read finance-agent Version C audit map
#
Ask an LLM
“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?”
Tell an agent
Get the Version C audit map for deployment {deployment_id}.
Show the schema refs and hard gates in {deployment_id}'s Version C audit map.
GET
/agent-os/finance/deployments/{deployment_id}/research-agent/status
Check Finance Research Agent status · Read private Finance Research Agent V1 status
#
Ask an LLM
“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?”
Tell an agent
Show the Finance Research Agent status for deployment {deployment_id}.
Tell me the research agent's policy decision and run counts on {deployment_id}.
POST
/agent-os/finance/deployments/{deployment_id}/research-agent/preview
Preview a finance research run · Preview a Finance Research Agent V1 run with zero calls and writes
#
Ask an LLM
“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?”
Tell an agent
Preview a research run on {deployment_id} for the question: {research_question}.
Dry-run finance research on ticker {ticker} asking {research_question} for deployment {deployment_id}.
POST
/agent-os/finance/deployments/{deployment_id}/research-agent/runs
Start a finance research run · Start an idempotent private Finance Research Agent V1 run
#
Ask an LLM
“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?”
Tell an agent
Start a finance research run on {deployment_id} answering: {research_question}.
Research {ticker} for {research_question} on deployment {deployment_id}, using at most {max_sources} sources.
GET
/agent-os/finance/deployments/{deployment_id}/research-agent/runs/{run_id}
Get a finance research run's result · Read a private Finance Research Agent V1 run
#
Ask an LLM
“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?”
Tell an agent
Show research run {run_id} on deployment {deployment_id}.
Get the status and findings of finance research run {run_id} for {deployment_id}.
POST
/agent-os/finance/deployments/{deployment_id}/research-agent/runs/{run_id}/stop
Stop a running finance research run · Stop a private Finance Research Agent V1 run
#
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Stop finance research run {run_id} on deployment {deployment_id}.
Cancel research run {run_id} on {deployment_id} with idempotency key {idempotency_key}.
GET
/agent-os/finance/research-agent/receipts/{receipt_id}
Read a finance research run receipt · Read a redacted Finance Research Agent V1 receipt
#
Ask an LLM
“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?”
Tell an agent
Show Finance Research Agent receipt {receipt_id}.
Get the redacted research-run receipt {receipt_id} with its source count and artifact hash.
GET
/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/status
Check research alert delivery readiness · Read Finance Research Alert Agent readiness
#
Ask an LLM
“Is my finance research alert agent ready to actually deliver alerts?”
“Why isn't my research alert setup marked live deliverable yet?”
Tell an agent
Show the research alert readiness for deployment {deployment_id}.
Check whether alerts on {deployment_id} have a confirmed canary and working scheduler.
GET
/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/channels
List research alert delivery channels · List Finance Research Alert delivery channels
#
Ask an LLM
“Which delivery channels have I registered for finance research alerts?”
“Does listing alert channels ever show the actual email address or webhook URL?”
Tell an agent
List the research alert channels on deployment {deployment_id}.
Show every alert delivery channel configured for {deployment_id}.
POST
/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/channels
Register a research alert delivery channel · Register a ref-only Finance Research Alert delivery channel
#
Ask an LLM
“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?”
Tell an agent
Register a {channel_type} alert channel named {label} on {deployment_id} using secret ref {destination_secret_ref}.
Add alert channel {label} for deployment {deployment_id}.
POST
/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/channels/{channel_id}/stop
Stop an alert channel and its schedules · Stop a Finance Research Alert channel and its schedules
#
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Stop alert channel {channel_id} on deployment {deployment_id}.
Turn off channel {channel_id} for {deployment_id} and stop all of its alert schedules.
GET
/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/schedules
List research alert schedules · List Finance Research Alert schedules
#
Ask an LLM
“What hourly, daily or weekly research alert schedules are set up on my deployment?”
“Which research requests are my alert schedules running?”
Tell an agent
List the research alert schedules for deployment {deployment_id}.
Show every scheduled finance research alert on {deployment_id}.
POST
/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/schedules
Schedule a recurring research alert · Create a Finance Research Alert schedule
#
Ask an LLM
“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?”
Tell an agent
Create a {cadence} research alert on {deployment_id} sent to channel {channel_id}.
Schedule research request {research_request} weekly on {day_of_week} at {run_at_utc} UTC to channel {channel_id} for {deployment_id}.
POST
/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/schedules/{schedule_id}/pause
Pause a research alert schedule · Pause a Finance Research Alert schedule
#
Ask an LLM
“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?”
Tell an agent
Pause alert schedule {schedule_id} on deployment {deployment_id}.
Temporarily suspend research alert schedule {schedule_id} for {deployment_id}.
POST
/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/schedules/{schedule_id}/resume
Resume a paused research alert schedule · Resume a Finance Research Alert schedule
#
Ask an LLM
“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?”
Tell an agent
Resume paused alert schedule {schedule_id} on deployment {deployment_id}.
Turn research alert schedule {schedule_id} back on for {deployment_id}.
POST
/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/schedules/{schedule_id}/stop
Permanently stop a research alert schedule · Permanently stop a Finance Research Alert schedule
#
Ask an LLM
“How do I end a research alert schedule for good so it never runs again?”
“Can a permanently stopped alert schedule ever be resumed?”
Tell an agent destructive · confirm first
Permanently stop alert schedule {schedule_id} on deployment {deployment_id}.
Kill research alert schedule {schedule_id} for {deployment_id} for good.
POST
/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/canary
Send a test research alert canary · Run one controlled Finance Research Alert delivery canary
#
Ask an LLM
“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?”
Tell an agent
Send a canary research alert to channel {channel_id} on deployment {deployment_id}.
Deliver one test alert for {research_request} through channel {channel_id} on {deployment_id}.
POST
/agent-os/finance/deployments/{deployment_id}/research-agent/alerts/canary/{receipt_id}/confirm
Confirm a canary alert reached its recipient · Confirm recipient receipt of the current Finance Research Alert canary
#
Ask an LLM
“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?”
Tell an agent
Confirm canary receipt {receipt_id} was received for deployment {deployment_id}.
Mark the canary alert {receipt_id} on {deployment_id} as delivered to the intended recipient.
GET
/agent-os/finance/research-agent/alert-receipts/{receipt_id}
Read a research alert delivery receipt · Read a redacted Finance Research Alert delivery receipt
#
Ask an LLM
“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?”
Tell an agent
Show research alert delivery receipt {receipt_id}.
Get the delivery status and hashes on alert receipt {receipt_id}.
POST
/agent-os/finance/deployments/{deployment_id}/research-jobs
Queue a finance research job record · Create finance research job record
#
Ask an LLM
“How do I create a queued financial research job on a topic with a USDC cost budget?”
“Can I scope a finance research job to specific symbols and a citation policy?”
Tell an agent
Create a finance research job on {topic} for deployment {deployment_id}.
Queue a research job on {topic} covering symbols {symbols} with a budget of {cost_budget_usdc} USDC on {deployment_id}.
GET
/agent-os/finance/research-jobs/{job_id}
Read a finance research job · Read finance research job
#
Ask an LLM
“What's in a finance research job record, including its artifacts and candidate actions?”
“Are the candidate actions on a research job ever directly executable?”
Tell an agent
Show finance research job {job_id}.
Get the artifact metadata and candidate actions for research job {job_id}.
GET
/agent-os/finance/receipts/{receipt_id}
Read a finance-agent receipt · Read finance-agent receipt
#
Ask an LLM
“How do I look up a general finance-agent receipt by its ID?”
“Which account, card and payment details are stripped from a finance-agent receipt?”
Tell an agent
Show finance-agent receipt {receipt_id}.
Fetch the redacted finance receipt {receipt_id} from my finance agent.
GET
/agent-os/finance/robinhood/live-read-beta/receipts/{receipt_id}
Read a Robinhood live-read beta receipt · Read Robinhood live-read beta receipt
#
Ask an LLM
“What did a particular Robinhood live-read beta call record in its receipt?”
“Does a Robinhood live-read receipt include the raw provider payload?”
Tell an agent
Show Robinhood live-read beta receipt {receipt_id}.
Get the live-read summary for Robinhood read receipt {receipt_id}.
GET
/agent-os/finance/deployments/{deployment_id}/mcp-probe-status
Check Robinhood MCP probe status · Read Robinhood MCP probe status
#
Ask an LLM
“What's the latest Robinhood MCP probe status and schema-proof summary on my deployment?”
“Has a Robinhood MCP schema probe been recorded for this finance deployment yet?”
Tell an agent
Show the Robinhood MCP probe status for deployment {deployment_id}.
Get the stored schema-proof summaries from {deployment_id}'s MCP probe status.
Documentation
📖
Documentation
https://agoragentic.com/docs.html
📖
APIReference
https://agoragentic.com/openapi.json