How to Query a Public API Endpoint and Pull Metadata into a Document

2 replies
Last updated: Apr 19, 2022
Learning Sanity - going through the docs. I’m looking to build a new CMS for my company strictly to enable marketing teams. Is it possible to query a public API endpoint and pull in metadata into a document? Example; lets say our writers will be writing about SKU #11; i’d like to query our product API and pull in the metadata (name, price, launch date, faculty name, etc) and be able to use those variables inside the content - or pre-render them as default values. Is this possible?
Apr 18, 2022, 6:07 PM
user Y
That would be awesome. Glad to hear it might be possible. Going to continue to dig into things.
Apr 18, 2022, 6:36 PM
As some more follow up
user B
, you would more or less want to hit the endpoint with the data you are looking for, then iterate over the data and then queue up your changes. Then you would define your document fields inside of an object called
, then use the client to write those changes.

Here is an example of a script that one of my colleagues Racheal put together that although isn’t directly using an external API it is similar in process using the
API to fetch info, iterate over it then create documents from that info. This should at least give you a working example of what you are asking for:

import { studioClient } from "./studioClient"
import cq from 'concurrent-queue'
import userStore from 'part:@sanity/base/user'

// Create a queue to limit the rate at which you write changes to Sanity
let queue = cq().limit({ concurrency: 2 }).process(function (task) {
  return new Promise(function (resolve, reject) {
      setTimeout(resolve.bind(undefined, task), 1000)

const createUserDocuments = async () => {
  const allUsers = await studioClient
    .fetch(`*[_id in path('_.groups.*')].members[@ != 'everyone']`)
    .then(res => userStore.getUsers(res))
    .then(users => users.filter(user => user.isCurrentUser))

    for (const user of allUsers){
      const doc = {
        _type: 'person',
        name: user.displayName,
        //other fields you have in your schema
      queue(doc).then(async () => {
        //create the doc via the client
          .then(updatedDoc => {
            console.log(`Hurray, the doc is updated! New document:${updatedDoc._id}`)
          .catch((err) => {
            console.error('Oh no, the update failed: ', err.message)


// execute this script by running 
// $ sanity exec ./path-to-your-script --withUserToken --mock-browser-env

here is a link in our docs to some additional information around creating documents (although vaguely related it is not exactly what you are asking for, it is very helpful for getting a better grasp of how creating documents works and different use cases). with these docs and the examples provided that should get you where you need to go.
Apr 19, 2022, 6:44 PM – build remarkable experiences at scale

Sanity is a customizable solution that treats content as data to power your digital business. Free to get started, and pay-as-you-go on all plans.