> For the complete documentation index, see [llms.txt](https://docs.airops.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.airops.com/docs/pt/integracoes/overview/integrations/sanity.md).

# Sanity

A integração com Sanity permite listar, criar, atualizar e consultar conteúdo no seu site Sanity.io.

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-a83f5e32ccae943e7ee425b6b518a607d6bbfd0a%2Fsanity-step-01-list-resources.png?alt=media" alt="Sanity Integration step set to List Resources for the spaceops-site project, the production dataset, and the post resource type"><figcaption><p>Exemplo de listagem de etapas de recursos do Sanity.</p></figcaption></figure>

## Autenticação

1. **Gerar uma chave de API**
   1. Aceda ao painel do seu projeto em Sanity.io
   2. Aceda ao separador API
   3. Clique no botão "Adicionar token de API"
   4. Defina um nome para o seu token (por exemplo, "AirOps")
   5. Defina as permissões como "Editor"
   6. Clique em "Guardar"
   7. Copie o token gerado
2. **Adicione a Chave da API ao AirOps**
   1. Vá para a página AirOps > Definições > Integrações
   2. Clique em "Adicionar novo" e selecione Sanity
   3. Cole o token gerado no campo Chave da API
   4. Clique em "Guardar"

**Nota de segurança:** Trate a sua Chave da API como uma palavra-passe. Ela fornece acesso à API REST à sua instância do Sanity e não deve ser partilhada. Guarde-a em segurança e utilize-a apenas em ambientes do lado do servidor ou em ambientes seguros/autenticados.

## Funções e os seus parâmetros <a href="#user-content-functions-and-their-parameters" id="user-content-functions-and-their-parameters"></a>

#### Parâmetros de configuração comuns

1. **ID do projeto**: O ID do seu projeto Sanity. (por exemplo, "w22x3y4z")
2. **Conjunto de dados**: O conjunto de dados que pretende usar. (por exemplo, "production")

### **Listar recursos**

Obtém uma lista de recursos do seu projeto Sanity. Isto é útil para recuperar publicações, imagens ou outros tipos de conteúdo existentes. Retorna 100 registos por página.

1. **Tipo de recurso**: O tipo de recurso que pretende listar. (por exemplo, "post")
2. **Último ID**: Para usar a paginação, pode definir o último ID do pedido anterior. (Opcional)
3. **Incluir rascunhos?**: Se deve incluir rascunhos nos resultados. (Opcional)

### **Obter recurso**

Obtém um único recurso do seu projeto Sanity. Isto é útil para recuperar informação detalhada sobre uma publicação ou imagem específica.

A matriz de blocos será devolvida tal como está, mas será devolvida uma estrutura de dados complementar com os atributos dos blocos convertidos para HTML simples dentro do `__airops.html` caminho JSON.

1. **ID do recurso**: O ID do recurso que pretende obter. (por exemplo, "4ddb0459-2734-4611-b1af-4ee13f3d5630")

### **Criar recurso**

Cria um novo recurso no seu projeto Sanity. Isto é útil para adicionar novas publicações, imagens ou outros tipos de conteúdo.

1. **JSON do recurso**: O objeto JSON que representa o recurso que pretende criar.
   * Por exemplo: `{ "title": "A Minha Nova Publicação", "category": "blog" }`
   * Quando usado em conjunto com a entrada HTML do recurso, os atributos HTML serão ignorados nesta entrada.
   * Veja <https://www.sanity.io/docs/js-client#creating-documents>.
2. **HTML do recurso**: Um objeto JSON que contém o nome do atributo do recurso como chave e o documento HTML como valor. (Opcional)
   * Por exemplo: `{ "body": "<h1>A Minha Nova Publicação</h1><p>Este é o conteúdo da minha nova publicação.</p>" }`
   * Isto é útil para criar publicações com conteúdo de texto rico.
   * O HTML será convertido para a estrutura Portable Text do Sanity e usado no payload para criar o recurso. Envie tantos atributos HTML quantos forem necessários.

### **Atualizar recurso**

Atualiza um recurso existente no seu projeto Sanity.

1. **ID do recurso**: O ID do recurso que pretende atualizar. (por exemplo, "4ddb0459-2734-4611-b1af-4ee13f3d5630")
2. **JSON do recurso**: O objeto JSON que representa o recurso que pretende atualizar.
   * Por exemplo: `{ "title": "A Minha Publicação Atualizada", "category": "blog" }`
   * Quando usado em conjunto com a entrada HTML do recurso, os atributos HTML serão ignorados nesta entrada.
   * Veja <https://www.sanity.io/docs/js-client#patchupdate-a-document>.
3. **HTML do recurso**: Um objeto JSON que contém o nome do atributo do recurso como chave e o documento HTML como valor. (Opcional)
   * Por exemplo: `{ "body": "<h1>A Minha Nova Publicação</h1><p>Este é o conteúdo da minha nova publicação.</p>" }`
   * Isto é útil para criar publicações com conteúdo de texto rico.
   * O HTML será convertido para a estrutura Portable Text do Sanity e usado no payload para criar o recurso. Envie tantos atributos HTML quantos forem necessários.

### **Carregar imagem**

Carrega uma imagem para o seu projeto Sanity. Isto é útil para adicionar imagens ao seu conteúdo ou biblioteca multimédia.

1. **URL da imagem**: O URL da imagem que pretende carregar para o Sanity. (por exemplo, "<https://example.com/image.jpg>")

### **Publicar recurso**

Publica um recurso em rascunho no seu projeto Sanity, tornando-o ativo e visível para a sua audiência.

1. **ID do recurso**: O ID do recurso em rascunho que pretende publicar. (por exemplo, "drafts.4ddb0459-2734-4611-b1af-4ee13f3d5630")

### **Executar consulta**

Executa uma consulta arbitrária [GROQ](https://www.sanity.io/docs/groq) ao seu projeto Sanity. Isto é útil para obter dados com filtragem, ordenação ou projeções personalizadas que vão além da ação integrada Listar recursos.

1. **Consulta**: A consulta GROQ a executar no seu conjunto de dados. (por exemplo, `*[_type == "post" && status == "published"] | order(publishedAt desc) { _id, title, slug, publishedAt }`)
2. **Parâmetros da consulta**: Um objeto JSON de parâmetros nomeados a passar para a consulta. (Opcional)
   * Por exemplo: `{ "status": "published" }` pode ser usado com uma consulta como `*[_type == "post" && status == $status]`
   * Veja <https://www.sanity.io/docs/query-cheat-sheet> para referência da sintaxe GROQ.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.airops.com/docs/pt/integracoes/overview/integrations/sanity.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
