# Crie esquemas de mensagens bem definidos e fáceis de consumir

As APIs devem responder com esquemas de mensagens fáceis de entender e consumir. Evite estruturas de dados brutos, estas devem ser limitadas apenas a dados abertos, relatórios e APIs estatísticas. Evite criar códigos de erro personalizados que exijam análise exaustiva pelo consumidor, as respostas e mensagens de erro, devem abstrair-se de detalhes técnicos dos quais o consumidor da API não tem visibilidade.


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://guias.mosaico.gov.pt/guias-praticos/boas-praticas-para-a-publicacao-de-api-a-consumir-pela-administracao-publica/crie-esquemas-de-mensagens-bem-definidos-e-faceis-de-consumir.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.