# POST /intuition/text/predict

*Text Prediction API*

## Introduction

Use the Text Predict API to submit text, images, or other supported resources to Sprinklr Intuition for machine learning-based predictions and classifications. The API accepts the prediction engine, input content, language, and optional details.

## API Endpoint

POST https://api3.sprinklr.com/api/v3/intuition/text/predict

## Request Parameters

| Parameter | Type | Required | Description | Sub-Parameters |
|  --- | --- | --- | --- | --- |
| text | string | No | Input text to classify or analyze. Required for text-based engines. | None |
| language | string | No | Language of the input text. Defaults to en. | None |
| engineKey | string | Yes | Engine key identifying the ML model or task to run. | None |
| resourceURL | string | No | Publicly accessible resource URL. | None |
| details | object (string to string) | No | Additional key-value metadata passed to the classification engine. | Dynamic key-value pairs |


## Example Request

{"engineKey":"sentiment-en","text":"I love this product!"}

## Example Response

204 No Content

# POST /intuition/text/batch-predict

*Batch Text Prediction API*

## Introduction

Use the Batch Text Prediction API to run text-based Sprinklr Intuition or machine learning predictions for multiple request objects in a single API call. Each item in the request array follows the Text Predict request schema and specifies the engine to execute along with the input text, language, resource URL, or additional metadata.

## API Endpoint

| **Method** | **URL** | **Consumes** | **Produces** |
|  --- | --- | --- | --- |
| POST | https://api3.sprinklr.com/api/v3/intuition/text/batch-predict | application/json | application/json |


## Authentication and Permissions

Include a valid API v3 bearer token in the Authorization header. The engineKey must identify an available Intuition engine.

> Authorization: Bearer <accessToken>


## Path Parameters

None.

## Query Parameters

None.

## Request Parameters

The request body is an array of Intuition request objects. Each array item supports the following parameters:

| **Parameter** | **Type** | **Required** | **Description** | **Sub-Parameters** |
|  --- | --- | --- | --- | --- |
| [] | array | Yes | Collection of prediction request objects. | [].text, [].language, [].engineKey, [].resourceURL, [].details |
| [].text | string | No | Input text to classify or analyze. | None |
| [].language | string | No | Language of the input text. Defaults to en. | None |
| [].engineKey | string | Yes | Engine key identifying the machine learning model or task. | None |
| [].resourceURL | string | No | Publicly accessible resource URL. | None |
| [].details | object (string to string) | No | Additional key-value metadata passed to the engine. | Dynamic key-value pairs, such as [].details.channel |


## Example Request

## Batch sentiment prediction

> [
{ "engineKey": "sentiment-en", "text": "Great service!" },
{ "engineKey": "sentiment-en", "text": "Terrible experience." }
]


## Mixed engine keys

> [
{ "engineKey": "sentiment-en", "text": "Love it", "language": "en" },
{
"engineKey": "topic-classifier",
"text": "Shipping delay",
"details": { "channel": "twitter" }
}
]


## Response Parameters

| **Parameter** | **Type** | **Required** | **Description** | **Sub-Parameters** |
|  --- | --- | --- | --- | --- |
| data | array | Yes | Array of text prediction result objects. | data[].input, data[].response |
| data[].input | object | Yes | Echo of the corresponding request element. | Request-specific fields |
| data[].response | object | Yes | Text prediction response. | data[].response.classDetails |
| data[].response.classDetails | array | No | Collection of detected classification details. | label, confidence, additional |
| label | string | No | Detected category label. | None |
| confidence | number | No | Prediction confidence between 0 and 1. | None |
| additional | object (string to string) | No | Engine-specific additional metadata. | Dynamic key-value pairs |


## Example Response

> {
"data": [
{
"input": { "engineKey": "sentiment-en", "text": "Great service!" },
"response": {
"classDetails": [{ "label": "Positive", "confidence": 0.91 }]
}
},
{
"input": { "engineKey": "sentiment-en", "text": "Terrible experience." },
"response": {
"classDetails": [{ "label": "Negative", "confidence": 0.88 }]
}
}
]
}


## HTTP Status Codes

