Overlay AI API

Name: Overlay AI API
Brand: Overlay AI API
Availability: InStock

✓ Official Vendor SpecArtificial IntelligenceComputer Visionoauth27 EndpointsREST

For Agents

Manage Overlay AI OAuth2 authentication, access tokens, and Zapier trigger integrations for AI object recognition workflows.

Install Jentic One Beta

Connect the Overlay AI API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Overlay 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 Overlay AI API.

Authenticate users via OAuth2 authorization flow

Refresh OAuth2 access tokens programmatically

Request access to Overlay AI resources with scopes

Subscribe to Zapier triggers for AI object detection events

GET STARTED

Start building with Overlay AI API

Explore with Jentic

View OpenAPI Document

Use Cases

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

★ Zapier Automation for Object Detection

Trigger Zapier workflows when Overlay AI detects specific objects or events in video streams. POST /api/zapier/subscribe/flows subscribes a Zapier webhook to detection events, GET /api/zapier/perform-list retrieves recent events for polling triggers, and DELETE /api/zapier/unsubscribe/flows unsubscribes. Use this to automate responses like sending alerts when a person enters a restricted zone, logging vehicle counts, or triggering notifications when specific objects appear on camera.

POST /api/zapier/subscribe/flows with webhook URL and detection filters, then use GET /api/zapier/perform-list for polling-based triggers. DELETE /api/zapier/unsubscribe/flows to remove subscriptions.

OAuth2 Authentication for Third-Party Apps

Integrate Overlay AI into third-party applications using OAuth2 for secure user authorization. POST /oauth2 initiates the OAuth2 flow, POST /access exchanges authorization codes for access tokens, and POST /refresh renews expired tokens. This allows apps to access user-specific detection data, manage subscriptions, and interact with Overlay AI on behalf of users without storing credentials.

POST /oauth2 to start OAuth2 flow, redirect user for authorization, then POST /access with authorization code to retrieve access token. Use POST /refresh to renew tokens before expiration.

Real-Time Monitoring System Integration

Build real-time monitoring dashboards or alerting systems that respond to Overlay AI object detection events. Subscribe webhooks to receive instant notifications when objects are detected, then process events through custom logic — filter by object type, aggregate counts, or trigger escalations. Integrate with SIEM tools, incident management platforms, or IoT systems to create intelligent surveillance and monitoring solutions.

POST /api/zapier/subscribe/flows to receive webhook notifications, parse detection payloads for object type and confidence, then route to alerting or incident systems based on rules.

AI Agent for Computer Vision Automation

Let an AI agent manage Overlay AI integration tasks — subscribing to detection triggers, refreshing tokens, and testing connectivity. Through Jentic, the agent searches by intent ('subscribe to Overlay AI detection events') and loads only the required endpoints. OAuth tokens are injected at execution time, keeping credentials out of agent context.

Use the Jentic search query 'subscribe to Overlay AI detection events' to find POST /api/zapier/subscribe/flows, load its schema, and execute with webhook URL and event filters provided by the user.

Key Endpoints

7 endpoints — overlay ai provides real-time object recognition and ai-powered computer vision capabilities integrated with automation platforms like zapier.

METHOD

PATH

DESCRIPTION

POST

/oauth2

Initiate OAuth2 authorization flow

POST

/access

Exchange authorization code for access token

POST

/refresh

Refresh an expired access token

POST

/api/zapier/subscribe/flows

Subscribe to Zapier detection triggers

GET

/api/zapier/perform-list

Retrieve recent detection events for polling

DELETE

/api/zapier/unsubscribe/flows

Unsubscribe from Zapier triggers

GET

/test

Test API connectivity and authentication

POST

/oauth2

Initiate OAuth2 authorization flow

POST

/access

Exchange authorization code for access token

POST

/refresh

Refresh an expired access token

POST

/api/zapier/subscribe/flows

Subscribe to Zapier detection triggers

GET

/api/zapier/perform-list

Retrieve recent detection events for polling

Why Jentic?

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

Credential isolation

Overlay AI OAuth2 tokens are stored encrypted in the Jentic vault, refreshed automatically, and injected at execution time. Raw tokens never appear in agent prompts, transcripts, or response payloads.

Intent-based discovery

Agents search by intent such as 'subscribe to Overlay AI detection events' or 'refresh OAuth token' and Jentic returns the matching endpoint with its schema and any required parameters.

Time to first call

Direct Overlay AI integration: 1 day to implement OAuth2, webhook subscriptions, and event handling. Through Jentic: under 1 hour — search, load schema, execute.

FAQs

Specific to using Overlay AI API through Jentic.

What authentication does the Overlay AI API use?

The API uses OAuth2 for authentication. POST /oauth2 initiates the flow, POST /access retrieves access tokens, and POST /refresh renews expired tokens. Through Jentic, OAuth tokens are managed and refreshed automatically, keeping credentials out of agent context.

Can I trigger Zapier workflows based on object detection?

Yes. POST /api/zapier/subscribe/flows subscribes a Zapier webhook to receive detection events, and GET /api/zapier/perform-list retrieves recent events for polling-based triggers.

How do I refresh an expired access token?

POST /refresh with the refresh token to obtain a new access token without requiring the user to re-authenticate.

Is the Overlay AI API free?

Overlay AI pricing depends on subscription tier and usage volume. Check the vendor's pricing page for details on free tiers and paid plans.

What objects can Overlay AI detect?

Overlay AI detects a wide range of objects including people, vehicles, animals, and custom-trained objects. Detection capabilities depend on the models and configurations active in your account.

Can I unsubscribe from Zapier webhooks?

Yes. DELETE /api/zapier/unsubscribe/flows removes webhook subscriptions for detection events.

Overlay AI API

Connect the Overlay AI API to your agent

Capabilities

Start building with Overlay AI API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs