---
title: Desenvolvimento com APIs
slug: desenvolvimento-com-apis
createdAt: 2024-09-02T20:38:04.021Z
---

O Paragraph oferece uma API de "Backend como Serviço", proporcionando inúmeros benefícios para desenvolvedores de aplicações de IA. Essa abordagem permite que os desenvolvedores acessem as poderosas capacidades dos grandes modelos de linguagem (LLMs) diretamente em aplicações frontend, sem as complexidades da arquitetura de backend e dos processos de implantação.

## Benefícios de usar a API do Paragraph

- Permite que apps frontend acessem com segurança as capacidades de LLMs sem desenvolvimento de backend.
- Projete aplicações visualmente com atualizações em tempo real em todos os clientes.
- APIs LLM originais bem encapsuladas.
- Troca fácil entre provedores de LLM e gerenciamento centralizado de chaves de API.
- Operações visuais das aplicações, incluindo análise de logs, anotações e observação de atividades de usuários.
- Fornecimento contínuo de mais ferramentas, plugins e conhecimento.

## Como usar

Escolha uma aplicação e encontre o "Acesso à API" na navegação lateral esquerda da seção Apps. Nesta página, você pode visualizar a documentação da API fornecida pelo Paragraph e gerenciar as credenciais para acessar a API.

## Documentação da API

Você pode criar várias credenciais de acesso para uma aplicação e entregá-las a diferentes usuários ou desenvolvedores. Isso significa que os usuários da API podem utilizar as capacidades de IA fornecidas pelo desenvolvedor da aplicação, mas a engenharia de Prompt subjacente, conhecimento e capacidades de ferramentas estão encapsulados.

:::hint{type="warning"}
Nas melhores práticas, as chaves de API devem ser chamadas através do backend, em vez de serem diretamente expostas em texto simples no código frontend ou nas requisições. Isso ajuda a prevenir que sua aplicação seja abusada ou atacada.
:::

Por exemplo, se você for um desenvolvedor em uma empresa de consultoria, pode oferecer capacidades de IA baseadas no banco de dados privado da empresa para usuários finais ou desenvolvedores, sem expor seus dados e a lógica de design da IA. Isso garante uma entrega de serviço segura e sustentável que atende aos objetivos de negócios.

## Aplicativo de geração de texto

Essas aplicações são usadas para gerar texto de alta qualidade, como artigos, resumos, traduções, etc., chamando a API `completion-messages` e enviando a entrada do usuário para obter resultados de texto gerado. Os parâmetros do modelo e os templates de prompt usados para gerar o texto dependem das configurações do desenvolvedor na página de Arranjo de Prompt do Paragraph.

Você pode encontrar a documentação da API e exemplos de requisições para esta aplicação em Aplicações -> Acesso à API.

Por exemplo, aqui está um exemplo de chamada de uma API para geração de texto:

```bash
curl --location --request POST 'https://api.ai/v1/completion-messages' \
--header 'Authorization: Bearer SUA-CHAVE-SECRETA' \
--header 'Content-Type: application/json' \
--data-raw '{
    "inputs": {},
    "response_mode": "streaming",
    "user": "abc-123"
}'
```

## Aplicações de conversação

Adequadas para a maioria dos cenários, as aplicações de conversação envolvem diálogos contínuos com os usuários em um formato de pergunta e resposta. Para iniciar uma conversa, chame a API `chat-messages` e mantenha a sessão passando continuamente o `conversation_id` retornado.

Você pode encontrar a documentação da API e exemplos de solicitações para essa aplicação em `Applications -> Access API`.

Por exemplo, aqui está um exemplo de chamada da API para `chat-messages`:

```bash
curl --location --request POST 'https://api.ai/v1/chat-messages' \
--header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "inputs": {},
    "query": "eh",
    "response_mode": "streaming",
    "conversation_id": "1c7e55fb-1ba2-4e10-81b5-30addcea2276",
    "user": "abc-123"
}'
```