Cursor – API de Administração

A API de Administração permite que você acesse programaticamente os dados da sua equipe, incluindo informações de membros, métricas de uso e detalhes de gastos. Construa dashboards personalizados, ferramentas de monitoramento ou integre com fluxos de trabalho existentes.

A API está em sua primeira versão. Estamos expandindo as capacidades com base no feedback - nos informe quais endpoints você precisa!

Autenticação

Todas as requisições da API requerem autenticação usando uma chave de API. Apenas administradores da equipe podem criar e gerenciar chaves de API. As chaves de API estão vinculadas à organização, são visíveis por todos os administradores e não são afetadas pelo status da conta do criador original.

Criando uma Chave de API

Navegue para cursor.com/dashboard → aba Settings → Cursor Admin API Keys
Clique em Create New API Key
Dê um nome descritivo para sua chave (ex: “Integração do Dashboard de Uso”)
Copie a chave gerada imediatamente - você não a verá novamente

Formato: key_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Usando Sua Chave de API

Use sua chave de API como nome de usuário na autenticação básica: Usando curl com autenticação básica:

curl https://api.cursor.com/{route} -u API_KEY:

Ou defina o cabeçalho Authorization diretamente:

Authorization: Basic {base64_encode('API_KEY:')}

URL Base

Todos os endpoints da API usam:

https://api.cursor.com

Endpoints

Obter Membros da Equipe

Recupera todos os membros da equipe e seus detalhes.

GET /teams/members

Resposta

Retorna um array de objetos de membros da equipe:

{
  teamMembers: {
    name: string;
    email: string;
    role: 'owner' | 'member' | 'free-owner';
  }[];
}

Exemplo de Resposta

{
  "teamMembers": [
    {
      "name": "Alex",
      "email": "developer@company.com",
      "role": "member"
    },
    {
      "name": "Sam",
      "email": "admin@company.com",
      "role": "owner"
    }
  ]
}

Exemplo de Requisição

curl -X GET https://api.cursor.com/teams/members \
  -u YOUR_API_KEY:

Obter Dados de Uso Diário

Recupera métricas detalhadas de uso diário para sua equipe dentro de um intervalo de datas. Fornece insights sobre edições de código, uso de assistência de IA e taxas de aceitação.

POST /teams/daily-usage-data

Corpo da Requisição

Parâmetro	Tipo	Obrigatório	Descrição
`startDate`	number	Sim	Data de início em milissegundos epoch
`endDate`	number	Sim	Data de fim em milissegundos epoch

O intervalo de datas não pode exceder 90 dias. Faça múltiplas requisições para períodos mais longos.

Resposta

{
  data: {
    date: number;
    isActive: boolean;
    totalLinesAdded: number;
    totalLinesDeleted: number;
    acceptedLinesAdded: number;
    acceptedLinesDeleted: number;
    totalApplies: number;
    totalAccepts: number;
    totalRejects: number;
    totalTabsShown: number;
    totalTabsAccepted: number;
    composerRequests: number;
    chatRequests: number;
    agentRequests: number;
    cmdkUsages: number;
    subscriptionIncludedReqs: number;
    apiKeyReqs: number;
    usageBasedReqs: number;
    bugbotUsages: number;
    mostUsedModel: string;
    applyMostUsedExtension?: string;
    tabMostUsedExtension?: string;
    clientVersion?: string;
    email?: string;
  }[];
  period: {
    startDate: number;
    endDate: number;
  };
}

Campos da Resposta

