Developer

API Reference

Integrate ORME AI into your workflow with our REST API. Build custom integrations, automate workflows, and extend the platform.

Authentication

All API requests require authentication via Bearer token. Include your API key in the Authorization header of every request.

// Include in request headers

Authorization: Bearer your_api_key_here

Base URL

All API endpoints are relative to the base URL. Use HTTPS for all requests in production environments.

// Production

https://api.orme.dev/v1

Endpoints

Available API endpoints

Accounts2 endpoints

GET/v1/accounts

List all connected Instagram accounts for the authenticated workspace.

POST/v1/accounts/connect

Initiate the OAuth flow to connect a new Instagram account.

Comments2 endpoints

GET/v1/comments

Retrieve comments with filtering by post, status, and date range.

POST/v1/comments/{id}/reply

Post a reply to a specific comment. Supports AI-generated or manual replies.

Subscribers3 endpoints

GET/v1/subscribers

List subscribers with pagination, tag filtering, and segment queries.

POST/v1/subscribers

Create a new subscriber record with tags and custom attributes.

PUT/v1/subscribers/{id}

Update subscriber details, tags, lifecycle stage, or custom fields.

Automation2 endpoints

GET/v1/flows

List all automation flows with their status and execution counts.

POST/v1/flows/{id}/trigger

Manually trigger a specific flow for testing or one-off execution.

Analytics2 endpoints

GET/v1/analytics/overview

Get high-level metrics including reply rate, response time, and engagement.

GET/v1/analytics/agent-performance

Detailed AI agent performance metrics: accuracy, confidence, and throughput.

Rate Limits

Request quotas by plan

Standard

Pro Plan

100

requests per minute

Enterprise

Custom

1,000

requests per minute

Coming Soon

Official SDKs

We are building official SDKs for JavaScript and Python to make integration even easier. Sign up to be notified when they launch.

JavaScript

npm

Python

pip

Need API access?

Contact our team to get your API credentials and start building integrations with ORME AI.

Contact Our Team Back to Docs