Como Trabalhar com a API Cohere

@apidog

@apidog

15 abril 2025

Como Trabalhar com a API Cohere

A Cohere oferece aos desenvolvedores acesso a sofisticados Modelos de Linguagem Grande (LLMs) capazes de entender e gerar texto semelhante ao humano. Para interagir com estes modelos de forma programática, você precisa de uma chave de API. Essa chave atua como seu identificador único e senha, permitindo que os sistemas da Cohere autentiquem suas solicitações e acompanhem seu uso.

Este guia irá orientá-lo através das etapas essenciais: obtendo sua chave de API, entendendo as diferenças críticas entre os tipos de chave (especialmente em relação a custos e limites de uso), e realizando um teste inicial simples usando a ferramenta Apidog para garantir que sua chave está funcionando corretamente.

Etapa 1: Obtendo Sua Chave de API da Cohere

Obter sua chave é o primeiro e mais crucial passo. A Cohere torna esse processo relativamente simples através do seu painel online.

  1. Navegue até o Painel da Cohere: Abra seu navegador e vá para o ponto de acesso principal da plataforma da Cohere. Você normalmente encontrará uma página de login ou cadastro.
  2. Acesse Sua Conta:

Localize a Seção de Chaves de API: Após fazer login com sucesso no painel da Cohere, procure uma seção especificamente dedicada à gestão de Chaves de API. Isso pode estar nas configurações da conta, em uma seção para desenvolvedores, ou acessível diretamente por um item de menu rotulado como "Chaves de API". A interface é projetada para ser amigável, então deve ser relativamente visível.

Inicie a Geração da Chave: Dentro da seção de Chaves de API, você encontrará uma opção para criar uma nova chave. Você provavelmente verá opções diferenciando entre tipos de chave, notavelmente "Chave de Avaliação" e potencialmente "Chave de Produção". Para testes iniciais e aprendizado, selecione a opção para gerar uma Chave de Avaliação.

Atribua um Nome: Um prompt solicitará que você nomeie sua chave. Escolha um nome descritivo que ajude você a lembrar seu propósito mais tarde, especialmente se você gerar várias chaves para diferentes projetos. Exemplos incluem "MinhaPrimeiraChaveDeTeste", "ChaveDoProjetoDeAprendizado" ou "ChaveTesteApidog".

Gere e Proteja Sua Chave: Clique no botão para confirmar e gerar a chave (por exemplo, "Gerar Chave de Avaliação"). A Cohere exibirá então sua nova chave de API gerada. Este é o único momento em que a chave completa será mostrada. É absolutamente essencial que você copie esta chave imediatamente e a armazene em um local muito seguro, como um gerenciador de senhas ou uma nota segura. Trate-a com o mesmo nível de segurança que uma senha. Não a compartilhe publicamente, não a insira diretamente em código do lado do cliente ou a faça commit em sistemas de controle de versão como Git. Uma vez que você feche a janela pop-up ou navegue para longe, não poderá recuperar a chave completa novamente por razões de segurança (embora você possa ver o nome da chave e potencialmente seus primeiros/últimos caracteres no painel). Se você perdê-la, precisará gerar uma nova.

Com sua chave de API copiada e protegida, você está pronto para entender o que pode fazer com ela e as regras associadas.

Etapa 2: Entendendo os Tipos de Chave, Custos e Limites de Uso

Nem todas as chaves de API da Cohere são criadas iguais. O tipo de chave que você tem determina quanto você pode usar a API, com que rapidez e se isso gera custos. Entender essas diferenças é vital para evitar interrupções ou cobranças inesperadas.

A. Chaves de API de Avaliação: Grátis para Avaliação

Quando você se inscreve pela primeira vez ou gera uma chave sem configurar a cobrança, normalmente você recebe uma Chave de Avaliação. Estas são projetadas para exploração, aprendizado e testes em pequena escala.

As chaves de avaliação são ideais para:

Se você constantemente atingir o limite mensal ou os limites de taxa por minuto, é um forte indicativo de que você precisa atualizar para uma chave de produção.

B. Chaves de API de Produção: Para Construir e Escalar

Quando estiver pronto para construir aplicativos com usuários reais, lidar com cargas de trabalho maiores ou ir além das limitações da avaliação, você precisará de uma Chave de Produção. Isso requer a configuração de informações de cobrança em sua conta da Cohere.

As chaves de produção são necessárias para:

C. Escolhendo a Chave Certa:

Ok, aqui está a seção revisada da Etapa 3 focando no teste da solicitação de chat em streaming fornecida no comando curl usando o Apidog, apresentada em Markdown:

Etapa 3: Realizando uma Chamada de Teste Básica da API para Chat em Streaming com Apidog

Antes de integrar a API em um código complexo, especialmente para respostas em streaming, é útil realizar um teste direto. O Apidog permite que você replique a estrutura do comando curl para verificar sua chave e entender o fluxo básico de solicitação/resposta para streaming.

  1. Inicie o Apidog: Abra o aplicativo Apidog em seu computador.
  2. Crie uma Nova Solicitação: Clique no botão '+' ou equivalente para criar uma nova solicitação de API. Nomeie algo descritivo, como "Teste de Chat em Streaming da Cohere".
  3. Configure o Endpoint:

4. Configure os Cabeçalhos:

5. Construa o Corpo da Solicitação (com Streaming Habilitado):

{
  "stream": true,
  "model": "command-r",
  "messages": [
    {
      "role": "user",
      "content": "Olá mundo!"
    }
  ]
}

(Nota: O exemplo curl usou "role": "user" (minúsculo) e modelo "command-a-03-2025". Eu mantive "role": "USER" e modelo "command-r" para consistência com os exemplos anteriores, mas você deve ajustar o modelo e a capitalização do papel no JSON acima para corresponder precisamente à solicitação específica que você pretende testar, se for diferente.)

6. Execute a Solicitação: Clique no botão "Enviar" no Apidog.

7. Analise a Resposta (Especificidades de Streaming):

Esse teste ajuda a confirmar que a API aceita sua solicitação de streaming e que sua chave é válida para esse tipo de interação, mesmo que o Apidog não seja a ferramenta ideal para visualizar a natureza em tempo real do streaming. Ele verifica se a configuração fundamental da solicitação está correta.

Conclusão

Agora você tem sua chave de API da Cohere e entende as diferenças cruciais entre chaves de Avaliação e Produção, particularmente em relação ao limite de 1.000 chamadas mensais e limites de taxa por minuto nas chaves de Avaliação versus o modelo de pagamento conforme o uso, baseado em tokens e limites mais altos das chaves de Produção. Você também realizou um teste básico, mas vital, usando o Apidog para confirmar que sua chave funciona e você pode estruturar uma chamada de API simples.

Essa base é essencial para interagir efetivamente com a API da Cohere. Lembre-se de manter sua chave segura, monitorar seu uso em relação aos limites (especialmente em uma chave de Avaliação) e consultar a documentação da Cohere para informações detalhadas sobre modelos específicos, parâmetros avançados e uso de SDK à medida que você começa a construir aplicativos mais sofisticados.

Pratique o design de API no Apidog

Descubra uma forma mais fácil de construir e usar APIs