Orsay AI API

Name: Orsay AI API
Brand: Orsay AI API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentAI/MLLanguage Modelsbearer33 EndpointsREST

For Agents

Run AI sales agents over Instagram and WhatsApp, manage conversations and leads, and orchestrate follow-up sequences through the Orsay AI platform.

Install Jentic One Beta

Connect the Orsay AI API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Orsay AI API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Orsay AI API.

List and inspect AI agent configurations through GET /v1/agents and GET /v1/agents/{agent_id}

Send messages from a configured agent into a conversation via POST /v1/agents/{agent_id}/message

Retrieve full conversation history and search across conversations using GET /v1/conversations and GET /v1/conversations/search-index

GET STARTED

Start building with Orsay AI API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Orsay AI API, keeping it validated and agent-ready. Orsay AI is a conversational-commerce platform that lets brands run AI agents over Instagram and WhatsApp to qualify leads, hold sales conversations, and execute follow-up sequences. The 33 endpoints span agent management, conversation history, lead context, integrations with Instagram and WhatsApp accounts, message-level feedback, sequence orchestration, organization configuration, and billing. It targets sales and customer-acquisition teams that want to automate first-touch outreach while keeping humans in the loop for handover.

Use Cases

Patterns agents use Orsay AI API for, with concrete tasks.

★ Instagram DM Lead Qualification

Brands receiving high inbound DM volume on Instagram can configure an Orsay agent to qualify leads in chat, ask discovery questions, and route hot prospects to a human. The integrations endpoints connect the Instagram account, and the agent endpoints drive the actual conversation through POST /v1/agents/{agent_id}/message.

POST /v1/integrations/instagram/account to connect, then POST /v1/agents/{agent_id}/message to reply to inbound DMs with qualification questions.

WhatsApp Outbound Sequences

Teams running paid acquisition into WhatsApp can use Orsay's sequence endpoints to deliver multi-step nurture flows that branch on response. POST /v1/sequences creates the sequence definition and POST /v1/agents/{agent_id}/message handles per-step delivery, with handoff to humans on conversion signals.

POST /v1/sequences with a 3-step welcome flow, then enroll new leads via the sequence enrollment endpoint and let the agent run delivery.

Human Handoff on Buy Intent

When a conversation shows buy intent, the agent should step back. PATCH /v1/conversation/{lead_id}/ai disables the AI on that thread so a human seller takes over without losing chat context, and GET /v1/lead/{lead_id} surfaces the full lead profile for the human's first reply.

PATCH /v1/conversation/{lead_id}/ai with enabled=false when intent score crosses threshold, then GET /v1/lead/{lead_id} for the human seller's briefing.

Conversation Export for Analytics

Operations teams want full conversation data in their warehouse to compute per-agent close rate or train on real exchanges. POST /v1/conversations/export starts a job and the GET /v1/conversations/export/{job_id}/download endpoint returns the file for ETL.

POST /v1/conversations/export, poll GET /v1/conversations/export/{job_id}/status, then download via the /download endpoint.

Agent-Driven Conversational Sales via Jentic

Sales-ops agents orchestrating multiple channels can drive Orsay through Jentic without learning all 33 endpoints. Jentic exposes the operations by intent and isolates the bearer token in the vault, letting another agent handle CRM updates while Orsay handles the chat.

Use Jentic to search 'send a message via my AI sales agent', load the POST /v1/agents/{agent_id}/message schema, and execute with the conversation id and message body.

Key Endpoints

33 endpoints — jentic publishes the only available openapi specification for orsay ai api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/v1/conversations

List conversations across the workspace

GET

/v1/lead/{lead_id}

Retrieve the lead behind a conversation

POST

/v1/agents/{agent_id}/message

Send a message via an AI agent

PATCH

/v1/conversation/{lead_id}/ai

Pause or resume the AI on a conversation

POST

/v1/integrations/instagram/account

Connect an Instagram account

POST

/v1/integrations/whatsapp/account

Connect a WhatsApp account

POST

/v1/sequences

Create a multi-step outreach sequence

POST

/v1/conversations/export

Start a conversation export job

GET

/v1/conversations

List conversations across the workspace

GET

/v1/lead/{lead_id}

Retrieve the lead behind a conversation

POST

/v1/agents/{agent_id}/message

Send a message via an AI agent

PATCH

/v1/conversation/{lead_id}/ai

Pause or resume the AI on a conversation

POST

/v1/integrations/instagram/account

Connect an Instagram account

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Orsay AI bearer tokens are stored encrypted in the Jentic vault. Agents receive scoped execution access only — the raw token never enters the agent's prompt or context window.

Intent-based discovery

Agents search by intent (e.g., 'send a message in a conversation' or 'pause AI on a conversation') and Jentic returns the matching Orsay operation with its input schema.

Time to first call

Direct Orsay integration: 1-2 weeks for OAuth-style setup, channel integration, and webhook handling. Through Jentic: hours — search, load, execute.

FAQs

Specific to using Orsay AI API through Jentic.

Why is there no official OpenAPI spec for Orsay AI API?

Orsay AI publishes documentation on its docs site but not a maintained OpenAPI document. Jentic generates and maintains this spec so that AI agents and developers can call Orsay AI API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Orsay AI API use?

Orsay AI uses bearer-token authentication. Through Jentic the bearer token is stored encrypted in the vault and injected only at execution time, so the agent never sees the raw secret.

Can I connect a WhatsApp account through the Orsay AI API?

Yes. POST /v1/integrations/whatsapp/account creates the integration, GET /v1/integrations/whatsapp/account lists existing connections, and GET /v1/integrations/whatsapp/profiles enumerates the linked WhatsApp profiles.

What are the rate limits for the Orsay AI API?

The OpenAPI spec does not declare numeric rate limits. Messaging-channel rate limits (Instagram and WhatsApp) often dominate in practice — confirm Orsay's per-tenant limits with their team before scaling outbound volume.

How do I pause the AI on a conversation through Jentic?

Search Jentic for 'pause AI on a conversation', load the PATCH /v1/conversation/{lead_id}/ai schema, and execute with enabled set to false. The agent stops responding while the human takes over.

Does the Orsay AI API expose billing data?

Yes. GET /v1/billing/products, GET /v1/billing/subscriptions, and GET /v1/billing/wallets return the product catalogue, current subscription state, and wallet balance for the tenant.

Orsay AI API

Connect the Orsay AI API to your agent

Capabilities

Start building with Orsay AI API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs