How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
ThoughtSpot

ThoughtSpot Metadata API

The Metadata API from ThoughtSpot — 16 operation(s) for metadata.

Documentation Provider Profile APIs.io OpenAPI GitHub

ThoughtSpot Metadata API is one of 29 APIs that ThoughtSpot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Metadata. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.

This API exposes 16 operations across 16 paths, and defines 44 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, {base-url}.

16 operations 16 paths 44 schemas 16 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://my.thoughtspot.cloud/api/rest/2.0
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

ThoughtSpot Metadata API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 16

Across 16 paths, the API surfaces 16 operations — 16 POST. Each is listed below with its method, path, parameters, and response codes.

Metadata 16
POST
/api/rest/2.0/metadata/worksheets/convert
Convert worksheets to models Version: 10.6.0.cl or later Prerequisites - Privileges Required: - DATAMANAGEMENT (Can manage data) or ADMINISTRATION (Can administer ThoughtSpot). - Additional Privilege…
convertWorksheetToModel body → 200400401403500
POST
/api/rest/2.0/metadata/copyobject
Makes a copy of an Answer or Liveboard Version: 10.3.0.cl or later Creates a copy of a metadata object. Requires at least view access to the metadata object being copied. Upon successful execution, t…
copyObject body → 200400401403404500
POST
/api/rest/2.0/metadata/delete
Version: 9.0.0.cl or later Removes the specified metadata object from the ThoughtSpot system. Requires edit access to the metadata object. Endpoint URL
deleteMetadata body → 204400401403500
POST
/api/rest/2.0/metadata/tml/export
Version: 9.0.0.cl or later Exports the [TML](https://docs.thoughtspot.com/cloud/latest/tml) representation of metadata objects in JSON or YAML format. Requires DATADOWNLOADING (Can download Data) and…
exportMetadataTML body → 200400401403500
POST
/api/rest/2.0/metadata/tml/export/batch
Version: 10.1.0.cl or later Exports the [TML](https://docs.thoughtspot.com/cloud/latest/tml) representation of metadata objects in JSON or YAML format. Permissions Required Requires DATAMANAGEMENT (C…
exportMetadataTMLBatched body → 200400401403500
POST
/api/rest/2.0/metadata/answer/sql
Version: 9.0.0.cl or later Fetches the underlying SQL query data for an Answer object. Requires at least view access to the Answer object. Upon successful execution, the API returns the SQL queries f…
fetchAnswerSqlQuery body → 200400401403500
POST
/api/rest/2.0/metadata/tml/async/status
Version: 10.4.0.cl or later Gets information about the status of the TML async import task scheduled using the /api/rest/2.0/metadata/tml/async/import API call. To fetch the task details, specify the…
fetchAsyncImportTaskStatus body → 200400401403500
POST
/api/rest/2.0/metadata/liveboard/sql
Version: 9.0.0.cl or later Fetches the underlying SQL query data for a Liveboard object and its visualizations. Requires at least view access to the Liveboard object. To get SQL query data for a Live…
fetchLiveboardSqlQuery body → 200400401403500
POST
/api/rest/2.0/metadata/tml/import
Version: 9.0.0.cl or later Imports [TML](https://docs.thoughtspot.com/cloud/latest/tml) files into ThoughtSpot. Requires DATAMANAGEMENT (Can manage data) or ADMINISTRATION (Can administer ThoughtsSpo…
importMetadataTML body → 200400401403500
POST
/api/rest/2.0/metadata/tml/async/import
Version: 10.4.0.cl or later Schedules a task to import [TML](https://docs.thoughtspot.com/cloud/latest/tml) files into ThoughtSpot. You can use this API endpoint to process TML objects asynchronously…
importMetadataTMLAsync body → 200400401403500
POST
/api/rest/2.0/metadata/parameterizedeprecated
Parameterize fields in metadata objects. Beta Version: 10.9.0.cl or later Note: This API endpoint is deprecated and will be removed from ThoughtSpot in a future release. Use [POST /api/rest/2.0/metad…
parameterizeMetadata body → 204400401403500
POST
/api/rest/2.0/metadata/parameterize-fields
Parameterize multiple fields of metadata objects. For example [schemaName, databaseName] for LOGICALTABLE. Version: 26.5.0.cl or later Allows parameterizing multiple fields of metadata objects in Tho…
parameterizeMetadataFields body → 204400401403500
POST
/api/rest/2.0/metadata/search
Version: 9.0.0.cl or later Gets a list of metadata objects available on the ThoughtSpot system. This API endpoint is available to all users who have view access to the object. Users with ADMINISTRATI…
searchMetadata body → 200400401403500
POST
/api/rest/2.0/metadata/unparameterize
Remove parameterization from fields in metadata objects. Version: 26.5.0.cl or later Allows removing parameterization from fields in metadata objects in ThoughtSpot. Requires appropriate permissions…
unparameterizeMetadata body → 204400401403500
POST
/api/rest/2.0/metadata/headers/update
Update header attributes for a given list of header objects. Beta Version: 10.6.0.cl or later Prerequisites - Privileges Required: - DATAMANAGEMENT (Can manage data) or ADMINISTRATION (Can administer…
updateMetadataHeader body → 204400401403500
POST
/api/rest/2.0/metadata/update-obj-id
Update object IDs for given metadata objects. Beta Version: 10.8.0.cl or later Prerequisites - Privileges Required: - DATAMANAGEMENT (Can manage data) or ADMINISTRATION (Can administer ThoughtSpot).…
updateMetadataObjId body → 204400401403500

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are SearchMetadataRequest (26 properties), ImportEPackAsyncTaskStatus (15 properties), MetadataSearchResponse (10 properties), ResponseWorksheetToModelConversion (10 properties). Each schema is shown below with its type and property counts.

ResponsePostUpgradeFailedEntity
object
Unique ID of the worksheet that failed post-upgrade.
3 properties 3 required
PermissionInput
object
Details of users or groups.
2 properties 2 required
FetchLiveboardSqlQueryRequest
object
2 properties 1 required
UpdateMetadataObjIdRequest
object
1 property 1 required
ImportMetadataTMLRequest
object
7 properties 1 required
SqlQueryResponse
object
4 properties 4 required
ResponseIncompleteEntities
object
Wrapper for the incomplete entities, as they are inside a 'data' field in the response.
1 property 1 required
ExportMetadataTMLRequest
object
9 properties 1 required
ConvertWorksheetToModelRequest
object
4 properties
ImportMetadataTMLAsyncRequest
object
7 properties 1 required
ResponseFailedEntities
object
Wrapper for the failed entities, as they are inside a 'data' field in the response.
1 property 1 required
Export_Options
object
Flags to specify additional options for export. This will only be active when UserDefinedId in TML is enabled.
6 properties
FetchAsyncImportTaskStatusRequest
object
6 properties
SearchMetadataRequest
object
26 properties
MetadataSearchResponse
object
Metadata Search Response Object.
10 properties 1 required
ParameterizeMetadataRequest
object
5 properties 4 required
GetAsyncImportStatusResponse
object
2 properties
ParameterizeMetadataFieldsRequest
object
5 properties 4 required
UnparameterizeMetadataRequest
object
5 properties 4 required
CopyObjectRequest
object
4 properties 1 required
MetadataListItemInput
object
5 properties
ResponseFailedEntity
object
Unique ID of the failed worksheet.
3 properties 3 required
ResponseWorksheetToModelConversion
object
Name of the conversion process, which involves converting worksheets to models.
10 properties 10 required
ExcludeMetadataListItemInput
object
2 properties 2 required
UpdateObjIdInput
object
Input for updating object ID of a metadata object.
4 properties 1 required
MetadataSearchSortOptions
object
Sort options.
2 properties
SqlQuery
object
Response format associated with fetch SQL query api
3 properties 3 required
ResponseIncompleteEntity
object
Unique ID of the incomplete worksheet.
3 properties 3 required
HeaderUpdateInput
object
Favorite object options.
4 properties 1 required
PrincipalsInput
object
2 properties 1 required
ResponsePostUpgradeFailedEntities
object
Wrapper for the post-upgrade failed entities, as they are inside a 'data' field in the response.
1 property 1 required
DeleteMetadataTypeInput
object
MetadataType InputType used in Delete MetadataType API
2 properties 1 required
ErrorResponse
object
1 property
ExportMetadataTypeInput
object
MetadataType InputType used in Export MetadataType API
4 properties
ResponseSuccessfulEntity
object
Unique ID of the worksheet.
2 properties 2 required
ResponseSuccessfulEntities
object
Wrapper for the successful entities, as they are inside a 'data' field in the response.
1 property 1 required
HeaderAttributeInput
object
Attribute to update in a header.
2 properties 2 required
DeleteMetadataRequest
object
2 properties 1 required
ImportEPackAsyncTaskStatus
object
15 properties
FavoriteObjectOptionsInput
object
Favorite object options.
2 properties
UpdateMetadataHeaderRequest
object
2 properties 1 required
FetchAnswerSqlQueryRequest
object
1 property 1 required
ResponseCopyObject
object
1 property
ExportMetadataTMLBatchedRequest
object
6 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thoughtspot-metadata-api-openapi.yml Raw ↑

Other APIs ThoughtSpot publishes across the network.

ThoughtSpot AI API
AE Profile APIs.io
ThoughtSpot Authentication API
AE Profile APIs.io
ThoughtSpot Collections API
AE Profile APIs.io
ThoughtSpot Connection Configurations API
AE Profile APIs.io
ThoughtSpot Connections API
AE Profile APIs.io
ThoughtSpot Custom Action API
AE Profile APIs.io
ThoughtSpot Custom Calendars API
AE Profile APIs.io
ThoughtSpot Data API
AE Profile APIs.io
ThoughtSpot DBT API
AE Profile APIs.io
ThoughtSpot Email Customization API
AE Profile APIs.io
ThoughtSpot Groups API
AE Profile APIs.io
ThoughtSpot Input Tables API
AE Profile APIs.io
#Metadata
← Back to T APIs
API Details
ID
thoughtspot:thoughtspot-metadata-api
Base URL
https://my.thoughtspot.cloud/api/rest/2.0
Docs
https://developers.thoughtspot.com/docs/rest-apiv2-reference
Provider
ThoughtSpot
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=thoughtspot-metadata-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/thoughtspot-metadata-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of ThoughtSpot Metadata API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.