How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
HighLevel

HighLevel Agents API

Documentation for Agent Studio APIs

Documentation Provider Profile APIs.io OpenAPI GitHub

HighLevel Agents API is one of 117 APIs that HighLevel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 60 JSON Schema definitions.

Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification and 60 JSON Schemas.

This API exposes 21 operations across 13 paths, and defines 47 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://services.leadconnectorhq.com.

21 operations 13 paths 47 schemas 3 DELETE8 GET3 PATCH6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.gohighlevel.com
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 5

HighLevel Agents API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer). It accepts HTTP bearer tokens (JWT) (Location-Access). It accepts HTTP bearer tokens (JWT) (Location-Access-Only). It accepts HTTP bearer tokens (JWT) (Agency-Access). It accepts HTTP bearer tokens (JWT) (Agency-Access-Only).

  • bearer — Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
  • Location-Access — Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
  • Location-Access-Only — Use the Access Token generated with user type as Sub-Account.
  • Agency-Access — Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.
  • Agency-Access-Only — Use the Access Token generated with user type as Agency.

Paths & Operations 21

Across 13 paths, the API surfaces 21 operations — 3 DELETE, 8 GET, 3 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Agents 21

Documentation for Agent Studio APIs

POST
/agent-studio/agent
Create Agent
createAgent 2 params body → 201400401422500
GET
/agent-studio/agent
List Agents
getAgents 6 params → 200400401422500
PATCH
/agent-studio/agent/versions/{versionId}
Update Agent
updateAgentVersion 3 params body → 200400401404422500
PATCH
/agent-studio/agent/{agentId}
Update Agent Metadata
updateAgentMetadata 3 params body → 200400401404422500
DELETE
/agent-studio/agent/{agentId}
Delete Agent
deleteAgent 4 params → 200400401404422500
GET
/agent-studio/agent/{agentId}
Get Agent
getAgentById 4 params → 200400401404422500
POST
/agent-studio/agent/versions/{versionId}/publish
Promote to Production
promoteAndPublish 3 params body → 200400401404422500
POST
/agent-studio/agent/{agentId}/execute
Execute Agent
executeAgent 3 params body → 200400401403404422500
GET
/agent-studio/public-api/agentsdeprecated
List Agents (Deprecated)
getAgents-deprecated 5 params → 200400401422500
GET
/agent-studio/public-api/agents/{agentId}deprecated
Get Agent (Deprecated)
getAgentById-deprecated 4 params → 200400401404422500
POST
/agent-studio/public-api/agents/{agentId}/executedeprecated
Execute Agent (Deprecated)
executeAgent-deprecated 3 params body → 200400401403404422500
POST
/conversation-ai/agents
Create an Agent
create-agent 1 param body → 201400401422
GET
/conversation-ai/agents/search
Search Agents
search-agent 4 params → 200400401422
PUT
/conversation-ai/agents/{agentId}
Update Agent
update-agent 2 params body → 200400401422
GET
/conversation-ai/agents/{agentId}
Get Agent
get-agent 2 params → 200400401422
DELETE
/conversation-ai/agents/{agentId}
Delete Agent
delete-agent 2 params → 200400401422
POST
/voice-ai/agents
Create Agent
postVoiceAiAgents 1 param body → 201400401422
GET
/voice-ai/agents
List Agents
get-agents 5 params → 200400401422
PATCH
/voice-ai/agents/{agentId}
Patch Agent
patch-agent 3 params body → 200400401422
GET
/voice-ai/agents/{agentId}
Get Agent
getVoiceAiAgentsByAgentId 3 params → 200400401422
DELETE
/voice-ai/agents/{agentId}
Delete Agent
deleteVoiceAiAgentsByAgentId 3 params → 204400401422

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are GetAgentResponseDTO (21 properties), PatchAgentResponseDTO (20 properties), CreateAgentResponseDTO (20 properties), UpdateEmployeeDto (19 properties). Each schema is shown below with its type and property counts.

