REST Agent API integration
How to use Omentir's REST Agent API under /api/agent/v1 for product profile, agents, leads, activity, schedules, and conversations with Bearer auth.
Endpoints
- MCP
- https://omentir.com/api/agent/v1/mcp
- REST
- https://omentir.com/api/agent/v1/*
- Guide
- /agents.md
Setup
- 1
Create a token on the API page
Keys are never accepted in URLs. Send Authorization: Bearer on every request.
- 2
Read OpenAPI
https://omentir.com/api/agent/v1/openapi.json is the contract. Do not guess path names.
- 3
Start with GET context
If get_context fails, fix auth before you write a create-agent script.
- 4
Create with an explicit body
Pass the ICP or Steal Customers URLs you actually want. Log the returned id and open it in the app.
What the REST Agent API is
The Agent API is the HTTP interface for workspace-scoped sales operations. It covers context, stats, product profile, agents, groups, leads, activity, scheduled actions, settings, and conversations. MCP exposes the same capabilities as tools for assistants that prefer tool calling.
OpenAPI lives at /api/agent/v1/openapi.json so clients can generate types and see current paths without scraping docs by hand.
Authentication
Create a revocable key in the workspace API keys UI. Send Authorization: Bearer on every request. Treat the key like a password. Scope is the workspace, not a single agent, so protect it accordingly.
Common integration flows
Readiness check: context plus stats. Segment launch: update product profile if needed, create agent, poll leads and activity. Ops dashboard: list scheduled actions and conversations. Always prefer read-before-write and human approval for destructive changes.
- Base path: /api/agent/v1
- Machine guide: /agents.md
- Human MCP story: /mcp-server
- Capability map: /agent.json
What not to build
Do not use the API to create Omentir accounts or buy subscriptions. Do not scrape the dashboard HTML for data the API already returns. Do not store LinkedIn passwords in your integration. Omentir holds the LinkedIn connection.
A first REST script that you can trust
Write the smallest script: authenticate, print context, list agents, exit. Check it twice. Then add one write. If a create call returns success, open that agent in the dashboard the same minute. Scripts that only look at their own JSON drift from the product.
Store the token in the environment. Revoke it when the script is done or when someone leaves the team. There is no reason for a weekend experiment key to live forever.
When REST is more than you need
If you are not writing code, use the dashboard or a chat connector. REST is for people who want Omentir inside an existing system. It is a worse first experience than clicking through the app if you only need one campaign this week.
Frequently Asked Questions
Use MCP when the client is an assistant with tool calling. Use REST when you own the HTTP client in a script, backend, or automation runner. Capabilities align.
Yes. Product and infrastructure limits apply. Design for retries with backoff and avoid tight poll loops.
Fetch https://omentir.com/api/agent/v1/openapi.json for the current REST surface.
Connect your operator to a real sales workspace
Omentir holds the LinkedIn connection and safety limits. Your AI configures agents and inspects results.