Open API
Call agents from your own systems
Your ticketing system, CRM and internal tools can call the agents and workflows you published in Evose. Wait for the result, or take the run ID now and get a callback when it's done.
Plug into the systems you have
Call what your team already built
Any agent, Orchestrated Agent or workflow your team published in Evose can be called from the API. Calls use the latest published version, so when the prompt changes in Evose, your code doesn't have to.
No waiting on long tasks
Start an async run and get its run ID right away. Poll for the result by ID, or pass a callback URL to have it pushed to you when it's done.
One key for one job
Each API key can only call the apps you choose. Give it an expiry date and turn it off at any time.
From publishing to the first call
- 01
Publish an app
Build an agent, Orchestrated Agent or workflow in Evose. Once it's published, you can call it from the API.
- 02
Create an API key
Choose who the key belongs to and which apps it can call, then add it to your service.
- 03
Make the call
Wait for the result, or run it async, keep the run ID and get a callback when it finishes.
Endpoints
All endpoints are under /open/v1. Authenticate by passing your API key as a Bearer token in the request header.
Apps
- GET
/appsList the apps this key can call - GET
/apps/agent/{app_id}/configGet the call config for an agent or Orchestrated Agent - GET
/apps/workflow/{app_id}/configGet a workflow's input variables
Agents and Orchestrated Agents
- POST
/apps/agent/runStart a conversation, with streaming support - POST
/apps/agent/async-runStart an async run, with an optional callback URL - GET
/apps/agent/async-runs/{run_id}Get an async run's status and answer
Workflows
- POST
/apps/workflow/runRun a workflow and stream progress as events - POST
/apps/workflow/sync-runRun a workflow and wait for the final output - POST
/apps/workflow/async-runStart an async run, with an optional callback URL - GET
/apps/workflow/async-runs/{run_id}Get an async run's result
Files
- POST
/files/uploadUpload a file to use in a run's inputs
Ways to use it
Triage new tickets
Each new ticket calls the triage agent, and its suggestion is written back to the ticket.
Prompt “Rate this ticket by urgency and suggest the team to own it. Only fill in the suggestion fields, don't reply to the customer.”
Draft follow-ups in the CRM
A rep clicks a button, the CRM calls an agent, and it drafts an email from the latest conversations.
Prompt “Draft a follow-up email for this deal based on the last three conversations, in the rep's own voice. Don't promise a discount, and leave the draft for the rep to check.”
Reconcile overnight
A scheduled job calls a workflow, and the exceptions list is ready in the morning.
Prompt “Check today's order export against the stock sheet and list items with less than 7 days of stock left. Just the list, don't place any purchase orders.”
You decide what each key can call
API keys are managed separately from members' access in Evose.
- Only the apps you chooseWhen you create a key, choose who it belongs to and which apps it can call. Calls outside that scope are refused.
- Expiry and off switchSet an expiry date, and turn a key off or delete it at any time. The list shows when each key was last used.
- Usage per keySee each key's cost and quota usage separately in Observe.
Questions
Make your first API call
Build an agent in Evose, create a key and connect it to your systems with a few lines of code.