UpdatePublicAgentMetadataDTO
object
4 properties 1 required
CreatePublicAgentDTO
object
11 properties 3 required
GetAgentByIdResponseDTO
object
4 properties 3 required
UpdatePublicAgentResponseDTO
object
3 properties 3 required
ExecutePublicAgentDTO
object
7 properties 2 required
GetPublishedAgentsResponseDTO
object
4 properties 4 required
PromoteAndPublishDTO
object
4 properties 1 required
CreatePublicAgentResponseDTO
object
4 properties 4 required
UpdatePublicAgentVersionDTO
object
11 properties 1 required
PromoteAndPublishResponseDTO
object
3 properties 3 required
DeletePublicAgentResponseDTO
object
3 properties 2 required
InternalServerErrorDTO
object
2 properties
PublicAttachmentSchema
object
2 properties 2 required
ExecutePublicAgentResponseDTO
object
11 properties 11 required
CreateEmployeeDto
object
19 properties 4 required
UpdateEmployeeDto
object
19 properties 1 required
EmployeeListItemDTO
object
19 properties 12 required
EmployeeResponseDTO
object
19 properties 10 required
ActionsIdDto
object
2 properties 2 required
SearchEmployeeResponseDTO
object
3 properties 3 required
DeleteEmployeeResponseDTO
object
2 properties 2 required
TranslationSchema
object
2 properties
CustomActionApiDetailsDTO
object
6 properties 2 required
WorkflowTriggerParameters
object
3 properties 3 required
CallTransferActionParameters
object
5 properties 4 required
AgentWorkingHoursDTO
object
2 properties 2 required
GetAgentResponseDTO
object
21 properties 15 required
SendPostCallNotificationDTO
object
5 properties 5 required
KnowledgeBaseParameters
object
2 properties 2 required
VoiceAILanguage
string
Language code for the agent's speech and understanding. Default: "en-US"
PatchAgentResponseDTO
object
20 properties 14 required
CreateAgentResponseDTO
object
20 properties 14 required
IntervalDTO
object
4 properties 4 required
TranslationDTO
object
2 properties 1 required
AgentActionResponseDTO
object
4 properties 4 required
SendPostCallNotificationSchema
object
5 properties
CustomActionParameterDTO
object
4 properties 1 required
PatchAgentDTO
object
18 properties
AppointmentBookingActionParameters
object
4 properties 4 required
CustomActionHeaderDTO
object
2 properties 2 required
InCallDataExtractionActionParameters
object
4 properties 3 required
AgentCreationRequestDTO
object
19 properties 1 required
GetAgentsResponseDTO
object
4 properties 4 required
CustomActionParameters
object
4 properties 3 required
PatienceLevel
string
Tolerance level for caller response delays. Default: "high"
SMSParameters
object
3 properties 3 required
DataExtractionActionParameters
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

highlevel-agents-api-openapi.yml Raw ↑

Other APIs HighLevel publishes across the network.

HighLevel Account API
AE Profile APIs.io
HighLevel Actions API
AE Profile APIs.io
HighLevel Affiliates API
AE Profile APIs.io
HighLevel App Billing Management API
AE Profile APIs.io
HighLevel App Management API
AE Profile APIs.io
HighLevel Appointment Notes API
AE Profile APIs.io
HighLevel Appointments API
AE Profile APIs.io
HighLevel Associations API
AE Profile APIs.io
HighLevel Availability API
AE Profile APIs.io
HighLevel Blogs API
AE Profile APIs.io
HighLevel Brand Boards API
AE Profile APIs.io
HighLevel Bulk API
AE Profile APIs.io
#Agents
← Back to H APIs
API Details
ID
highlevel:highlevel-agents-api
Base URL
https://api.gohighlevel.com
Docs
https://developers.gohighlevel.com
Provider
HighLevel
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=highlevel-agents-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/highlevel-agents-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of HighLevel Agents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.