| **Status Code** | **Condition** | **Description** |
|  --- | --- | --- |
| 200 | Success | Returns an array of text prediction result objects. |
| 400 | Invalid request | Returned for a null request body, a null array element, bean validation failure, or an invalid engineKey. |
| 500 | Server error | Returned for an internal classification or downstream service failure. |


## Behavior Notes

- Each request element is validated independently. A null element at any array index returns an HTTP 400 response.
- Results are correlated with inputs through server-assigned internal IDs.


# POST /intuition/location-insights/predict

*Location Insights Prediction API*

## Introduction

Use the Location Insights Prediction API to run a single location-insights Intuition prediction for the specified text and engine key. The API analyzes unstructured text and returns detected location categories, subjects, sentiments, and phrase-level details that you can use for structured analysis.

## API Endpoint

| **Method** | **URL** | **Consumes** | **Produces** |
|  --- | --- | --- | --- |
| POST | https://api3.sprinklr.com/api/v3/intuition/location-insights/predict | application/json | application/json |


## Authentication and Permissions

Include a valid API v3 bearer token in the Authorization header. Use an engineKey associated with an available Intuition engine.

> Authorization: Bearer <accessToken>


## Path Parameters

None.

## Query Parameters

None.

## Request Parameters

| **Parameter** | **Type** | **Required** | **Description** | **Sub-Parameters** |
|  --- | --- | --- | --- | --- |
| text | string | No | Input text to classify or analyze. Required for text-based engines. | None |
| language | string | No | Language of the input text. Defaults to en. | None |
| engineKey | string | Yes | Engine key identifying the machine learning model or task. | None |
| resourceURL | string | No | Publicly accessible resource URL. Required for engines that accept a URL instead of inline content. | None |
| details | object (string to string) | No | Additional key-value metadata passed to the classification engine. | Dynamic key-value pairs |


## Example Request

## Minimal request

> {
"engineKey": "location-insights-en",
"text": "The store in downtown Chicago was amazing."
}


## Request with language

> {
"engineKey": "location-insights-en",
"text": "Visited the Paris flagship store.",
"language": "en"
}


## Response Parameters

| **Parameter** | **Type** | **Required** | **Description** | **Sub-Parameters** |
|  --- | --- | --- | --- | --- |
| data | object | Yes | Single location insight result object. | input, response |
| data.input | object | Yes | Echo of the request input. The server assigns an internal ID. | text, language, engineKey, resourceURL, details |
| data.response | array of objects | No | Detected location insight phrase details. | category, subject, sentiment, additional |
| category | object | No | Detected location category phrase. | name, start, end, phrase, confidence |
| subject | object | No | Detected location subject phrase. | name, start, end, phrase, confidence |
| sentiment | object | No | Detected sentiment phrase for the insight. | name, start, end, phrase, confidence |
| additional | object (string to string) | No | Engine-specific additional metadata. | Dynamic key-value pairs |
| name | string | No | Name of the category to which the detected phrase belongs. | None |
| start | integer | No | Starting character position of the detected phrase. | None |
| end | integer | No | Ending character position of the detected phrase. | None |
| phrase | string | No | Detected phrase text. | None |
| confidence | number | No | Prediction confidence between 0 and 1. | None |


## Example Response

> {
"data": {
"input": {
"engineKey": "location-insights-en",
"text": "The store in downtown Chicago was amazing.",
"language": "en"
},
"response": [
{
"category": {
"name": "Location Experience",
"start": 4,
"end": 29,
"phrase": "store in downtown Chicago",
"confidence": 0.91
},
"sentiment": {
"name": "Positive",
"start": 34,
"end": 41,
"phrase": "amazing",
"confidence": 0.95
}
}
]
}
}


## HTTP Status Codes

| **Status Code** | **Condition** | **Description** |
|  --- | --- | --- |
| 200 | Success | Returns a single location insight result object. |
| 400 | Invalid request | Returned for a null request body, a null list element, bean validation failure, or an invalid engineKey. |
| 500 | Server error | Returned for an internal classification or downstream service failure. |


# POST /intuition/location-insights/batch-predict

*Batch Location Insights Prediction API*

## Introduction

Use the Batch Location Insights Prediction API to run a single location-insights Intuition prediction for the specified text and engine key. The API analyzes unstructured text and returns detected location categories, subjects, sentiments, and phrase-level details that you can use for structured analysis.

