Sanity

undefined

Detail	Value
Category	CMS
Base URL	https://{project_id}.api.sanity.io/v2021-10-21
Authentication	Bearer Token
Endpoints	7
Connector key	sanity

Using Sanity in a workflow

1. Go to Connections and click New Connection.
2. Pick Sanity from the marketplace.
3. Enter your credentials (see Authentication above for what's expected).
4. In a workflow, drop an API Call node and select this connection.
5. Pick the operation you need from the Operation dropdown. The full list is below.

Available endpoints

Endpoint	Summary
GET	Query Documents (GROQ)
GET	Mutate Documents
GET	Get Document
GET	Export Dataset
GET	Upload Image
GET	Upload File
GET	List Projects

Each endpoint is documented in full below. Use the outline on the right to jump to one.

GET

Query Documents (GROQ)

Detail	Value
Operation ID	query_documents_groq__0
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Sanity connection from the Connection dropdown.
3. In the Operation dropdown, select query_documents_groq__0.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Sanity API reference.

GET

Mutate Documents

Detail	Value
Operation ID	mutate_documents_1
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Sanity connection from the Connection dropdown.
3. In the Operation dropdown, select mutate_documents_1.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Sanity API reference.

GET

Get Document

Detail	Value
Operation ID	get_document_2
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Sanity connection from the Connection dropdown.
3. In the Operation dropdown, select get_document_2.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Sanity API reference.

GET

Export Dataset

Detail	Value
Operation ID	export_dataset_3
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Sanity connection from the Connection dropdown.
3. In the Operation dropdown, select export_dataset_3.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Sanity API reference.

GET

Upload Image

Detail	Value
Operation ID	upload_image_4
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Sanity connection from the Connection dropdown.
3. In the Operation dropdown, select upload_image_4.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Sanity API reference.

GET

Upload File

Detail	Value
Operation ID	upload_file_5
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Sanity connection from the Connection dropdown.
3. In the Operation dropdown, select upload_file_5.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Sanity API reference.

GET

List Projects

Detail	Value
Operation ID	list_projects_6
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Sanity connection from the Connection dropdown.
3. In the Operation dropdown, select list_projects_6.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Sanity API reference.