# Spotter APIs

> For the complete documentation index, see [llms.txt](https://developers.thoughtspot.com/docs/llms.txt)

Source: https://developers.thoughtspot.com/docs/spotter-api

# Spotter APIs

The Spotter APIs support natural-language-driven analytics, context-aware and guided data analysis, and integration with agentic systems.

The key capabilities of the Spotter APIs include the following:

-   Initiating and managing conversational sessions
    
-   Processing natural-language queries and interpreting user intent
    
-   Generating analytical responses, insights, and visualizations
    
-   Decomposing complex user queries
    

Spotter manages conversation sessions, context tracking, and response generation for user-submitted queries. The Spotter APIs are designed for use in Spotter-driven analytics and also for agentic interactions within an orchestrated agent framework.

Spotter API operations require `CAN_USE_SPOTTER` privilege and at least view-level access to the underlying metadata entities referenced in the response.

## Supported API operations

For information about supported API operations, see the following pages:

-   [APIs for Spotter classic workflow]({{navprefix}}/{{spotter-classic-apis}})
    
-   [APIs for Spotter agent workflows]({{navprefix}}/{{spotter-agent-apis}})
    
-   [APIs for Spotter agent conversations]({{navprefix}}/{{spotter-agent-conversation-apis}})
    
-   [APIs for Spotter agent streaming responses]({{navprefix}}/{{spotter-agent-streaming-apis}})
    
-   [APIs for processing Spotter agent conversation results]({{navprefix}}/{{spotter-agent-process-results-apis}})
    
-   [APIs for Spotter agent data literacy]({{navprefix}}/{{spotter-agent-data-literacy-apis}})
    
-   [APIs for sharing Spotter conversations]({{navprefix}}/{{spotter-agent-sharing-apis}})
    
-   [APIs for Spotter conversation management]({{navprefix}}/{{spotter-agent-conversation-mgmt-apis}})
    
-   [APIs for Spotter coaching and data model instructions]({{navprefix}}/{{spotter-nl-instructions}})
    
-   [APIs for Spotter agent instructions]({{navprefix}}/{{spotter-agent-instructions}})
    

## Locale settings for API requests

When using the [Single Answer]({{navprefix}}/{{spotter-classic-apis}}#_generate_a_single_answer) and [Send message]({{navprefix}}/{{spotter-classic-apis}}#_send_a_query_to_a_conversation_session) APIs, the locale used for API requests depends on your application’s locale settings:

-   If your application is set to "Use browser language," the API will not apply the default locale. In this case, you must explicitly include the desired locale code in the `Accept-Language` header of your API request. If you do not specify the locale, the API may not return responses in the expected language or regional format.
    
-   If you have set a specific locale in your ThoughtSpot instance or user profile, the API uses this locale to generate responses, overriding the browser or OS locale.
    

## Per-user API rate limits

The following rate limits apply to Spotter agent APIs per user:

-   A maximum of 10 conversation creation requests per minute.
    
-   A maximum of 30 query messages to a conversation session per minute.
    

 
| API endpoint | Rate Limit (per user, per minute) |
| --- | --- |
| 
`/api/rest/2.0/ai/agent/conversation/create`

 | 

10

 |
| 

`/api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send`

 | 

30

 |
| 

`/api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send/stream`

 | 

30

 |
| 

`/api/rest/2.0/ai/agent/{conversation_identifier}/converse` Deprecated

 | 

30

 |
| 

`/api/rest/2.0/ai/agent/converse/sse` Deprecated

 | 

30

 |

If you are integrating these APIs in your environment, consider implementing a retry logic to handle the rate limit errors.

## Additional resources

-   Visit the [REST API v2.0 Playground]({{navprefix}}/restV2-playground?apiResourceId=http%2Fgetting-started%2Fintroduction) to view the API endpoints and verify the request and response workflows.
    
-   For information about embedding Spotter in your app, see [Embed Spotter]({{navprefix}}/{{embed-spotter}}).
    
-   For information about MCP server, see [MCP server integration]({{navprefix}}/{{mcp-integration}}).