## API Endpoint

| **Method** | **URL** | **Consumes** | **Produces** |
|  --- | --- | --- | --- |
| POST | https://api3.sprinklr.com/api/v3/intuition/location-insights/batch-predict | application/json | application/json |


## Authentication and Permissions

Include a valid API v3 bearer token in the Authorization header. Use an engineKey associated with an available Intuition engine.

> Authorization: Bearer <accessToken>


## Path Parameters

None.

## Query Parameters

None.

## Request Parameters

The request body is an array of Intuition request objects. Each array item supports the following parameters:

| **Parameter** | **Type** | **Required** | **Description** | **Sub-Parameters** |
|  --- | --- | --- | --- | --- |
| [] | array | Yes | Collection of location-insights prediction request objects. | [].text, [].language, [].engineKey, [].resourceURL, [].details |
| [].text | string | No | Input text to classify or analyze. Required for text-based engines. | None |
| [].language | string | No | Language of the input text. Defaults to en. | None |
| [].engineKey | string | Yes | Engine key identifying the machine learning model or task. | None |
| [].resourceURL | string | No | Publicly accessible resource URL. Required for engines that accept a URL instead of inline content. | None |
| [].details | object (string to string) | No | Additional key-value metadata passed to the classification engine. | Dynamic key-value pairs |


## Example Request

> [
{ "engineKey": "location-insights-en", "text": "Great store in NYC." },
{ "engineKey": "location-insights-en", "text": "Poor service in London." }
]


## Response Parameters

| **Parameter** | **Type** | **Required** | **Description** | **Sub-Parameters** |
|  --- | --- | --- | --- | --- |
| data | array | Yes | Array of location insight result objects. | data[].input, data[].response |
| data[].input | object | Yes | Echo of the request input. The server assigns an internal ID. | text, language, engineKey, resourceURL, details |
| data[].response | array of objects | No | Detected location insight phrase details. | category, subject, sentiment, additional |
| category | object | No | Detected location category phrase. | name, start, end, phrase, confidence |
| subject | object | No | Detected location subject phrase. | name, start, end, phrase, confidence |
| sentiment | object | No | Detected sentiment phrase for the insight. | name, start, end, phrase, confidence |
| additional | object (string to string) | No | Engine-specific additional metadata. | Dynamic key-value pairs |
| name | string | No | Name of the category to which the detected phrase belongs. | None |
| start | integer | No | Starting character position of the detected phrase. | None |
| end | integer | No | Ending character position of the detected phrase. | None |
| phrase | string | No | Detected phrase text. | None |
| confidence | number | No | Prediction confidence between 0 and 1. | None |


## Example Response

> {
"data": [
{
"input": { "engineKey": "location-insights-en", "text": "Great store in NYC." },
"response": [
{
"category": { "name": "Location Experience", "phrase": "store in NYC" },
"sentiment": { "name": "Positive", "phrase": "Great" }
}
]
},
{
"input": { "engineKey": "location-insights-en", "text": "Poor service in London." },
"response": [
{
"subject": { "name": "Service", "phrase": "service" },
"sentiment": { "name": "Negative", "phrase": "Poor" }
}
]
}
]
}


## HTTP Status Codes

| **Status Code** | **Condition** | **Description** |
|  --- | --- | --- |
| 200 | Success | Returns an array of location insight result objects. |
| 400 | Invalid request | Returned for a null request body, a null list element, bean validation failure, or an invalid engineKey. |
| 500 | Server error | Returned for an internal classification or downstream service failure. |


# POST /intuition/product-insights/predict

Product Insights Prediction API

## Introduction

Use the Product Insights Prediction API to run a single product-insights Intuition prediction against input text. The API identifies product categories, brands, and sentiment, and returns phrase-level insights with hierarchical product categorization.

## API Endpoint

| Method | URL | Consumes | Produces |
|  --- | --- | --- | --- |
| POST | https://api3.sprinklr.com/api/v3/intuition/product-insights/predict | application/json | application/json |


## Authentication and Permissions

Include a valid API v3 bearer token and a supported product-insights engine key.

Authorization: Bearer <accessToken>

## Request Parameters

