Gong: Ask Entity

Ask about an entity (/v2/entities/ask-entity).

Tool ID: gong_ask_entity

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'gong_ask_entity',
  {
    "workspaceId": 123,
    "crmEntityType": "ACCOUNT",
    "crmEntityId": "crm_entity_123",
    "timePeriod": "LAST_7DAYS",
    "question": "example"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute gong_ask_entity --input '{
  "workspaceId": 123,
  "crmEntityType": "ACCOUNT",
  "crmEntityId": "crm_entity_123",
  "timePeriod": "LAST_7DAYS",
  "question": "example"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "requestId": "request_123",
    "numOfCallsSearched": 123,
    "numOfEmailsSearched": 123
  }
}

Use deepline tools get gong_ask_entity --json for the latest machine-readable contract.

Input reference

Returns the answer to a question about a specified entity. The answer is generated from calls or emails associated with the entity within the specified time period. A maximum of 60 calls and 500 emails are used to answer the question. A call to this API consumes Gong credits according to the number of emails and calls used to generate the answer. Supported entities are Accounts, Deals, Contacts, or Leads that exist in your CRM. The response includes: The answer Details of emails and calls used to generate the answer Required authorization scope: ‘api:ai-ask:read’. Get AI-generated answers to natural language questions about entities (Accounts, Deals, Contacts, Leads).

Name	Type	Required	Default	Details
`payload.workspaceId`	`integer`	Yes	—	Workspace identifier. The calls and emails used to answer the question must be associated with this workspace. Format: `int64`.
`payload.crmEntityType`	`"ACCOUNT" \| "CONTACT" \| "DEAL" \| "LEAD"`	Yes	—	The object type of the entity in the CRM. Allowed: `ACCOUNT`, `CONTACT`, `DEAL`, `LEAD`.
`payload.crmEntityId`	`string`	Yes	—	The CRM Id of the entity the question is asked about.
`payload.timePeriod`	`"LAST_7DAYS" \| "LAST_30DAYS" \| "LAST_90DAYS" \| "LAST_90_DAYS_SINCE_LAST_ACTIVITY" \| "LAST_YEAR_SINCE_LAST_ACTIVITY" \| "LAST_YEAR" \| "THIS_WEEK" \| "THIS_MONTH" \| "THIS_YEAR" \| "THIS_QUARTER" \| "CUSTOM_RANGE" \| "ALL_CONVERSATIONS"`	Yes	—	Specifies the time period during which associated calls and emails must have occurred to be used to generate the answer. The calls and emails must be associated with the specified entity. Allowed: `LAST_7DAYS`, `LAST_30DAYS`, `LAST_90DAYS`, `LAST_90_DAYS_SINCE_LAST_ACTIVITY`, `LAST_YEAR_SINCE_LAST_ACTIVITY`, `LAST_YEAR`, `THIS_WEEK`, `THIS_MONTH`, `THIS_YEAR`, `THIS_QUARTER`, `CUSTOM_RANGE`, `ALL_CONVERSATIONS`.
`payload.fromDateTime`	`string`	No	—	Required when timePeriod is CUSTOM_RANGE Specifies the date and time (UTC) on or after which calls (based on call start time) and emails must have occurred to be included when generating the answer. Date and time (in ISO-8601 format: ‘2024-10-18T08:00:00Z’, where Z stands for UTC).
`payload.toDateTime`	`string`	No	—	Relevant only when timePeriod is CUSTOM_RANGE Specifies the date and time (UTC) before which calls (based on call start time) and emails must have occurred to be included when generating the answer. Date and time (in ISO-8601 format: ‘2024-10-18T08:00:00Z’, where Z stands for UTC).
`payload.question`	`string`	Yes	—	The question to answer.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.requestId`	`string`	No	—	A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
`result.data.numOfCallsSearched`	`integer`	No	—	Number of calls searched to generate the answer Format: `int32`.
`result.data.numOfEmailsSearched`	`integer`	No	—	Number of emails searched to generate the answer Format: `int32`.
`result.data.answer`	`array`	No	—	The generated answer. The answer is composed of one or more answerItems, each representing a portion of the response along with the calls and emails used to generate it.
`result.data.answer[].answerItems`	`array`	No	—	An array of items that make up the answer. Each item contains part of the generated response and metadata describing the calls and emails used as sources.
`result.data.answer[].emailFindings`	`array`	No	—	Evidence from emails used. Includes the relevant emails and the supporting excerpts identified.
`result.data.answer[].emailFindings[].emails`	`array`	No	—	Details of the emails that contain supporting evidence.
`result.data.answer[].emailFindings[].emails[].id`	`string`	No	—	The email Id. This Id can be used to view the email in Gong by adding it to a Gong URL.
`result.data.answer[].emailFindings[].emails[].title`	`string`	No	—	The email subject
`result.data.answer[].emailFindings[].emails[].sentDateTime`	`string`	No	—	The date and time the email message was sent in the ISO-8601 format, for example: ‘2024-01-17T16:20:05-03:00’ or ‘2016-02-16T03:57:04.834+05:30’ or ‘2020-11-20T21:30:07.233692Z’, where Z stands for UTC. Format: `date-time`.
`result.data.answer[].callFindings`	`array`	No	—	Evidence from calls used to generate this answer item. Includes the relevant calls and supporting excerpts.
`result.data.answer[].callFindings[].call`	`object`	No	—	Details of the call that contains supporting evidence for the answer.
`result.data.answer[].callFindings[].call.id`	`string`	No	—	The call ID
`result.data.answer[].callFindings[].call.title`	`string`	No	—	The call title
`result.data.answer[].callFindings[].call.started`	`string`	No	—	The date and time the call was recorded in the ISO-8601 format (e.g., ‘2018-02-18T02:30:00-07:00’ or ‘2018-02-18T08:00:00Z’, where Z stands for UTC). Format: `date-time`.
`result.data.answer[].callFindings[].call.url`	`string`	No	—	Link to the call page in Gong
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

Get started

Build and automate

Common workflows

Data and integrations

Reference

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation