Início rápido: Enterprise

Este guia orienta você a configurar o acesso à API para organizações Enterprise com funções personalizadas, RBAC e suporte a várias organizações.

Se você estiver em um plano Teams com uma única organização e não precisar de funções personalizadas, o início rápido do Teams é mais simples.

Se você for um cliente Devin Enterprise com uma implantação dedicada, será necessário substituir api.devin.ai em todas as URLs da API pelo domínio de API personalizado da sua organização (por exemplo, api.your-company.devinenterprise.com). Entre em contato com o administrador do Devin na sua organização ou com o suporte da Cognition se não tiver certeza sobre qual é o seu domínio de API.

Entendendo os escopos de usuários de serviço

Clientes Enterprise podem criar usuários de serviço em dois níveis:

Escopo	URL base	Caso de uso
Enterprise	`/v3/enterprise/*`	Gerenciamento entre organizações, análises, logs de auditoria, gerenciamento de membros
Organização	`/v3/organizations/{org_id}/*`	Sessões, Knowledge, playbooks, segredos dentro de uma única organização

Um usuário de serviço com permissões em nível Enterprise herda automaticamente as permissões correspondentes em nível de organização em todas as organizações.

Etapa 1: Crie um usuário de serviço

Usuário de serviço do Enterprise (acesso entre organizações)

Acesse Enterprise settings > Devin API e abra a aba Service users
Clique em Provision > Enterprise service user
Escolha um nome de exibição (por exemplo, “Analytics Dashboard”, “Org Provisioning Bot”)
Atribua uma função do Enterprise com as permissões necessárias para a sua integração e escolha uma data de expiração

Usuário de serviço da organização (acesso a uma única organização)

Acesse Settings > Devin API na organização de destino e abra a aba Service users
Clique em Provision service user
Escolha um nome de exibição, atribua uma função em nível de organização e defina uma data de expiração

Você também pode provisionar um usuário de serviço de organização em Enterprise settings > Devin API clicando em Provision > Organization service user e selecionando a organização de destino.

Siga o princípio do menor privilégio: crie usuários de serviço com escopo de organização quando sua integração precisar de acesso somente a uma organização. Use usuários de serviço do Enterprise apenas para fluxos de trabalho entre organizações.

Etapa 2: Copiar sua chave de API

Após provisionar o usuário de serviço, a chave de API dele é exibida em uma caixa de diálogo
Copie a chave imediatamente — ela começa com cog_ e não será exibida novamente
Armazene-a com segurança como uma variável de ambiente:

export DEVIN_API_KEY="cog_your_key_here"

Etapa 3: Faça sua primeira chamada à API

Exemplo de endpoint Enterprise

Liste todas as organizações no seu Enterprise:

curl "https://api.devin.ai/v3/enterprise/organizations" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

Exemplo de endpoint de organização

Crie uma sessão do Devin em uma organização específica:

export DEVIN_ORG_ID="your_org_id"

curl -X POST "https://api.devin.ai/v3/organizations/$DEVIN_ORG_ID/sessions" \
  -H "Authorization: Bearer $DEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt": "Implement the feature described in JIRA-123"}'

Permissões e RBAC

Cada endpoint da API é controlado por uma permissão específica. A permissão necessária é documentada na página de referência de API de cada endpoint. As permissões são divididas em dois escopos:

Permissões Enterprise — controlam os endpoints /v3/enterprise/* (por exemplo, ManageOrganizations, ManageBilling, ViewAccountMetrics)
Permissões de organização — controlam os endpoints /v3/organizations/{org_id}/* (por exemplo, UseDevinSessions, ManageOrgSecrets, ManageOrgPlaybooks)

Um usuário de serviço Enterprise com uma permissão em nível Enterprise herda automaticamente a permissão correspondente em nível de organização em todas as organizações. Por exemplo, ViewAccountSessions concede ViewOrgSessions em todas as organizações. Para a referência completa de permissões, consulte a documentação de permissões e RBAC.

Fluxos de trabalho comuns no Enterprise

Monitorar o consumo em várias organizações

# Obter detalhamento de consumo diário (usa timestamps Unix — exemplo: 1 de jan a 31 de jan de 2025)
curl "https://api.devin.ai/v3/enterprise/consumption/daily?time_after=1735689600&time_before=1738368000" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

Recuperar logs de auditoria

curl "https://api.devin.ai/v3/enterprise/audit-logs" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

Gerenciar usuários entre organizações

# Listar usuários Enterprise
curl "https://api.devin.ai/v3/enterprise/members/users" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

# Listar usuários em uma organização específica
curl "https://api.devin.ai/v3/enterprise/organizations/$DEVIN_ORG_ID/members/users" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

Próximas etapas

Consulte a referência completa de permissões da API
Saiba mais, em profundidade, sobre autenticação
Configure a paginação para conjuntos grandes de resultados
Revise o guia de migração se você estiver migrando da v1/v2

Primeiros passos

Conceitos

Ciclo de vida do agente

Gerenciamento de contexto

Gerenciamento de ambiente

Automação

Integrações

Análises

Observabilidade

Devin para Security

Infraestrutura

Identidade e acesso

Configuração

API legada v1

API legada v2

Início rápido: Enterprise

Entendendo os escopos de usuários de serviço

Etapa 1: Crie um usuário de serviço

Usuário de serviço do Enterprise (acesso entre organizações)

Usuário de serviço da organização (acesso a uma única organização)

Etapa 2: Copiar sua chave de API

Etapa 3: Faça sua primeira chamada à API

Exemplo de endpoint Enterprise

Exemplo de endpoint de organização

Permissões e RBAC

Fluxos de trabalho comuns no Enterprise

Monitorar o consumo em várias organizações

Recuperar logs de auditoria

Gerenciar usuários entre organizações

Próximas etapas

​Entendendo os escopos de usuários de serviço

​Etapa 1: Crie um usuário de serviço

​Usuário de serviço do Enterprise (acesso entre organizações)

​Usuário de serviço da organização (acesso a uma única organização)

​Etapa 2: Copiar sua chave de API

​Etapa 3: Faça sua primeira chamada à API

​Exemplo de endpoint Enterprise

​Exemplo de endpoint de organização

​Permissões e RBAC

​Fluxos de trabalho comuns no Enterprise

​Monitorar o consumo em várias organizações

​Recuperar logs de auditoria

​Gerenciar usuários entre organizações

​Próximas etapas

Entendendo os escopos de usuários de serviço

Etapa 1: Crie um usuário de serviço

Usuário de serviço do Enterprise (acesso entre organizações)

Usuário de serviço da organização (acesso a uma única organização)

Etapa 2: Copiar sua chave de API

Etapa 3: Faça sua primeira chamada à API

Exemplo de endpoint Enterprise

Exemplo de endpoint de organização

Permissões e RBAC

Fluxos de trabalho comuns no Enterprise

Monitorar o consumo em várias organizações

Recuperar logs de auditoria

Gerenciar usuários entre organizações

Próximas etapas