| Parameter | Type | Required | Description | Sub-Parameters |
|  --- | --- | --- | --- | --- |
| text | string | No | Input text to classify or analyze. | None |
| language | string | No | Language of the input text. Defaults to en. | None |
| engineKey | string | Yes | Engine key identifying the ML model/task. | None |
| resourceURL | string | No | Publicly accessible resource URL. | None |
| details | object (string to string) | No | Additional metadata. | Dynamic key-value pairs |


## Example Request

{
"engineKey": "product-insights-en",
"text": "The new iPhone camera is incredible but battery life is poor."
}

## Response Parameters

| Parameter | Type | Required | Description | Sub-Parameters |
|  --- | --- | --- | --- | --- |
| data | object | Yes | Single product insight result object. | input,response |
| input | object | Yes | Echo of request input. | text,language,engineKey,resourceURL,details |
| response | array | Yes | Prediction output. | category,brand,sentiment,additional |
| category | object | No | Detected product category phrase with hierarchy. | name,start,end,phrase,confidence,l1,l2,l3 |
| brand | object | No | Detected brand phrase. | name,start,end,phrase,confidence |
| sentiment | object | No | Detected sentiment phrase. | name,start,end,phrase,confidence |
| additional | object | No | Engine specific metadata. | Dynamic key-value pairs |
| l1 | string | No | Level-1 product category. | None |
| l2 | string | No | Level-2 product category. | None |
| l3 | string | No | Level-3 product category. | None |


## Example Response Structure

{
"data": {
"input": {"engineKey":"product-insights-en"},
"response": [{
"category":{"name":"Smartphones","l1":"Electronics"},
"brand":{"name":"Apple"},
"sentiment":{"name":"Mixed"}
}]
}
}

## HTTP Status Codes

| Status | Condition | Description |
|  --- | --- | --- |
| 200 | Success | Returns a product insight result object. |
| 400 | Invalid request | Null request body or invalid engineKey. |
| 500 | Server error | Internal classification or downstream service failure. |


# POST /intuition/product-insights/batch-predict

Batch Product Insights Prediction API

## Introduction

Use the Batch Product Insights Prediction API to run product-insights predictions for multiple text inputs in a single API call. Submit an array of Intuition request objects and receive product insight results containing detected product categories, brands, sentiments, and hierarchical category information.

## API Endpoint

POST https://api3.sprinklr.com/api/v3/intuition/product-insights/batch-predict

## Request Parameters

| **Parameter** | **Sub-Parameter** | **Type** | **Required** | **Description** |
|  --- | --- | --- | --- | --- |
| [] | - | Array | Yes | Collection of product insights prediction request objects. |
| [] | text | String | No | Input text to classify or analyze. |
| [] | language | String | No | Language of the input text. Defaults to en. |
| [] | engineKey | String | Yes | Engine key identifying the product insights ML model. |
| [] | resourceURL | String | No | Publicly accessible resource URL. |
| [] | details | Object (String → String) | No | Additional metadata passed to the engine. |
| details | Dynamic key-value pairs | String | No | Engine-specific metadata. |


## Example Request

[

{ "engineKey": "product-insights-en", "text": "Love the Nike shoes." },

{ "engineKey": "product-insights-en", "text": "Samsung TV has great picture." }

]

## Example Response

HTTP/1.1 200 (Success)

# POST /intuition/intent/predict

Intent Prediction API

## Introduction

Use the Intent Prediction API to run a single intent-based Intuition prediction against input text. The API identifies user intent, categorization details, and phrase-level insights based on the selected intent classification engine.

## API Endpoint

POST https://api3.sprinklr.com/api/v3/intuition/intent/predict

## Request Parameters

| **Parameter** | **Sub-Parameter** | **Type** | **Required** | **Description** |
|  --- | --- | --- | --- | --- |
| Root Object | text | String | No | Input text to classify or analyze. |
| Root Object | language | String | No | Language of the input text. Defaults to en. |
| Root Object | engineKey | String | Yes | Engine key identifying the ML model or task to run. |
| Root Object | resourceURL | String | No | Publicly accessible resource URL. |
| Root Object | details | Object (String → String) | No | Additional metadata passed to the classification engine. |
| details | Dynamic key-value pairs | String | No | Engine-specific metadata. |


