Sanity logosanity.ioAll Systems Operational© Sanity 2026
Change Site Theme
Sanity logo

Documentation

    • Overview
    • Platform introduction
    • Next.js quickstart
    • Nuxt.js quickstart
    • Astro quickstart
    • React Router quickstart
    • Studio quickstart
    • Build with AI
    • Content Lake
    • Functions
    • APIs and SDKs
    • Agent Actions
    • Visual Editing
    • Blueprints
    • Platform management
    • Dashboard
    • Studio
    • Canvas
    • Media Library
    • App SDK
    • Content Agent
    • HTTP API
    • CLI
    • Libraries
    • Specifications
    • Changelog
    • User guides
    • Developer guides
    • Courses and certifications
    • Join the community
    • Templates

On this page

HTTP API Reference
Overview

  • Content Lake API

    Actions
    Assets
    Copy
    Backups
    Doc
    Export
    History
    Jobs
    Listen
    Live
    Mutation
    Query
    Scheduling
    Webhooks

  • Compute and AI

    Agent Actions
    Embeddings Index

  • Apps

    Media Library

  • Management API

    Access
    Projects
    Roles

On this page

  • Authentication
Endpoints
  • Job status
  • Listen for job updates
HTTP API ReferenceLast updated January 9, 2026

Jobs API reference

Reference documentation for the Jobs HTTP endpoint.

The Jobs API allows you to monitor and manage processes running inside Sanity's infrastructure.

Authentication

  • All requests must be authenticated.

Base API server URL

Sanity API base URL

https://api.sanity.io/{apiVersion}

Variables

  • apiVersionstringdefault: "v2021-06-07"

    API version

Previous

History

Next

Listen

Endpoints

Job status

get/jobs/{jobId}

Get the status of a job.

Path parameters

  • jobIdstringrequired

Responses

200

Returns the status of the job.

  • idstring
  • statestring
  • authorsarray

    An array of authorIds

    Show child attributes
    items
    • string
  • createdAtstring
  • updatedAtstring

Listen for job updates

get/jobs/{jobId}/listen

Each job has a /listen endpoint to allow you to monitor its status programmatically. While listening, event data will be sent back at intervals providing updates on the status of your job.

Path parameters

  • jobIdstringrequired

Responses

200

Returns the status of the job.

  • string (binary)
Examplestext/event-stream
event: job
data: {"job_id":"jacsfsmnxp","state":"running","progress":60}