Campo	Descrição
`date`	Data em milissegundos epoch
`isActive`	Usuário ativo neste dia
`totalLinesAdded`	Linhas de código adicionadas
`totalLinesDeleted`	Linhas de código deletadas
`acceptedLinesAdded`	Linhas adicionadas de sugestões de IA aceitas
`acceptedLinesDeleted`	Linhas deletadas de sugestões de IA aceitas
`totalApplies`	Operações de aplicação
`totalAccepts`	Sugestões aceitas
`totalRejects`	Sugestões rejeitadas
`totalTabsShown`	Completações de tab mostradas
`totalTabsAccepted`	Completações de tab aceitas
`composerRequests`	Requisições do Composer
`chatRequests`	Requisições de chat
`agentRequests`	Requisições de agente
`cmdkUsages`	Usos da paleta de comandos (Cmd+K)
`subscriptionIncludedReqs`	Requisições da assinatura
`apiKeyReqs`	Requisições de chave API
`usageBasedReqs`	Requisições de pagamento por uso
`bugbotUsages`	Usos de detecção de bugs
`mostUsedModel`	Modelo de IA mais frequente
`applyMostUsedExtension`	Extensão de arquivo mais usada para aplicações
`tabMostUsedExtension`	Extensão de arquivo mais usada para tabs
`clientVersion`	Versão do Cursor
`email`	Email do usuário

Exemplo de Resposta

{
  "data": [
    {
      "date": 1710720000000,
      "isActive": true,
      "totalLinesAdded": 1543,
      "totalLinesDeleted": 892,
      "acceptedLinesAdded": 1102,
      "acceptedLinesDeleted": 645,
      "totalApplies": 87,
      "totalAccepts": 73,
      "totalRejects": 14,
      "totalTabsShown": 342,
      "totalTabsAccepted": 289,
      "composerRequests": 45,
      "chatRequests": 128,
      "agentRequests": 12,
      "cmdkUsages": 67,
      "subscriptionIncludedReqs": 180,
      "apiKeyReqs": 0,
      "usageBasedReqs": 5,
      "bugbotUsages": 3,
      "mostUsedModel": "gpt-4",
      "applyMostUsedExtension": ".tsx",
      "tabMostUsedExtension": ".ts",
      "clientVersion": "0.25.1",
      "email": "developer@company.com"
    },
    {
      "date": 1710806400000,
      "isActive": true,
      "totalLinesAdded": 2104,
      "totalLinesDeleted": 1203,
      "acceptedLinesAdded": 1876,
      "acceptedLinesDeleted": 987,
      "totalApplies": 102,
      "totalAccepts": 91,
      "totalRejects": 11,
      "totalTabsShown": 456,
      "totalTabsAccepted": 398,
      "composerRequests": 67,
      "chatRequests": 156,
      "agentRequests": 23,
      "cmdkUsages": 89,
      "subscriptionIncludedReqs": 320,
      "apiKeyReqs": 15,
      "usageBasedReqs": 0,
      "bugbotUsages": 5,
      "mostUsedModel": "claude-3-opus",
      "applyMostUsedExtension": ".py",
      "tabMostUsedExtension": ".py",
      "clientVersion": "0.25.1",
      "email": "developer@company.com"
    }
  ],
  "period": {
    "startDate": 1710720000000,
    "endDate": 1710892800000
  }
}

Exemplo de Requisição

curl -X POST https://api.cursor.com/teams/daily-usage-data \
  -u YOUR_API_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "startDate": 1710720000000,
    "endDate": 1710892800000
  }'

Obter Dados de Gastos

Recupere informações de gastos para o mês calendário atual com busca, ordenação e paginação.

POST /teams/spend

Corpo da Requisição

Parâmetro	Tipo	Obrigatório	Descrição
`searchTerm`	string	Não	Buscar em nomes de usuários e emails
`sortBy`	string	Não	Ordenar por: `amount`, `date`, `user`. Padrão: `date`
`sortDirection`	string	Não	Direção da ordenação: `asc`, `desc`. Padrão: `desc`
`page`	number	Não	Número da página (indexada em 1). Padrão: `1`
`pageSize`	number	Não	Resultados por página

Resposta

{
  teamMemberSpend: {
    spendCents: number;
    fastPremiumRequests: number;
    name: string;
    email: string;
    role: 'owner' | 'member' | 'free-owner';
    hardLimitOverrideDollars: number;
  }[];
  subscriptionCycleStart: number;
  totalMembers: number;
  totalPages: number;
}

