Cursor – Admin API

Admin API memungkinkan Anda mengakses data tim secara programatis, termasuk informasi anggota, metrik penggunaan, dan detail pengeluaran. Bangun dashboard kustom, alat monitoring, atau integrasikan dengan alur kerja yang sudah ada.

API ini masih dalam rilis pertama. Kami sedang memperluas kemampuan berdasarkan masukan - beri tahu kami endpoint apa yang Anda butuhkan!

Autentikasi

Semua permintaan API memerlukan autentikasi menggunakan API key. Hanya administrator tim yang dapat membuat dan mengelola API key. API key terikat pada organisasi, dapat dilihat oleh semua admin, dan tidak terpengaruh oleh status akun pembuat aslinya.

Membuat API Key

Navigasi ke cursor.com/dashboard → tab Settings → Cursor Admin API Keys
Klik Create New API Key
Berikan nama deskriptif untuk key Anda (misalnya, “Usage Dashboard Integration”)
Salin key yang dihasilkan segera - Anda tidak akan melihatnya lagi

Format: key_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Menggunakan API Key Anda

Gunakan API key Anda sebagai username dalam autentikasi dasar: Menggunakan curl dengan basic auth:

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

Atau atur header Authorization secara langsung:

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

Base URL

Semua endpoint API menggunakan:

https://api.cursor.com

Endpoints

Dapatkan Anggota Tim

Ambil semua anggota tim dan detail mereka.

GET /teams/members

Response

Mengembalikan array objek anggota tim:

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

Contoh Response

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

Contoh Request

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

Dapatkan Data Penggunaan Harian

Ambil metrik penggunaan harian yang detail untuk tim Anda dalam rentang tanggal. Memberikan wawasan tentang pengeditan kode, penggunaan bantuan AI, dan tingkat penerimaan.

POST /teams/daily-usage-data

Request Body

Parameter	Type	Required	Description
`startDate`	number	Ya	Tanggal mulai dalam epoch milliseconds
`endDate`	number	Ya	Tanggal akhir dalam epoch milliseconds

Rentang tanggal tidak boleh melebihi 90 hari. Buat beberapa request untuk periode yang lebih panjang.

Response

{
  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;
  };
}

Field Response

Field	Description
`date`	Tanggal dalam epoch milliseconds
`isActive`	Pengguna aktif pada hari ini
`totalLinesAdded`	Baris kode yang ditambahkan
`totalLinesDeleted`	Baris kode yang dihapus
`acceptedLinesAdded`	Baris yang ditambahkan dari saran AI yang diterima
`acceptedLinesDeleted`	Baris yang dihapus dari saran AI yang diterima
`totalApplies`	Operasi apply
`totalAccepts`	Saran yang diterima
`totalRejects`	Saran yang ditolak
`totalTabsShown`	Tab completion yang ditampilkan
`totalTabsAccepted`	Tab completion yang diterima
`composerRequests`	Request composer
`chatRequests`	Request chat
`agentRequests`	Request agent
`cmdkUsages`	Penggunaan command palette (Cmd+K)
`subscriptionIncludedReqs`	Request subscription
`apiKeyReqs`	Request API key
`usageBasedReqs`	Request bayar per penggunaan
`bugbotUsages`	Penggunaan deteksi bug
`mostUsedModel`	Model AI yang paling sering digunakan
`applyMostUsedExtension`	Ekstensi file yang paling sering digunakan untuk apply
`tabMostUsedExtension`	Ekstensi file yang paling sering digunakan untuk tab
`clientVersion`	Versi Cursor
`email`	Email pengguna

Contoh Response

{
  "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
  }
}

Contoh Request

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
  }'

Mendapatkan Data Pengeluaran

Mengambil informasi pengeluaran untuk bulan kalender saat ini dengan pencarian, pengurutan, dan paginasi.

POST /teams/spend

Request Body

Parameter	Type	Required	Description
`searchTerm`	string	No	Pencarian dalam nama pengguna dan email
`sortBy`	string	No	Urutkan berdasarkan: `amount`, `date`, `user`. Default: `date`
`sortDirection`	string	No	Arah pengurutan: `asc`, `desc`. Default: `desc`
`page`	number	No	Nomor halaman (dimulai dari 1). Default: `1`
`pageSize`	number	No	Hasil per halaman

Response

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

Field Response

Field	Description
`spendCents`	Total pengeluaran dalam sen
`fastPremiumRequests`	Request model premium cepat
`name`	Nama anggota
`email`	Email anggota
`role`	Peran dalam tim
`hardLimitOverrideDollars`	Override batas pengeluaran khusus
`subscriptionCycleStart`	Mulai siklus berlangganan (epoch milidetik)
`totalMembers`	Total anggota tim
`totalPages`	Total halaman

Contoh Response

{
  "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
}

Contoh Permintaan

Data pengeluaran dasar:

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

Cari pengguna tertentu dengan paginasi:

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
  }'

Dapatkan Data Event Penggunaan

Ambil event penggunaan terperinci untuk tim Anda dengan opsi filtering, pencarian, dan paginasi yang komprehensif. Endpoint ini menyediakan wawasan granular tentang panggilan API individual, penggunaan model, konsumsi token, dan biaya.

POST /teams/filtered-usage-events

Request Body

