Sanity Connector

Sanity Connector Overview

Sanity is considered a unified content platform that allows teams to collaborate on digital content across channels.

There are two layers to Sanity:

  • your Sanity account or database/datastore, containing your content projects and API tokens.
  • Sanity Studio: your content creation environment connected to your's datastore containing your project's content for translation.

Smartling’s Sanity Connector connects to your datastore, and automatically ingests your content into Smartling, allowing you to authorize this content for translation from within the Smartling platform. Visual Context is supported. Translations are automatically sent back to Sanity Studio once complete.

Smartling’s Sanity Connector currently ingests all assets and related assets* within the following Sanity content types:

  • Documents 

*Related assets are ingested from one-level deep, meaning a related asset within a related asset will not be ingested.

Image and video files are not yet supported content types for translation.

Sanity Asset List

Once you have connected your account to Smartling, you will find Sanity Studio content in the Sanity tab in your Smartling project.

Here you will see a flat list of your Sanity Studio Documents. 


Documents are the default, and currently only Sanity content type. You can further refine your search by filtering for a specific Document Type in Sanity Studio.

The Asset List will include the following columns:

  • Title: the document title and JSON URI in Sanity Studio.
  • Smartling Status: the asset's translation status in Smartling.
  • Sanity Document Type: the Document Type as filtered by in the Document Type filter.
  • Last Modified: is the date the asset was last modified in Sanity Studio.
  • App Link: brings you directly to the asset in Sanity Studio. The project's URL must be configured in the Smartling Sanity Connector settings.


You can sort the asset list by Sanity structure (default) or asset name (descending/ascending), created (descending/ascending), and last modified (descending/ascending).


To find a Document using the search box in the Asset List, you can search for Document title, Document ID. The Document ID can be found in the document URL in your Sanity Studio, or in the asset URI in Smartling. Search by any of the characters between the hyphens

For example, to search for the asset below using the Document ID, insert one of the following:

  • ea13f8d1
  • d956
  • 4b7d
  • ba9b
  • b4158a1b4d12


You can only search for one asset at a time; comma-separated search is not supported.

Smartling Status

Completed: Translations were successfully delivered from Smartling to Sanity Studio.

Failed: The asset submission failed, or the translation delivery failed. A number of reasons can result in a failed status, but some of the most common are due to invalid regex causing placeholder issues, or the target languages are disabled in Sanity Studio.

In Progress: The asset has been successfully sent to Smartling from Sanity Studio, and the translation process has commenced but is not yet completed. If there is a case where translations are complete, but a network issue occurs, the translations will remain in progress until the Sanity Connector delivers the translations to Sanity on a successful retry.

New: The asset is in the process of being sent for a new translation request. For example, if changes were made to the source content and your Sanity Connector is configured to automatically send the new content for translation. The asset could be sitting in submission queue or sitting in Awaiting Authorization 

Not Translated: The asset has never been submitted for translation.


Language Filter

Filter by the dropdown list of target languages configured in Smartling for the Sanity project. Target Languages must also be configured identically in Sanity and mapped in the Sanity Connector Language Configuration found in your Smartling Project Settings.


Asset Details

Click the information icon beside the asset name, to access the Asset Details page. Here you can see further information on that asset, including the translation status for each language. From here, you can also Request Translations or Export Translations for that specific asset.


Was this article helpful?