Campos da Resposta

Campo	Descrição
`spendCents`	Gasto total em centavos
`fastPremiumRequests`	Requisições de modelo premium rápido
`name`	Nome do membro
`email`	Email do membro
`role`	Função na equipe
`hardLimitOverrideDollars`	Substituição de limite de gastos personalizado
`subscriptionCycleStart`	Início do ciclo de assinatura (milissegundos epoch)
`totalMembers`	Total de membros da equipe
`totalPages`	Total de páginas

Exemplo de Resposta

{
  "teamMemberSpend": [
    {
      "spendCents": 2450,
      "fastPremiumRequests": 1250,
      "name": "Alex",
      "email": "developer@company.com",
      "role": "member",
      "hardLimitOverrideDollars": 100
    },
    {
      "spendCents": 1875,
      "fastPremiumRequests": 980,
      "name": "Sam",
      "email": "admin@company.com",
      "role": "owner",
      "hardLimitOverrideDollars": 0
    },
  ],
  "subscriptionCycleStart": 1708992000000,
  "totalMembers": 15,
  "totalPages": 1
}

Exemplos de Requisições

Dados básicos de gastos:

curl -X POST https://api.cursor.com/teams/spend \
  -u YOUR_API_KEY: \
  -H "Content-Type: application/json" \
  -d '{}'

Buscar usuário específico com paginação:

curl -X POST https://api.cursor.com/teams/spend \
  -u YOUR_API_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "searchTerm": "alex@company.com",
    "page": 2,
    "pageSize": 25
  }'

Obter Dados de Eventos de Uso

Recupere eventos de uso detalhados para sua equipe com opções abrangentes de filtragem, busca e paginação. Este endpoint fornece insights granulares sobre chamadas individuais da API, uso de modelos, consumo de tokens e custos.

POST /teams/filtered-usage-events

Corpo da Requisição

Parâmetro	Tipo	Obrigatório	Descrição
`startDate`	number	Não	Data de início em milissegundos epoch
`endDate`	number	Não	Data de fim em milissegundos epoch
`userId`	number	Não	Filtrar por ID de usuário específico
`page`	number	Não	Número da página (indexada em 1). Padrão: `1`
`pageSize`	number	Não	Número de resultados por página. Padrão: `10`
`email`	string	Não	Filtrar por endereço de email do usuário

Resposta

{
  totalUsageEventsCount: number;
  pagination: {
    numPages: number;
    currentPage: number;
    pageSize: number;
    hasNextPage: boolean;
    hasPreviousPage: boolean;
  };
  usageEvents: {
    timestamp: string;
    model: string;
    kindLabel: string;
    maxMode: boolean;
    requestsCosts: number;
    isTokenBasedCall: boolean;
    tokenUsage?: {
      inputTokens: number;
      outputTokens: number;
      cacheWriteTokens: number;
      cacheReadTokens: number;
      totalCents: number;
    };
    isFreeBugbot: boolean;
    userEmail: string;
  }[];
  period: {
    startDate: number;
    endDate: number;
  };
}

Campos da Resposta Explicados

Campo	Descrição
`totalUsageEventsCount`	Número total de eventos de uso que correspondem à consulta
`pagination`	Metadados de paginação para navegar pelos resultados
`timestamp`	Timestamp do evento em milissegundos epoch
`model`	Modelo de IA usado para a requisição
`kindLabel`	Categoria de uso (ex: “Usage-based”, “Included in Business”)
`maxMode`	Se o modo máximo estava habilitado
`requestsCosts`	Custo em unidades de requisição
`isTokenBasedCall`	Verdadeiro quando o evento é cobrado como um evento baseado em uso
`tokenUsage`	Consumo detalhado de tokens (disponível quando isTokenBasedCall é verdadeiro)
`isFreeBugbot`	Se este foi um uso gratuito do bugbot
`userEmail`	Email do usuário que fez a requisição
`period`	Intervalo de datas dos dados consultados

Exemplo de Resposta

