1Execute Natural Language Query

Content-Type (Required)

String

Specifies media type of request body.

application/x-www-form-urlencoded

sessionid

String

The session ID is the token received from the login API.

Note: Session ID is required for token-based authentication.

–

name-or-id (Required)

String

Name or ID of the Entity on which the Natural Language Query needs to be executed.

Note: If the Entity name is provided, then folderName must also be provided.

–

by

String

Specifies whether the name-or-id parameter should be interpreted as Entity name or Entity ID.

If by=name, provide the Entity name in the name-or-id parameter.

If by=id, provide the Entity ID in the name-or-id parameter.

The default value is name.

–

nlQuery (Required)

String

Natural Language Query that needs to be executed.

–

previousQuery

String

If the user has previously executed the API and wishes to continue from the same context, they can provide the query received in the previous response. If this parameter is not provided, the context of prior executions will not be preserved.

–

entityType (Required)

String

Type of the entity on which Natural Language Query is to be executed.

AISPACE

selectedAISpaceObjects

String

Specifies the AI Space entities to be used for NLP-based querying.

An AI Space can contain multiple entities that are eligible for querying. If this parameter is empty or not provided, all entities available in the AI Space are considered during query processing.

Users can optionally restrict the scope of querying by explicitly specifying one or more entities.

Note: An example is provided under the Resources section below.

–

additionalInfo

String

An AI Space can contain multiple entities. When submitting consecutive or follow-up queries, users may supply this parameter to preserve context and improve query resolution.

Note: This object can include previously executed query details.

Note: An example is provided under the Resources section below.

–

folderName

String

Name of the folder in which entity is present.

–

includeData

String

Specifies whether to include data in the response.

true/false

Default: true

includeSummary

String

Specifies whether to include a generated summary (key insights) in the response.

true/false

Default: false

summaryType

String

The length/detail level of the summary when includeSummary is true.

"BRIEF", "MODERATE", "DETAILED"

Default: "MODERATE"

maxRows

String

Maximum number of data rows to return. Must be a valid integer.

Default: "10000"

requestID

String

Custom request ID for logging and tracing. If provided, it overrides the auto-generated request ID in the logger context.

–

includeActivityLogs

String

Specifies whether to include activity logs in the response (used in Deep Dive Mode).

true/false

Default: true

ignoreFeedback

String

Specifies whether to ignore user feedback when generating the response.

true/false

Default: true

401

Authorization information is missing or invalid.

404

No matching record found.

412

Precondition failed. Parameter missing.

500

Internal Server Error

Field

Type

Description

Possible Values

Example

entityName

String

Name of the entity within the AI Space. Matched case-insensitively against the AI Space's entity names. Takes priority over entityId if both are provided.

Any valid entity name within the AI Space

entityName

entityType

String

Type of the entity within the AI Space.

SEMANTIC_MODEL

SEMANTIC_MODEL

folderName

String

Folder name of the entity. Used together with entityName for lookup. Matched case-insensitively. If not provided, defaults to empty string.

Any valid folder name, or empty string

folderName

entityId

String

ID of the entity within the AI Space. Used as fallback when entityName + folderName match fails.

Any valid entity ID (UUID format)

12AB5678-1B3-1234-ABCD-CC316D1F1FBB

Field

Type

Description

Possible Values

Example

context

Object

Additional context data that is merged into the query request sent to the backend.

—

{ "lastResolvedQuestion": "...", "previouslyUsedEntities": [...] }

context.lastResolvedQuestion

String

The last natural language question that was resolved, used for conversational context in follow-up queries.

Any string

last query that was asked

context.valueDisambiguationContext

String

JSON array string representing disambiguation context for resolving ambiguous values in the current query.

A valid JSON array string

[]

context.previouslyUsedEntities

Array<Object>

List of entities previously used in the conversation, helping the backend resolve entity references in follow-up queries.

—

[{ "name": "...", "id": "...", "folderName": "...", "type": "..." }]

context.previouslyUsedEntities[].name

String

Name of the previously used entity.

Any valid entity name

entity name

context.previouslyUsedEntities[].id

String

ID of the previously used entity.

Any valid entity ID

entity ID

context.previouslyUsedEntities[].folderName

String

Folder name where the previously used entity resides.

Any valid folder name

folder name

context.previouslyUsedEntities[].type

String

Type of the previously used entity.

SEMANTIC_MODEL, "WORKBOOK", "WORKSHEET"

SEMANTIC_MODEL