## Example Request

{

"engineKey": "intent-classifier",

"text": "I want to cancel my subscription"

}

## Example Response

HTTP/1.1 200 (Success)

# POST /intuition/intent/batch-predict

Batch Intent Prediction API

## Introduction

Use the Batch Intent Prediction API to run intent predictions for multiple text inputs in a single request. Submit an array of Intuition request objects and receive intent detection results for each input.

## API Endpoint

POST https://api3.sprinklr.com/api/v3/intuition/intent/batch-predict

## Authentication

Authorization: Bearer <accessToken>

## Request Parameters

| **Parameter** | **Sub-Parameter** | **Type** | **Required** | **Description** |
|  --- | --- | --- | --- | --- |
| [] | - | Array | Yes | Collection of intent prediction request objects. |
| [] | text | String | No | Input text to classify or analyze. Required for text-based engines. |
| [] | language | String | No | Language of the input text. Defaults to en. |
| [] | engineKey | String | Yes | Engine key identifying the ML model or intent classification task to run. |
| [] | resourceURL | String | No | Publicly accessible resource URL. |
| [] | details | Object (String → String) | No | Additional key-value metadata passed to the classification engine. |
| details | Dynamic key-value pairs | String | No | Engine-specific metadata. |


## Example Request

[

{

"engineKey": "intent-classifier",

"text": "I want to cancel my subscription"

},

{

"engineKey": "intent-classifier",

"text": "How do I update my billing information?"

}

]

``

## Example Response

HTTP/1.1 200 (Success)

# POST /intuition/visual/predict

Visual Prediction API

## Introduction

Use the Visual Prediction API to run image-based Intuition predictions using a resource URL and engine key. The API detects visual entities and returns prediction results including labels, confidence scores, and bounding box information.

## API Endpoint

POST https://api3.sprinklr.com/api/v3/intuition/visual/predict

## Request Parameters

| **Parameter** | **Sub-Parameter** | **Type** | **Required** | **Description** |
|  --- | --- | --- | --- | --- |
| Root Object | text | String | No | Input text to classify or analyze. Required for text-based engines. |
| Root Object | language | String | No | Language of the input text. Defaults to en. |
| Root Object | engineKey | String | Yes | Engine key identifying the ML model or task to run. |
| Root Object | resourceURL | String | No | Publicly accessible resource URL. Required for image/visual engines that accept a URL instead of inline content. |
| Root Object | details | Object (String → String) | No | Additional key-value metadata passed to the classification engine. |
| details | Dynamic key-value pairs | String | No | Engine-specific metadata. |


## Example Request

{

"engineKey": "logo-detection",

"resourceURL": "[https://example.com/banner.jpg]()",

"language": "en"

}

## Response Parameters

HTTP/1.1 200 (Success)

# POST /intuition/visual/batch-predict

Batch Visual Prediction API

## Introduction

Use the Batch Visual Prediction API to run visual predictions for multiple image inputs in a single request. Submit an array of image-based Intuition request objects and receive visual detection results, including detected entities, confidence scores, and bounding box coordinates.

## API Endpoint

POST https://api3.sprinklr.com/api/v3/intuition/visual/batch-predict

## Request Parameters

| **Parameter** | **Sub-Parameter** | **Type** | **Required** | **Description** |
|  --- | --- | --- | --- | --- |
| [] | - | Array | Yes | Collection of visual prediction request objects. |
| [] | text | String | No | Input text to classify or analyze. |
| [] | language | String | No | Language of the input text. Defaults to en. |
| [] | engineKey | String | Yes | Engine key identifying the ML model or visual detection task to run. |
| [] | resourceURL | String | No | Publicly accessible image URL. Required for visual prediction engines that operate on images. |
| [] | details | Object (String → String) | No | Additional key-value metadata passed to the classification engine. |
| details | Dynamic key-value pairs | String | No | Engine-specific metadata. |


## Example Request

[

{ "engineKey": "logo-detection", "resourceURL": "[https://example.com/img1.jpg]()" },

{ "engineKey": "logo-detection", "resourceURL": "[https://example.com/img2.jpg]()" }

]

## Example Response

HTTP/1.1 200 (Success)