Agent Studio Overview

The Agent Studio API lets you programmatically interact with AI agents built in the HoopAI Agent Studio. Use it to list available agents, retrieve agent details, and execute agents to get AI-powered responses — all through a simple REST interface.

Base URL

https://services.leadconnectorhq.com

Authentication

All endpoints require a Bearer token and an API version header.

Authorization: Bearer <access_token>
Version: 2021-04-15

See OAuth 2.0 to obtain an access token.

OAuth scopes

Scope	Access
`agent-studio.readonly`	List and retrieve agents
`agent-studio.write`	Execute agents

Quick start

Execute an agent and get a response:

curl -X POST https://services.leadconnectorhq.com/agent-studio/public-api/agents/agent_abc123/execute \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-04-15" \
  -H "Content-Type: application/json" \
  -d '{
    "locationId": "ve9EPM428h8vShlRW1KT",
    "message": "What services do you offer?",
    "contactId": "contact_abc123"
  }'

The response includes an executionId that you can pass in follow-up requests to maintain conversation context.

Endpoints

Method	Path	Description
`GET`	`/agent-studio/public-api/agents`	List all agents for a location
`GET`	`/agent-studio/public-api/agents/{agentId}`	Get agent details by ID
`POST`	`/agent-studio/public-api/agents/{agentId}/execute`	Execute an agent

Conversation AI API — Manage conversation bots and training
Knowledge Base API — Train knowledge bases that agents can reference
Contacts API — Look up contacts associated with agent conversations

Conversation AI

Agent Studio

Knowledge Base

Voice AI

Phone System

Base URL

Authentication

OAuth scopes

Quick start

Endpoints

​Base URL

​Authentication

​OAuth scopes

​Quick start

​Endpoints

​Related

Base URL

Authentication

OAuth scopes

Quick start

Endpoints

Related