{
  "totalUsageEventsCount": 113,
  "pagination": {
    "numPages": 12,
    "currentPage": 1,
    "pageSize": 10,
    "hasNextPage": true,
    "hasPreviousPage": false
  },
  "usageEvents": [
    {
      "timestamp": "1750979225854",
      "model": "claude-4-opus",
      "kindLabel": "Usage-based",
      "maxMode": true,
      "requestsCosts": 5,
      "isTokenBasedCall": true,
      "tokenUsage": {
        "inputTokens": 126,
        "outputTokens": 450,
        "cacheWriteTokens": 6112,
        "cacheReadTokens": 11964,
        "totalCents": 20.18232
      },
      "isFreeBugbot": false,
      "userEmail": "developer@company.com"
    },
    {
      "timestamp": "1750979173824",
      "model": "claude-4-opus",
      "kindLabel": "Usage-based",
      "maxMode": true,
      "requestsCosts": 10,
      "isTokenBasedCall": true,
      "tokenUsage": {
        "inputTokens": 5805,
        "outputTokens": 311,
        "cacheWriteTokens": 11964,
        "cacheReadTokens": 0,
        "totalCents": 40.16699999999999
      },
      "isFreeBugbot": false,
      "userEmail": "developer@company.com"
    },
    {
      "timestamp": "1750978339901",
      "model": "claude-4-sonnet-thinking",
      "kindLabel": "Included in Business",
      "maxMode": true,
      "requestsCosts": 1.4,
      "isTokenBasedCall": false,
      "isFreeBugbot": false,
      "userEmail": "admin@company.com"
    }
  ],
  "period": {
    "startDate": 1748411762359,
    "endDate": 1751003762359
  }
}

Exemplos de Requisições

Obter todos os eventos de uso com paginação padrão:

curl -X POST https://api.cursor.com/teams/filtered-usage-events \
  -u YOUR_API_KEY: \
  -H "Content-Type: application/json" \
  -d '{}'

Filtrar por intervalo de datas e usuário específico:

curl -X POST https://api.cursor.com/teams/filtered-usage-events \
  -u YOUR_API_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "startDate": 1748411762359,
    "endDate": 1751003762359,
    "email": "developer@company.com",
    "page": 1,
    "pageSize": 25
  }'

Obter eventos de uso para um usuário específico com paginação personalizada:

curl -X POST https://api.cursor.com/teams/filtered-usage-events \
  -u YOUR_API_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "userId": 12345,
    "page": 2,
    "pageSize": 50
  }'

API de Listas de Bloqueio de Repositórios

Adicione repositórios e use padrões para impedir que arquivos ou diretórios sejam indexados ou usados como contexto para sua equipe.

Obter Listas de Bloqueio de Repositórios da Equipe

Recupere todas as listas de bloqueio de repositórios configuradas para sua equipe.

GET /settings/repo-blocklists/repos

Resposta

Retorna um array de objetos de lista de bloqueio de repositórios:

{
  repos: {
    id: string;
    url: string;
    patterns: string[];
  }[];
}

Exemplo de Resposta

{
  "repos": [
    {
      "id": "repo_123",
      "url": "https://github.com/company/sensitive-repo",
      "patterns": ["*.env", "config/*", "secrets/**"]
    },
    {
      "id": "repo_456",
      "url": "https://github.com/company/internal-tools",
      "patterns": ["*"]
    }
  ]
}

Exemplo de Requisição

curl -X GET https://api.cursor.com/settings/repo-blocklists/repos \
  -u YOUR_API_KEY:

Inserir ou Atualizar Listas de Bloqueio de Repositórios

Substitua as listas de bloqueio de repositórios existentes para os repositórios fornecidos. Nota: Este endpoint apenas sobrescreverá os padrões para os repositórios fornecidos. Todos os outros repositórios não serão afetados.

POST /settings/repo-blocklists/repos/upsert

Corpo da Requisição

