Skip to main content
GET
/
api
/
ai
/
agent
/
call-endpoint
AI Call Endpoint
curl --request GET \
  --url https://app.aisync.link/api/ai/agent/call-endpoint \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "data": {
    "endpoint": "",
    "Method": "POST",
    "form_data": [
      "phone_number",
      "email",
      "first_name",
      "last_name",
      "ghl_contact_id",
      "override_agent_id",
      "local_presence_number=No (Yes/No)<br> [If Yes, then the call will be made from AI local presence number]"
    ]
  }
}

AI Call Endpoint

Retrieve the call endpoint URL for a specific AI agent. This endpoint provides the unique URL that can be used to initiate calls with the specified agent.
agent_id
string
required
The unique identifier of the agent (e.g., agent_07a9005357b35d0943f7359ad9)
Authorization
string
required
Bearer token in the format: Bearer {access_token}
Content-Type
string
required
Must be set to application/json
curl --location 'https://app.aisync.link/api/ai/agent/call-endpoint?agent_id=agent_07a9005357b35d0943f7359ad9' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{bearer_token}}'
status
string
Response status (e.g., “success”)
data
object
Response data object containing endpoint information
data.endpoint
string
The unique endpoint URL for initiating calls with this agent
data.Method
string
The HTTP method to use when calling the endpoint (typically “POST”)
data.form_data
array
Array of form field names that must be included when making a POST request to the endpoint:
  • phone_number: The phone number to call
  • email: Contact email address
  • first_name: Contact’s first name
  • last_name: Contact’s last name
  • ghl_contact_id: GoHighLevel contact ID
  • override_agent_id: Agent ID override (optional)
  • local_presence_number: Set to “Yes” to make the call from AI local presence number, or “No” otherwise
Use the returned endpoint URL with POST method and include the required form_data fields to initiate conversations with your AI agent. The endpoint is unique to each agent. When local_presence_number is set to “Yes”, the call will be made from the AI local presence number.

Authorizations

Authorization
string
header
required

Bearer token authentication. Include the access token in the Authorization header as 'Bearer {access_token}'

Query Parameters

agent_id
string
required

The unique identifier of the agent (e.g., agent_07a9005357b35d0943f7359ad9)

Response

Call endpoint URL

status
string
required

Response status (e.g., 'success')

Example:

"success"

data
object
required