Use Public APIs for Agent Studio

Public APIs for AI Agent Studio let you call, manage, and run any Omnix agent from your own software—without logging in to Omnix. This article explains what the APIs are, why they matter, and how to use them securely with OAuth.

TABLE OF CONTENTS

What is Agent Studio Public API?


A Public API (Application Programming Interface) is a secure way for external applications to communicate with Omnix. In Agent Studio, the Public API allows your software to list, retrieve, and execute production-ready AI agents programmatically without logging into the Omnix dashboard.


Your application sends secure HTTP requests to Omnix’s servers, which run the selected agent and return a structured JSON response. Each request is tied to a specific sub-account (location) and must include proper authentication using OAuth 2.0 bearer tokens or a Private Integration Token (PIT). Only agents that are Active in the Production lifecycle stage can be accessed through the Public API.

Key Benefits of Agent Studio Public API


  • Embed AI agents inside mobile apps, SaaS platforms, voice assistants, or internal tools.


  • Trigger complex agent workflows from external automations (Zapier, Make, Airflow, etc.).


  • Centralize security with OAuth 2.0 and scoped access tokens.


  • Leverage PIT Integrations to run agents inside your own environment while respecting data-privacy rules.


  • Return rich, structured JSON so downstream systems can parse results without extra NLP.

List Agents API

This endpoint returns every active agent for a given location.


  • Method: GET /agent-studio/public-api/agents


  • Required query param: locationId


  • Optional pagination: limit, offset


  • Typical use: show a dropdown of available agents in your app.

Get Agent API

Retrieve full metadata about a single agent.


  • Method: GET /agent-studio/public-api/agents/{agentId}


  • Required query param: locationId


  • Returns: name, status, tool-nodes, variables, lifecycle stage, and more.


  • Typical use: display agent details before execution or inspect variables.

Execute Agent API

Run an agent and get the complete output in one JSON payload.


  • Method: POST /agent-studio/public-api/agents/{agentId}/execute


  • Body: { locationId, input, executionId? }


  • First call omits executionId; response returns executionId so you can continue the same conversation thread in subsequent calls.


  • Typical use: deliver instant results (e.g., “Summarize this PDF” or “Generate ad copy”).

OAuth Authentication

Public APIs use OAuth 2.0 bearer tokens. Create a private integration in Omnix or use the standard OAuth flow to obtain an access token. Tokens are JWTs that must be included in the Authorization header:
Authorization: Bearer {access_token}

PIT Integrations


Private Integration Tokens (PIT) offer a simplified alternative to full OAuth when you need server-to-server calls. Generate a PIT in the Omnix Developer Settings, scope it to the required sub-account, and include it in the Authorization header just like an OAuth access token.

How To Set Up Agent Studio Public API

Follow these steps to connect your external app:

 

  • Enable AI Agents → Agent Studio in your sub-account (must have agents in “Production”).


  • Go to Settings → Developer and create a Private Integration or OAuth App.


  • Copy the Client ID and Client Secret (OAuth) or PIT value (Private Integration).


For OAuth:
Call POST /oauth/token with grant_type=authorization_code to exchange the code for an access token.


  • b. Store the access token securely; refresh it as needed.


  • Test the connection with List Agents:



  • Parse the response and save the agentId(s) you intend to run.


Execute the agent:


curl -X POST \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
-d '{ "locationId":"abc123", "input":{ "prompt":"Write a Facebook ad for plumbers"} }' \


https://services.leadconnectorhq.com/agent-studio/public-api/agents/{agentId}/execute


Store the returned executionId if you need multi-turn conversations.

Frequently Asked Questions


Q: Is there a rate limit?

Yes. Each sub-account is limited to 300 API requests per minute across all Agent Studio endpoints.


Q: Can I stream partial responses?
Not yet. The Execute Agent endpoint currently returns a single JSON object after completion.


Q: Do agents need to be in Production?
Yes. Only agents with status = “Active” in the Production lifecycle stage are accessible via the public API.


Q: What happens if I omit locationId?
The API returns HTTP 400 (“locationId is required”).


Q: Can I call the API from client-side JavaScript?
It’s not recommended; always proxy the request from your backend to protect the bearer token.


Q: How long is an executionId valid?
Execution IDs expire after 30 minutes of inactivity. Start a new session if needed.


Q: Does OAuth support refresh tokens?
Yes follow the standard OAuth 2.0 refresh_token grant to renew access tokens without user interaction.


Q: Are PIT tokens limited to a single location?Yes. PIT tokens are scoped to the sub-account you selected when generating the token.
← Volver a AI Employee