Parâmetro	Tipo	Obrigatório	Descrição
repos	array	Sim	Array de objetos de lista de bloqueio de repositórios

Cada objeto de repositório deve conter:

Campo	Tipo	Obrigatório	Descrição
url	string	Sim	URL do repositório para adicionar à lista de bloqueio
patterns	string[]	Sim	Array de padrões de arquivo para bloquear (padrões glob suportados)

Resposta

Retorna a lista atualizada de listas de bloqueio de repositórios:

{
  repos: {
    id: string;
    url: string;
    patterns: string[];
  }[];
}

Exemplo de Requisição

curl -X POST https://api.cursor.com/settings/repo-blocklists/repos/upsert \
  -u YOUR_API_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "repos": [
      {
        "url": "https://github.com/company/sensitive-repo",
        "patterns": ["*.env", "config/*", "secrets/**"]
      },
      {
        "url": "https://github.com/company/internal-tools", 
        "patterns": ["*"]
      }
    ]
  }'

Excluir Lista de Bloqueio de Repositório

Remove um repositório específico da lista de bloqueio.

DELETE /settings/repo-blocklists/repos/:repoId

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
repoId	string	Sim	ID da lista de bloqueio de repositório para excluir

Resposta

Retorna 204 No Content em caso de exclusão bem-sucedida.

Exemplo de Requisição

curl -X DELETE https://api.cursor.com/settings/repo-blocklists/repos/repo_123 \
  -u YOUR_API_KEY:

Exemplos de Padrões

Padrões comuns de lista de bloqueio:

* - Bloquear repositório inteiro
*.env - Bloquear todos os arquivos .env
config/* - Bloquear todos os arquivos no diretório config
**/*.secret - Bloquear todos os arquivos .secret em qualquer subdiretório
src/api/keys.ts - Bloquear arquivo específico

Começar

Essencial

Contexto

Integrações

Modelos

Configuração

Conta

Solução de Problemas

​Autenticação

​Criando uma Chave de API

​Usando Sua Chave de API

​URL Base

​Endpoints

​Obter Membros da Equipe

​Resposta

​Exemplo de Resposta

​Exemplo de Requisição

​Obter Dados de Uso Diário

​Corpo da Requisição

​Resposta

​Campos da Resposta

​Exemplo de Resposta

​Exemplo de Requisição

​Obter Dados de Gastos

​Corpo da Requisição

​Resposta

​Campos da Resposta

​Exemplo de Resposta

​Exemplos de Requisições

​Obter Dados de Eventos de Uso

​Corpo da Requisição

​Resposta

​Campos da Resposta Explicados

​Exemplo de Resposta

​Exemplos de Requisições

​API de Listas de Bloqueio de Repositórios

​Obter Listas de Bloqueio de Repositórios da Equipe

Resposta

Exemplo de Resposta

Exemplo de Requisição

​Inserir ou Atualizar Listas de Bloqueio de Repositórios

Corpo da Requisição

Resposta

Exemplo de Requisição

​Excluir Lista de Bloqueio de Repositório

Parâmetros

Resposta

Exemplo de Requisição

​Exemplos de Padrões

Autenticação

Criando uma Chave de API

Usando Sua Chave de API

URL Base

Endpoints

Obter Membros da Equipe

Resposta

Exemplo de Resposta

Exemplo de Requisição

Obter Dados de Uso Diário

Corpo da Requisição

Resposta

Campos da Resposta

Exemplo de Resposta

Exemplo de Requisição

Obter Dados de Gastos

Corpo da Requisição

Resposta

Campos da Resposta

Exemplo de Resposta

Exemplos de Requisições

Obter Dados de Eventos de Uso

Corpo da Requisição

Resposta

Campos da Resposta Explicados

Exemplo de Resposta

Exemplos de Requisições

API de Listas de Bloqueio de Repositórios

Obter Listas de Bloqueio de Repositórios da Equipe

Inserir ou Atualizar Listas de Bloqueio de Repositórios

Excluir Lista de Bloqueio de Repositório

Exemplos de Padrões