HighLevel: Get the generation details

← Conversation AI operations · Get started

Operation gohighlevel.get_generation_details

Provider route: GET /conversation-ai/generations. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["conversationAi"]["getGenerationDetails"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.conversationAi.getGenerationDetails(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.conversation_ai.get_generation_details(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.messageId	string	Required within parent
query.source	string	Required within parent	One of: conversation, workflow

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get the generation details — response body

Referenced models: Get the generation details — response body

Schemas

Get the generation details — response body

Field	Type	Presence	Description and constraints
$	object	Root
actionLogs	array	Required within parent	List of actions taken during this interaction.
agentId	string	Optional	ID of the employee/agent that generated the response.
faqs	array	Optional	FAQ chunks used in generating the response from fine-tuned data.
history	array	Required within parent	Conversation history leading up to this response.
input	string	Optional	The original input message that triggered this response.
intent	string	Optional	The intent/goal extracted from location prompt.
mode	string	Optional	Mode of operation during this interaction.
prompt	string	Required within parent	The complete prompt used for the AI response.
responseMessage	string	Required within parent	The response message generated by the AI.
website	array	Optional	Website content chunks used in generating the response.

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_generation_details. Catalog operation: get-generation-details. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["conversation-ai.readonly"]

Pinned headers: {"Version": "v3"}

Official provider source