Parameter	Type	Required	Description
`startDate`	number	No	Tanggal mulai dalam epoch milliseconds
`endDate`	number	No	Tanggal akhir dalam epoch milliseconds
`userId`	number	No	Filter berdasarkan ID pengguna tertentu
`page`	number	No	Nomor halaman (1-indexed). Default: `1`
`pageSize`	number	No	Jumlah hasil per halaman. Default: `10`
`email`	string	No	Filter berdasarkan alamat email pengguna

Response

{
  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;
  };
}

Penjelasan Field Response

Field	Description
`totalUsageEventsCount`	Total jumlah event penggunaan yang cocok dengan query
`pagination`	Metadata paginasi untuk navigasi hasil
`timestamp`	Timestamp event dalam epoch milliseconds
`model`	Model AI yang digunakan untuk permintaan
`kindLabel`	Kategori penggunaan (misalnya, “Usage-based”, “Included in Business”)
`maxMode`	Apakah max mode diaktifkan
`requestsCosts`	Biaya dalam unit permintaan
`isTokenBasedCall`	True ketika event dikenakan biaya sebagai event berbasis penggunaan
`tokenUsage`	Konsumsi token terperinci (tersedia ketika isTokenBasedCall adalah true)
`isFreeBugbot`	Apakah ini adalah penggunaan bugbot gratis
`userEmail`	Email pengguna yang membuat permintaan
`period`	Rentang tanggal dari data yang di-query

Contoh Response

{
  "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
  }
}

Contoh Request

Dapatkan semua event penggunaan dengan paginasi default:

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

Filter berdasarkan rentang tanggal dan pengguna tertentu:

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
  }'

Dapatkan event penggunaan untuk pengguna tertentu dengan paginasi kustom:

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
  }'

Repo Blocklists API

Tambahkan repositori dan gunakan pola untuk mencegah file atau direktori diindeks atau digunakan sebagai konteks untuk tim Anda.

Dapatkan Team Repo Blocklists

Ambil semua blocklist repositori yang dikonfigurasi untuk tim Anda.

GET /settings/repo-blocklists/repos

Response

Mengembalikan array objek blocklist repositori:

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

Contoh Response

{
  "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": ["*"]
    }
  ]
}

Contoh Request

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

Upsert Repo Blocklists

Ganti blocklist repositori yang ada untuk repo yang disediakan. Catatan: Endpoint ini hanya akan menimpa pola untuk repositori yang disediakan. Semua repo lainnya tidak akan terpengaruh.

POST /settings/repo-blocklists/repos/upsert

Request Body

Parameter	Type	Required	Description
repos	array	Yes	Array dari objek blocklist repositori

Setiap objek repositori harus berisi:

Field	Type	Required	Description
url	string	Yes	URL repositori untuk dimasukkan ke blocklist
patterns	string[]	Yes	Array dari pola file yang akan diblokir (mendukung pola glob)

Response

Mengembalikan daftar terbaru dari blocklist repositori:

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

Example Request

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": ["*"]
      }
    ]
  }'

Delete Repo Blocklist

Menghapus repositori tertentu dari blocklist.

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

Parameters

Parameter	Type	Required	Description
repoId	string	Yes	ID dari blocklist repositori yang akan dihapus

Response

Mengembalikan 204 No Content ketika penghapusan berhasil.

Example Request

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

Pattern Examples

Pola blocklist yang umum:

* - Blokir seluruh repositori
*.env - Blokir semua file .env
config/* - Blokir semua file dalam direktori config
**/*.secret - Blokir semua file .secret dalam subdirektori manapun
src/api/keys.ts - Blokir file tertentu

Memulai

Inti

Konteks

Integrasi

Model

Konfigurasi

Akun

Pemecahan Masalah

​Autentikasi

​Membuat API Key

​Menggunakan API Key Anda

​Base URL

​Endpoints

​Dapatkan Anggota Tim

​Response

​Contoh Response

​Contoh Request

​Dapatkan Data Penggunaan Harian

​Request Body

​Response

​Field Response

​Contoh Response

​Contoh Request

​Mendapatkan Data Pengeluaran

​Request Body

​Response

​Field Response

​Contoh Response

​Contoh Permintaan

​Dapatkan Data Event Penggunaan

​Request Body

​Response

​Penjelasan Field Response

​Contoh Response

​Contoh Request

​Repo Blocklists API

​Dapatkan Team Repo Blocklists

Response

Contoh Response

Contoh Request

​Upsert Repo Blocklists

Request Body

Response

Example Request

​Delete Repo Blocklist

Parameters

Response

Example Request

​Pattern Examples

Autentikasi

Membuat API Key

Menggunakan API Key Anda

Base URL

Endpoints

Dapatkan Anggota Tim

Response

Contoh Response

Contoh Request

Dapatkan Data Penggunaan Harian

Request Body

Response

Field Response

Contoh Response

Contoh Request

Mendapatkan Data Pengeluaran

Request Body

Response

Field Response

Contoh Response

Contoh Permintaan

Dapatkan Data Event Penggunaan

Request Body

Response

Penjelasan Field Response

Contoh Response

Contoh Request

Repo Blocklists API

Dapatkan Team Repo Blocklists

Upsert Repo Blocklists

Delete Repo Blocklist

Pattern Examples