> ## Documentation Index
> Fetch the complete documentation index at: https://docs.replit.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Admin API

> Use a Replit Enterprise Admin API para acessar o uso da conta, workspaces, membros e projetos de forma programática.

<Note>
  A Admin API está em **beta**. Os endpoints disponíveis e o comportamento podem mudar.
</Note>

A Admin API oferece aos administradores de conta Enterprise acesso programático baseado em escopos a análises e recursos de administração da conta. Use a API para criar relatórios internos, fluxos de trabalho operacionais e integrações para sua conta Enterprise.

## Quem pode acessar a Admin API

A Admin API está disponível apenas para **administradores de conta** em contas Enterprise. Administradores de conta podem criar e gerenciar chaves de API. Administradores de workspace e outros membros da conta não podem acessar a Admin API nem criar suas chaves.

Para saber mais sobre as funções de administrador Enterprise, veja [Administradores de Conta e de Workspace](/pt/teams/identity-and-access-management/account-and-workspace-admins).

## Criar uma chave de API

<Steps>
  <Step title="Abrir as configurações de Desenvolvedor">
    Abra **Settings**. Em **Account**, selecione **Developer**.
  </Step>

  <Step title="Criar uma chave de API">
    Selecione **Create API key** e escolha acesso somente leitura ou de leitura e escrita.
  </Step>

  <Step title="Armazene sua chave com segurança">
    Copie a chave, que começa com `rpl_`, e armazene-a em um gerenciador de segredos seguro. Trate-a como uma senha e nunca a compartilhe.
  </Step>

  <Step title="Autentique sua integração">
    Envie a chave como um Bearer token nas suas requisições de API.
  </Step>
</Steps>

## O que você pode fazer

A Admin API usa escopos para controlar o que cada chave pode fazer. Seus escopos de leitura fornecem dados da conta para relatórios, enquanto escopos de escrita específicos oferecem suporte a ações como a atualização de orçamentos.

* **Uso:** Leia o uso da conta e o custo bruto no livro-razão, filtrado ou agrupado por Workspace, membro, projeto ou período.
* **Workspaces:** Leia listas e detalhes de Workspaces, incluindo contagem de membros e projetos, administradores e data de criação.
* **Membros:** Leia a associação à conta e a Workspaces, filtrada por função ou pesquisada por nome, nome de usuário ou e-mail.
* **Projetos:** Leia projetos em Team Workspaces, filtrados por visibilidade ou status de implantação, ou pesquisados por título, slug ou descrição.
* **Orçamentos:** Leia os orçamentos da conta e use o escopo `write:budgets` para atualizá-los.
* **Solicitações de aprovação:** Recupere, aprove ou negue [solicitações de acesso](/pt/teams/advanced-settings#solicitações-de-acesso). Use `write:budgets` para revisar aumentos de limite de uso, `write:deployments` para a permissão de publicação pública e `write:members` para upgrades de Viewer para Member.
* **Conformidade:** Use o escopo `compliance:messages:read` para recuperar o texto do prompt por trás dos eventos de auditoria `project.message_sent`. Veja [Recuperar Texto de Prompt com a Compliance API](/pt/teams/identity-and-access-management/audit-logs#recuperar-texto-de-prompt-com-a-compliance-api).

As respostas da API oferecem suporte a paginação por cursor e incluem cabeçalhos de limite de taxa e um `X-Request-Id` para rastreamento de requisições.

## Crie relatórios e fluxos de trabalho

Use os dados da Admin API onde você já acompanha operações, como um painel interno, um alerta no Slack ou um relatório financeiro mensal. Por exemplo, agrupe o uso por Workspace para reportar os gastos de cada Workspace.

## Construindo com o Replit Agent

Você pode pedir ao Replit Agent para construir um painel personalizado com a Admin API. Descreva os dados da conta que deseja acompanhar, como uso por workspace ou custos por projeto, e o Agent pode construir o painel e sua integração de API.

<Steps>
  <Step title="Abra o seletor de skills">
    Em um projeto Replit, clique no botão **+** ao lado da entrada de chat e selecione **Use a skill**.
  </Step>

  <Step title="Selecione a skill Admin API">
    Em **Replit skills**, selecione **Admin API** para dar ao Agent o contexto da API e orientações de integração.
  </Step>

  <Step title="Descreva o painel">
    Diga ao Agent o que você quer acompanhar e como quer visualizá-lo. Por exemplo, peça ao Agent para construir um painel que mostre uso por Workspace e custo por projeto.
  </Step>

  <Step title="Adicione sua chave de API com segurança">
    Quando o Agent precisar fazer requisições de API, adicione sua chave da Admin API aos Secrets do seu projeto. Não cole a chave no chat nem a inclua em commits do seu projeto.
  </Step>
</Steps>

## Referência da API

Para detalhes de endpoints, parâmetros de requisição e exemplos de integração, veja a [documentação para desenvolvedores da Admin API](https://api.replit.com/docs).

## Documentação relacionada

* [Configurações de Workspace](/pt/features/collaboration/workspace-settings): Defina a política Enterprise para os modelos do Agent e os provedores de modelo que cada Workspace pode usar.