Agent Actions: AI building blocks for structured content

const favoritePizza = "Detroit Style";

await client.agent.action.generate({
  schemaId: "your-schema-id",
  targetDocument: { operation: "create", _type: "menuItem" },
  instruction: "Write a description for a $pizzaType pizza.",
  instructionParams: {
    pizzaType: { 
      type: "constant", 
      value: favoritePizza 
    }
  }
});

await client.agent.action.transform({
  schemaId: "your-schema-id",
  documentId: "pizza-123",
  instruction: "Rewrite this menu item to cater toward $audience.",
  instructionParams: {
    audience: 'An Italian pizza connoisseur'
  }
});

await client.agent.action.translate({
  schemaId: "your-schema-id",
  documentId: "pizza-123",
  targetDocument: { operation: "create" },
  fromLanguage: { id: "en-US", title: "English" },
  toLanguage: { id: "it-IT", title: "Italian" },
  styleGuide: "Translate with passion like an Italian pizzaiolo.",
  protectedPhrases: ["Margherita", "Napoletana", "Quattro Formaggi"],
});

sanity schema list

# Deploy just the schema
sanity schema deploy

# Or deploy your entire studio
sanity deploy

import { createClient } from "@sanity/client";

const client = createClient({
  projectId: "your-project-id",
  dataset: "your-dataset",
  apiVersion: "vX", // At the moment "vX" API version is required for Agent Actions, but this is just temporary until out of beta 
  token: "your-token"
});

await client.agent.action.generate({
  schemaId: "your-schema-id",
  targetDocument: { 
    operation: "create", 
    _type: "post"
  },
  instruction: "Write a blog post about $pizzaTopic with a catchy title and pizza metaphors.",
  instructionParams: {
    pizzaTopic: { 
      type: "constant", 
      value: "The History of Pizza" 
    }
  }
});

await client.agent.action.transform({
  schemaId: "your-schema-id",
  documentId: "pizza-post-123",
  instruction: "Replace 'New York style' with 'Detroit style'.",
  target: [
    path: ['title', 'body']
  ]
});

await client.agent.action.translate({
  schemaId: "your-schema-id",
  documentId: "pizza-post-123",
  targetDocument: { operation: "create" },
  fromLanguage: { id: "en-US", title: "English" },
  toLanguage: { id: "it-IT", title: "Italian" },
  styleGuide: "Translate with passion like an Italian pizzaiolo.",
  protectedPhrases: ["Margherita", "Napoletana", "Quattro Formaggi"],
});

// For each product without a description
const products = await client.fetch(`*[_type == "product" && !defined(description)]._id`);

for (const productId of products) {
  await client.agent.action.generate({
    schemaId: "your-schema-id",
    documentId: productId,
    instruction: `
      Write a compelling product description based on $product.
      Highlight key features and benefits in a persuasive way.
    `,
    instructionParams: {
      product: {
        type: "document",
        documentId: productId
      }
    },
    target: {
      path: "description"
    }
  });
}

// In a Sanity Function triggered on publish
export const handler = async ({ context, event }) => {
  // Only translate posts
  if (event.data._type !== 'post') return;

  // Create translations for multiple languages
  const languages = [
    { id: 'es-ES', title: 'Spanish' },
    { id: 'fr-FR', title: 'French' },
    { id: 'de-DE', title: 'German' }
  ];

  for (const language of languages) {
    await client.agent.action.translate({
      schemaId: "your-schema-id",
      documentId: event.data._id,
      targetDocument: { operation: "create" },
      fromLanguage: { id: "en-US", title: "English" },
      toLanguage: language,
      styleGuide: "Preserve tone and technical accuracy."
    });
  }
};

// GenerateButton.tsx
import {Button, Stack, TextArea, Text} from '@sanity/ui'
import {useClient, StringInputProps, useFormValue} from 'sanity'

export const GenerateButton = (props: StringInputProps) => {
  const {value = '', elementProps} = props
  const id = useFormValue(['_id']) as string // Access document values
  const client = useClient({apiVersion: 'vX'}).withConfig({useCdn: false})

  const handleGenerate = async (event: React.MouseEvent<HTMLButtonElement>) => {
    try {
      await client.agent.action.generate({
        schemaId: '_.schemas.default',
        documentId: id,
        instruction: 'Suggest improvements to the "overview" to make it more engaging.',
        target: {
          path: 'aiSuggestions',
        },
        conditionalPaths: {
          defaultReadOnly: false,
        },
      })
    } catch {
      console.log('Error running action')
    }
  }

  return (
    <Stack space={3}>
      <TextArea rows={7} {...elementProps} value={typeof value === 'string' ? value : ''} />
      <Button onClick={handleGenerate} text={'Get AI Suggestions'} />
    </Stack>
  )
}

// movie.schema.ts

// ... Other fields
defineField({
  name: 'overview',
  title: 'Overview',
  type: 'blockContent',
  group: 'main',
}),
defineField({
  name: 'aiSuggestions',
  title: 'AI Suggestions',
  type: 'text',
  group: 'main',
  components: {
    input: GenerateButton,
  },
  readOnly: () => true,
}),