Origin API

Origin は Early Beta 段階であり、変更される可能性があります。連携を更新する際は、OpenAPI 仕様を確認してください。

Origin は Cherri Code のコードフォージです。公開 REST API を使用すると、アプリやツールで Origin のリポジトリ、コミット、チェック、Pull Requests、アプリのインストールを操作できます。

Origin Apps は、アプリ JWT とインストールアクセストークンで認証します。認証を参照してください。
詳細なスキーマと例については、OpenAPI 仕様の完全版を参照してください。
エージェントは、llms.txt インデックスまたは llms-full.txt の Markdown 形式の完全なリファレンスを読み込めます。

概要

Origin Apps は、OAuth 形式のインストール同意と GitHub App 形式の認証モデルを採用しています。

アプリは、Ed25519 秘密鍵を使用して短期有効の EdDSA JWT に署名します。
アプリは、その JWT とインストール ID を短期有効のインストールアクセストークン (oit_…) と交換します。
インストールトークンは、インストールで承認されたリポジトリとスコープ内でリポジトリ API を呼び出し、HTTPS 経由の Git 認証に使用します。
Origin は、アプリに登録された webhook URL に署名付き webhook 配信を送信します。

ベース URL

https://api.cursor.com/v1/origin

リファレンスのエンドポイントパスには、/v1/originプレフィックス全体が含まれます。

プロトコルの規約

リクエストとレスポンスには application/json を使用します。JSON フィールド名には camelCase を使用します。タイムスタンプは RFC 3339 形式の文字列です。プルリクエスト番号やバージョン番号を含む Protobuf の 64 ビット整数は、JSON 文字列として表現します。

レスポンスは、デフォルト値のフィールドを省略せずに含めます。そのため、false の boolean、0 の number、空文字列、空の配列はいずれもボディに含まれます。キーが存在しないことをデフォルト値とみなすのではなく、値そのものを読み取ってください。存在しない、または省略されると記載されているフィールドはコントラクト上 optional であり、未設定の場合はボディに含まれません。

プレビュー

一部の API サーフェスはプレビューとして公開されています。これらはこのリファレンスと仕様書に記載されていますが、一般提供 (GA) までに構造が変更される可能性があります。OpenAPI 仕様では、これらに x-cursor-visibility: PREVIEW が付与されています。このマーカーは操作、パラメータ、スキーマ、または個々のフィールドに付与されることがあるため、安定版の操作でもプレビューのフィールドが返される場合があります。プレビュー段階のエンドポイントには、このリファレンスで Preview バッジが表示されます。プレビューのフィールドは省略可能なものとして扱い、その構造に強く依存する実装は作らないでください。

はじめに

Origin へのアクセス

cursor.com/codebase で Origin をブラウズします。
cursor.com/codebase/settings/apps でアプリの設定を管理します。
アプリの署名キーを生成し、公開キーのみを登録します。

Origin CLI

Origin CLI をインストールしてサインインします。

curl -fsSL https://downloads.cursor.com/origin/install.sh | shorigin auth login

既存のリポジトリをクローンする：

origin repo clone '{ownerSlug}/{repoName}'# または git を直接使用するgit clone 'https://origin.cursor.com/{ownerSlug}/{repoName}.git'

Apps は、ユーザーログインではなく、インストールアクセストークンによる Git HTTPS 認証を使用してクローンします。

インストール

顧客の Workspace 管理者に以下を送信してください：

/codebase/apps/install  ?client_id=APP_ID  &scope=SPACE_SEPARATED_SCOPES  &redirect_uri=REGISTERED_CALLBACK  &state=RANDOM_ANTI_FORGERY_VALUE  &summary=SHORT_REASON_FOR_ACCESS  &include_granted_scopes=true

パラメータ	必須	説明
`client_id`	対応	Origin Apps ID。
`scope`	対応	スペース区切りのスコープ。`repository:metadata:read` は自動的に追加されます。
`redirect_uri`	パートナー主導のインストールでは対応	登録済みのコールバック URI と完全に一致する URI。
`state`	強く推奨	インストールレシートの `state` クレームとしてエコーされる偽造防止用のランダムな値。リダイレクト前に生成し、コールバック時にクレームを確認してください。
`summary`	非対応	同意画面に表示される簡単な説明。
`include_granted_scopes`	非対応	`true` の場合、既存の付与を維持し、追加分のみをリクエストします。

Workspace 管理者は、ターゲットの所有者、承認するスコープ、すべてのリポジトリまたは選択したリポジトリを選択します。リポジトリへのアクセスを制御するのはアプリではなく顧客です。

承認後、Origin は登録済みのコールバック URI にリダイレクトします。

https://ci.example.com/origin/callback?installation_receipt=RECEIPT_JWT

インストールレシートを確認してから、その sub クレームからインストール ID を保存します。インストールアクセストークンを発行するたびに必要になります。

インストールでは、次の 2 つのリポジトリ選択モードのいずれかを使用します。

all: インストールは、選択したターゲットが所有するすべてのリポジトリにアクセスできます。
selected: インストールは、Workspace 管理者が選択したリポジトリにのみアクセスできます。

どちらのモードも、ネイティブの Origin リポジトリとミラーリポジトリの両方に対応しているため、ミラーは GET /installation/repos に表示され、選択できます。ミラーは安定したアウトバウンドミラーになるまで参照専用です。ミラーリポジトリを参照してください。

インストールトークンを使用して GET /installation/repos を呼び出すと、そのインストールで利用可能なリポジトリを確認できます。App JWT エンドポイントでは、アプリのインストールを一覧表示、確認、削除できます。インストールを削除すると、新しいトークンを発行できなくなります。

インストールレシート

installation_receipt は、Origin が署名した短期有効なコンパクト JWT です。インストールの承認が偽造されたリダイレクトによるものではなく、Origin からのものであることを証明し、コールバックに必要な情報をすべて含みます。Cherri Code はこれがない場合はリダイレクトを拒否するため、外部コールバックには常に含まれます。

JOSE ヘッダー:

{  "alg": "EdDSA",  "kid": "origin-key-id",  "typ": "origin-installation-receipt+jwt"}

クレーム:

{  "iss": "https://api.cursor.com/v1/origin",  "aud": "app_01...",  "sub": "i_01...",  "namespace_id": "ns_01...",  "iat": 1786465200,  "exp": 1786465500,  "jti": "RECEIPT_UUID",  "installedBy": {    "id": "user_01...",    "email": "[email protected]",    "displayName": "Jane Doe"  },  "state": "ORIGINAL_VALUE"}

aud はアプリ ID、sub はインストールアクセストークンを発行する際に使用するインストール ID です。
namespace_id は、アプリがインストールされた namespace の安定した ID です。
installedBy は、このインストールまたは再同意を実行したユーザーを識別します。現在のアクションを示すため、再同意時には Get App Installation の永続的な installedBy と異なる場合があります。アカウントに名前がある場合は displayName を含みますが、handle は含みません。handle は REST レスポンスまたは webhook のペイロードから取得してください。
レシートは発行から 5 分で期限切れになります。jti はレシートごとに一意です。
state は、インストール URL に空でない state が含まれる場合にのみ存在し、その値をそのまま返します。リダイレクト前に生成した偽造防止用の値と照合してください。

コールバックを信頼する前にレシートを確認してください。kid ヘッダーを基に JWKS から署名キーを取得し、alg が EdDSA、typ が origin-installation-receipt+jwt であることを確認したうえで、署名、iss、aud、exp を検証します。検証に失敗した場合は、コールバックを拒否します。

レシートはインストールアクセストークンではありません。Bearer 認証情報として送信しないでください。代わりに、Create Installation Access Token でインストールトークンを発行してください。

認証

REST認証情報はBearerスキームで送信してください。各エンドポイントのAuthバッジに、受け入れ可能な認証情報のタイプが一覧表示されます。

curl --request GET \  --url https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME \  --header "Authorization: Bearer $ORIGIN_BEARER_TOKEN"

Cherri Code API キーはOriginのBearerトークンではありません。ユーザー認証されたリクエストには Origin CLI を使用してください。Origin CLIは、個人ユーザーの API キーを、Originが受け入れる短命なアクセストークンと交換します。Cherri Code API キーを Authorization ヘッダーに直接指定しないでください。

アプリの署名キーを生成する

Origin Apps は Ed25519 キーペアで認証します。キーペアをローカルで生成し、公開鍵のみを cursor.com/codebase/settings/apps に登録します。アプリでは有効な署名キーを最大 10 個保持できます。

秘密鍵は厳重に管理してください。アップロードしたり、アプリの設定に貼り付けたり、リポジトリにコミットしたり、共有したりしないでください。シークレットマネージャーに保存してください。Cherri Code に保存されるのは公開鍵のみです。

OpenSSL を使用して、PKCS#8 秘密鍵と PEM SPKI 公開鍵を作成します。

openssl genpkey -algorithm ED25519 -out origin-app-private.pemopenssl pkey -in origin-app-private.pem -pubout -out origin-app-public.pem

公開鍵ファイルは -----BEGIN PUBLIC KEY----- で始まります。署名キーを追加する際に、この PEM を貼り付けます。対応する秘密鍵は、app JWT への署名にのみ使用してください。

アプリ JWT

アプリの有効な署名キーのいずれかに対応する Ed25519 秘密鍵で、短期有効の JWT に署名します。その鍵ペアは、アプリ署名キーを生成するで説明されている方法で生成します。

JOSE ヘッダー:

{  "alg": "EdDSA",  "kid": "app_01...",  "typ": "JWT"}

クレーム：

{  "iss": "app_01...",  "aud": "origin-apps",  "iat": 1782928800,  "exp": 1782929100}

iss と kid にはアプリ ID を設定します。有効期限は約 5 分に設定します。

Authorization: Bearer APP_JWT

アプリのメタデータの読み取り、インストールの管理、インストールトークンの発行、Webhook 配信の再取得などのアプリレベルの操作には、アプリ JWT を使用します。

インストールアクセストークン

アプリ JWT を使用して POST /app/installations/{installationId}/access_tokens を呼び出します。インストールトークンは oit_ で始まります。

Authorization: Bearer oit_...

レスポンスには expiresAt が含まれます。トークンは必要になる直前に発行し、有効期限が切れる前に更新してください。パスワードと同様に扱い、決してログに記録しないでください。

トークンの有効期限は作成から最大 15 分であり、それをリクエストしたアプリ JWT の有効期限を超えることはありません。そのため、上で推奨した 5 分の JWT では、トークンの有効期間も最大 5 分になります。有効期間を決め打ちせず、expiresAt を読み取り、期限を過ぎたら新しいトークンを発行してください。オリジンのトークンは GitHub App のインストールトークンよりも有効期間が短いため、GitHub のスケジュールに合わせてトークンを再利用する連携は、トークンの期限切れとともに失敗します。ジョブで 15 分すべてを必要とする場合は、CloneKit CI レシピのように、より遅い exp で JWT に署名してください。

インストールを削除するか、アプリを削除すると、expiresAt より前にそのインストールトークンは無効になります。その後、REST API と HTTPS 経由の Git はトークンを 401 で拒否します。同じトークンで再試行しないでください。有効なトークンを発行するには、アプリを再インストールする必要があります。

インストールトークンに付与できるスコープまたはリポジトリアクセスは、インストールで承認された範囲を超えることはできません。トークンは、より少ない scopes または repositoryIds に制限できます。空の配列または省略した配列には、インストールに付与されたすべての権限が継承されます。

Pull Requestsやチェック実行の書き込み、HTTPS 経由の Gitを含む、リポジトリスコープの操作にはインストールトークンを使用します。

アプリとしてではなく、インストール先の名前空間のメンバーとして操作するには、インストールユーザートークンを発行します。詳しくはユーザーの代理としての操作を参照してください。

Git HTTPS 認証

インストールアクセストークンを使用して、HTTPS 経由で Git を認証します。Git エンドポイントでは HTTP ベーシック認証を使用します。パスワードにはインストールトークン、ユーザー名には x-access-token を指定します。Bearer 認証情報は REST API で使用してください。Git HTTPS では使用できません。

Git 操作の直前に、Create Installation Access Token でトークンを発行します。トークンの有効期限は最長 15 分です。

clone、fetch、pull には repository:contents:read が必要です。プッシュには repository:contents:write が必要です。トークンの権限付与には、ターゲットリポジトリを含める必要があります。

プッシュには、Create Repo と同様に、リポジトリの所有者に Origin への書き込みが許可されていることも必要です。ユーザー所有者は、Pro、Pro Student、Pro+、Ultra、または Start プランを利用している必要があります。チーム所有者は、有効な有料チームプランを利用しており、プライバシーモード (レガシー) を使用しておらず、チーム管理者によって Origin が無効化されていない必要があります。所有者が適格でないリポジトリへのプッシュでは 403 が返されます。clone、fetch、pull にはこの要件はありません。

Get Repo または List App Installation Repositories から cloneUrl を取得します。GitHub 形式のパス (https://origin.cursor.com/OWNER_SLUG/REPO_NAME.git) と従来の /git/ パスのどちらでも clone できます。

git clone "https://x-access-token:${INSTALLATION_TOKEN}@origin.cursor.com/OWNER_SLUG/REPO_NAME.git"

トークンをURLに埋め込むと、.git/configに保存されます。クローンに成功したら、後続のコマンドで期限切れのシークレットが再利用されないよう、リモートURLを書き換えます：

git remote set-url origin "https://origin.cursor.com/OWNER_SLUG/REPO_NAME.git"

トークンをリモート URL に含めないよう、Git の認証情報ヘルパーを使って指定します：

git -c credential.helper="!f() { echo username=x-access-token; echo password=${INSTALLATION_TOKEN}; }; f" \  clone "https://origin.cursor.com/OWNER_SLUG/REPO_NAME.git"

Origin CLI の認証情報ヘルパーは、ユーザーログインに使用します。アプリ連携では、ここに示すようにインストールトークンを渡します。トークンはパスワードと同様に扱い、決してログに記録しないでください。ジョブで引き続き Git へのアクセスが必要な場合は、expiresAt より前に新しいトークンを発行してください。

HTTPS 経由の Git は、Rate limits の REST 用バジェットとは別に、独自のバジェットで計測されます。カウント対象となる Git レスポンスには、同じ X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Used ヘッダーが含まれ、X-RateLimit-Resource は core ではなく git に設定されます。バジェットを超過した Git リクエストには、Retry-After と X-RateLimit-Reset を伴う 429 が返されます。数値を決め打ちせず、ヘッダーを読み取ってジョブのペースを調整してください。計測対象外のリクエストにはレート制限ヘッダーは含まれません。

ミラーリポジトリでは、インストールトークンで clone、fetch、pull を実行できますが、ミラーが安定したアウトバウンドミラーになるまで、Origin は git push を 403 で拒否します。ミラーリポジトリを参照してください。

ユーザー認証による CLI リクエスト

ユーザー認証されたリクエストには origin api を使用します。対話型セッションの場合は、ブラウザからサインインします。

origin auth loginorigin api /repos/OWNER_SLUG/REPO_NAME/pulls

非対話型セッションの場合は、Cherri Code Dashboard → API キーで取得した個人ユーザーの API キーを指定してください。

export CURSOR_API_KEY="YOUR_PERSONAL_USER_API_KEY"origin api /repos/OWNER_SLUG/REPO_NAME/pulls

CLI は個人用 API キーを短期間有効なユーザーアクセストークンに交換し、そのトークンを Authorization ヘッダーに含めて送信します。API キー自体を Origin エンドポイントに送信しないでください。アプリ連携では、代わりにアプリ JWT とインストールアクセストークンを使用してください。

ディスカバリーと署名キー

Origin は、認証不要のディスカバリーメタデータと有効な署名キーを公開します。同じキーは webhook 配信とインストールレシートの署名に使用されます。

ディスカバリーメタデータには、issuer と jwks_uri が含まれます：

curl https://api.cursor.com/v1/origin/.well-known/openid-configuration

{  "issuer": "https://api.cursor.com/v1/origin",  "jwks_uri": "https://api.cursor.com/v1/origin/keys",  "response_types_supported": ["id_token"],  "subject_types_supported": ["public"],  "id_token_signing_alg_values_supported": ["EdDSA"]}

/keys は有効な Ed25519 JWK を返します：

curl https://api.cursor.com/v1/origin/keys

{  "keys": [    {      "kty": "OKP",      "crv": "Ed25519",      "use": "sig",      "alg": "EdDSA",      "kid": "origin-key-id",      "x": "PUBLIC_KEY_MATERIAL"    }  ]}

JWKS をキャッシュします。/keys は Cache-Control: public, max-age=600, stale-if-error=600 を送信するため、キャッシュされたレスポンスを 10 分間再利用した後に更新します。更新に失敗した場合は、検証を失敗とする前に、最後に取得した有効なキーを最大さらに 10 分間保持します。どのキーでも検証できない署名を受け取った場合も更新し、これにより廃止されたキー ID が除去されます。キーは毎週ローテーションされます。

Webhook 署名にはキー ID が含まれないため、検証時には有効な各 Ed25519 キーで検証を試行する必要があります。インストールレシートには JOSE ヘッダーに署名キーの kid が含まれるため、レシートの検証ではキーを直接特定できます。

スコープ

アプリに必要な最小限のスコープのみをリクエストしてください。repository:metadata:read、およびアプリまたはインストールのメタデータへのアクセスは自動的に付与されるため、インストール URL に個別に追加する必要はありません。

スコープ	許可される操作
`repository:metadata:read`	リポジトリのメタデータを読み取る。自動的に追加されます。
`repository:contents:read`	コミット、ブランチ、コンテンツ、比較ファイル、低レベルの Git オブジェクトを読み取る。ファイルのテキストを検索する。リポジトリのアーカイブをダウンロードする。Git HTTPS 経由でクローン、フェッチ、プルする。ミラーリポジトリをアップストリームソースから同期する。
`repository:contents:write`	Git HTTPS 経由でプッシュする。Pull Requests をマージする。Git data エンドポイント経由でブランチを作成し、ファイルの変更をコミットする。チェック実行を再リクエストする。
`repository:pull_requests:read`	Pull Requests、変更ファイル、Pull Requests のコミット、割り当てられたラベル、マージ可否を読み取る。
`repository:pull_requests:write`	Pull Requests を作成・更新する。Pull Requests のラベルを割り当て・削除する。
`repository:pull_requests:reviews:read`	Pull Requestsコメント、コメントスレッド、送信済み確認、レビュー依頼先を読み取る。
`repository:pull_requests:reviews:write`	コメントを作成・更新し、コメントスレッドを解決・再オープンし、確認を作成・更新・却下し、レビュー担当者を依頼・削除する。
`repository:checks:read`	チェックスイート、実行、チェック実行の注釈を読み取る。
`repository:checks:write`	チェックスイートと実行を作成・更新する。チェック実行の注釈を追加する。
`repository:labels:read`	リポジトリが所有するラベル定義を読み取る。
`repository:labels:write`	リポジトリのラベル定義を作成・更新・削除する。
`repository:rulesets:read`	リポジトリのルールセットを読み取る。
`repository:rulesets:write`	リポジトリのルールセットを作成・更新・削除する。
`repository:settings:read`	リポジトリに直接付与されている権限付与を読み取る。
`repository:settings:write`	リポジトリの設定を更新する: デフォルトブランチ、可視性、マージ方法、自動ヘッドブランチ削除。リポジトリの権限付与を upsert・削除する。
`namespace:settings:read`	所有者に直接付与されている権限付与を読み取る。所有者が信頼する SSH 認証局と、証明書を必須とするかどうかを読み取る。
`namespace:settings:write`	所有者の権限付与を upsert・削除する。SSH 認証局を追加・削除し、所有者が証明書を必須とするかどうかを設定する。これらの書き込みには Cherri Code ユーザー認証情報が必要です。
`namespace:user_tokens:write`	インストールの名前空間のメンバーとして動作するインストールユーザートークンを発行する。トークン自体がこのスコープを持つことはできません。ユーザーの代理としての操作を参照してください。

:write スコープをリクエストすると、対応する :read スコープも併せて付与されます。そのため repository:labels:write は repository:labels:read を含んでおり、両方を指定する必要はありません。ただし、その逆は成り立ちません。読み取りスコープが書き込みを許可することはありません。

インストールトークンでは、これらの権限付与を制限することしかできません。Workspace 管理者が承認していないスコープやリポジトリを追加することはできません。

ミラー状態の変更はこの表の対象外です。リポジトリミラーを移行、リポジトリミラーの切り替えを強制、リポジトリミラーを切断には repository:mirror:write または repository:mirror:delete が必要ですが、アプリはこれらをインストール時にリクエストできません。これらは Cherri Code ユーザー認証情報に付随し、呼び出し元はミラーのアップストリームソース上でもリポジトリを管理している必要があります。

インストールの管理も対象外です。アプリのインストールにリポジトリを追加には namespace:installations:write が必要ですが、アプリはこれをインストール時にリクエストできません。これは名前空間管理者が Cherri Code ユーザー認証情報上で保持するもので、インストールに同意したものと同じ種類の認証情報のみがその範囲を拡張できます。

アプリの管理も同じ理由で対象外です。アプリを作成には namespace:apps:create、名前空間のアプリ一覧を取得とアプリを取得には namespace:apps:read、アプリを更新、アプリの署名キーを追加、アプリの署名キーを失効には app:settings:write が必要です。発行者はこれらを Cherri Code ユーザー認証情報上で保持します。アプリが自身のためにこれらをリクエストすることはできません。

この表では、アプリがインストール時にリクエストするスコープを示しています。個別の操作に必要なスコープを確認するには、OpenAPI 仕様の x-origin-scopes 拡張を参照してください。この拡張は、インストール権限ではなく認証情報自体に付随する app、installation、namespace スコープを含む、すべての操作を対象としています。必要なスコープがすべて認証情報に付随している操作には、拡張に ambient: true が付きます。この場合、リクエストすべきものは何もなく、適切な認証情報を提示するだけで十分です。

ミラーリポジトリ

インストールでは、ネイティブの Origin リポジトリと安定したアウトバウンドミラーに対して、付与されているすべてのスコープを使用できます。その他のミラー状態のリポジトリでは、次の 2 つのスコープのみが適用されます。

repository:metadata:read
repository:contents:read

Workspace 管理者が何を承認したかにかかわらず、そのリポジトリでは、それ以外のすべてのスコープで 403 が返されます。REST API では、リポジトリとコンテンツの読み取り、コミットの比較、ミラーを同期は引き続き利用できますが、Origin はPull Requests、確認、コメント、チェック、ルールセット、およびすべての書き込みを拒否します。Git HTTPS では、クローン、フェッチ、プル、LFS のダウンロードは引き続き利用できますが、Origin は push と LFS のアップロードを拒否します。

リポジトリをその状態から移行するには、インストールでは実行できないユーザー認証情報による操作が必要です。リポジトリミラーを移行ではミラーの方向を進め、リポジトリミラーの切り替えを強制では分岐したリファレンスをプッシュバックせずにアップストリームソースへ切り替え、リポジトリミラーを切断ではミラーを完全に切断します。

リポジトリの mirror オブジェクトでは、書き込みが許可されているかどうかはわかりません。移行中のミラーでは、mirror.status が outbound と表示されていても参照専用の場合があるため、mirror.status に基づいて分岐するのではなく、403 を信頼してください。

レート制限

Origin API では、プリンシパルごとに共有のポイント予算が設定されており、直近1分間のローリングウィンドウごとにリセットされます。認証済みプリンシパルの種類ごとに、それぞれ予算が設定されています。

プリンシパル	デフォルトの予算
インストールアクセストークン	3,000 ポイント/分
アプリ JWT	6,000 ポイント/分
Cherri Code ユーザーまたはサービスアカウント	600 ポイント/分

各エンドポイントは、ハンドラーの実行前にこの予算から固定コストを差し引きます。認証または認可に失敗した場合、コストはかかりません。

コスト	操作
0	レート制限の取得。ステータスの取得のみで、ポイントは消費しません。
1	ほとんどの読み取りエンドポイント、およびインストールアクセストークンを作成
5	通常の書き込み操作、および次の負荷の高い読み取り操作: Get Commit、List Commit Files、List Comparison Files、List Pull Request Files、Get Repo Tarball、Grep Contents
10	Create App、Create Repo、Create Commit From Files、Merge Pull Request、Get Pull Request Mergeability、リポジトリミラーを移行、リポジトリミラーの切り替えを強制

Cherri Code は、デザインパートナー向けにアプリごとの1分あたりの予算を引き上げることができます。連携により高い上限が必要な場合は、Cherri Code にお問い合わせください。

レスポンスヘッダー

課金対象のレスポンスおよびレート制限の取得には、以下のヘッダーが含まれます。

ヘッダー	説明
`X-RateLimit-Limit`	このプリンシパルに対する現在のウィンドウ内の利用可能ポイント数
`X-RateLimit-Remaining`	現在のウィンドウ内の残りポイント数
`X-RateLimit-Used`	現在のウィンドウ内で消費されたポイント数
`X-RateLimit-Reset`	ウィンドウがリセットされる Unix タイムスタンプ (UTC秒)
`X-RateLimit-Resource`	共有パブリック API の予算では常に `core`

X-RateLimit-Reset は、レスポンス時点から60秒間のウィンドウを示します。カウンターのウィンドウは、暦上の分の境界ではなく、バースト内で最初に課金対象となるリクエスト時に開始されます。

上限を超えた場合

リクエストが予算を超過する場合、API は次の内容とともに HTTP 429 を返します。

Retry-After: 再試行までの待機時間 (秒) (60)
X-RateLimit-Remaining が 0 に設定された同じ X-RateLimit-* ヘッダー

{  "code": 8,  "message": "Rate limit exceeded: 3000 points per minute for this installation. Retry after 60s.",  "details": []}

再試行する前に、Retry-After の時間が経過するか、X-RateLimit-Reset の時刻になるまで待機してください。複数の呼び出し元で1つのインストールトークンを共有する場合は、ジッターを加えたバックオフを使用してください。

残りのクォータを確認する

ポイントを消費せずに現在の予算を確認するには、レート制限の取得を呼び出します。レスポンス本文には、共有 core リソースの X-RateLimit-* ヘッダーと同じ内容が含まれます。

共通の規約

ページネーション

ページネーション対応のエンドポイントでは、以下を受け付けます。

pageSize: デフォルトは30で、最大100です。
pageToken: 前のページで返される不透明なトークンです。内容を確認したり、生成したりしないでください。

レスポンスでは、リソース固有のコレクションフィールドとnextPageTokenを使用します。次のページがない場合、nextPageTokenは空になります。公開リストのレスポンスには合計件数は含まれません。ページトークンは、元のリソースとフィルターに紐づきます。フィルターを変更した場合は、ページネーションをやり直してください。空でない無効なトークンや一致しないトークンの場合は、400が返されます。

一連のリクエストでは、続きのページを取得するリクエストも含め、すべてのリクエストで同じpageSizeを送信してください。ほとんどのリストエンドポイントでは、ページトークンとともに送信されたpageSizeがそのページに適用され、省略した場合は前のページサイズが維持されます。これに該当するエンドポイントでは、pageTokenのエントリにその旨が記載されています。それ以外のエンドポイントはページトークンが保持する内容が異なるため、pageSizeを常に同じ値にしておけば、どのエンドポイントでも同じページサイズで結果を取得できます。

エラー

エラーの本文には、Google RPC スタイルの形式を使用します。

{  "code": 5,  "message": "resource not found",  "details": []}

一般的な HTTP ステータスは 400、401、403、404、429、500、503 です。一部の Git データベース操作では、リポジトリの状態競合に対して 409 も返されます。429 のヘッダーと再試行の挙動については、レート制限を参照してください。

エラーの処理を分岐するには、HTTP ステータスと code を使用します。message は開発者向けのテキストとして扱います。

404 は、存在しないリソースとアプリが到達できないリソースを区別しません。リソースが存在しない証拠ではなく、"このインストールでは利用できない"ものとして解釈してください。

details には型付きエントリが含まれます。無効な引数には google.rpc.BadRequest のフィールド違反、すべてのエラーには google.rpc.RequestInfo エントリが含まれます。Origin はいつでも詳細タイプを追加できるため、連携で認識できないエントリは無視してください。

すべてのエラーレスポンスには、リクエスト ID が 2 か所に含まれます。X-Request-ID レスポンスヘッダーと、details 内の google.rpc.RequestInfo エントリです。Origin は送信した x-request-id をエコーし、送信しなかった場合は生成します。message が不透明な内部エラーの場合でも RequestInfo エントリは存在するため、呼び出しの失敗について Cherri Code に問い合わせる際はリクエスト ID を伝えてください。

/v1/origin 配下で一致しないパスと、既知のパスに対して誤ったメソッドを使用するリクエストは、汎用ルーターエラーではなく同じ本文を返します。メッセージにはメソッドとパスが含まれ、クエリ文字列がエコーされることはありません。

ID

リソース ID は、型を示すプレフィックスが付いた不透明な文字列です。たとえば、アプリの ID は app_…、インストールの ID は i_… で始まります。ID は文字列全体として保存・比較してください。ID を解析したり、文字から意味を読み取ったり、ソート順に依存したりしないでください。

名前や slug は変更される可能性がありますが、ID はリソースが存在する限り変わりません。リポジトリは名前を変更しても同じ ID を保持するため、キャッシュしたデータのキーには {ownerSlug}/{repoName} ではなく ID を使用してください。また、リポジトリパスで説明しているとおり、リポジトリは ID で指定してください。

リポジトリパス

リポジトリスコープのパスでは、所有者スラッグとリポジトリ名を {ownerSlug}/{repoName} の形式で指定します。両方のセグメントは大文字と小文字を区別せずに解決されるため、どの表記でもリポジトリを指定できます。レスポンスでは、送信した表記ではなく保存されている名前とスラッグが返され、Git HTTPS URLも同様に解決されます。リポジトリ名は大文字と小文字を区別せずに比較し、正規の表記は Get Repo から取得してください。

すべてのリポジトリスコープのパスでは、所有者スラッグとリポジトリ名の組み合わせの代わりに、リポジトリの安定 ID も使用できます。GET /v1/origin/repos/_/REPO_ID のように、所有者スラッグとして _ を、リポジトリ名として ID を送信します。ID は Get Repo の id フィールドから取得してください。センチネル _ は所有者スラッグとして使用できないため、2 つの形式が衝突することはありません。Connect または JSON リクエストでは、ownerSlug を _ に、name を ID に設定します。

ID 形式は名前変更後も有効なため、リポジトリを指定する安定した方法です。ID 自体が権限を付与することはありません。Origin が ID をリポジトリに解決した後も、アプリにはそのリポジトリに対する同じスコープが必要です。アプリがアクセスできない ID は、存在しない ID と同じ 404 本文を返すため、レスポンスからリポジトリの存在を確認することはできません。不正な形式の ID は 400 を返します。Create Repo は所有者スラッグのみを受け取り、_ を拒否します。

リソースリファレンス

リソーススナップショットには、リソースの現在のフィールドが含まれます。コンテナコンテキストでは、リソース全体を重複して保持する代わりに、簡潔なリファレンスを使用します。

RepositoryReference はリポジトリを識別します。
PullRequestReference はプルリクエストを識別し、そのリポジトリリファレンスをネストします。
ThreadReference はプルリクエストコメントを含むスレッドを識別します。
OriginActor は公開actorを user、app、または serviceAccount のいずれかとして識別します。存在するバリアントは必ず1つです。そのバリアントからIDを読み取ってください。

チェック実行

Apps は Post Check Run と Batch Upsert Check Runs を使って、commit に対する CI の結果をチェックスイートおよびチェック実行として報告し、Checks エンドポイントで読み取ります。このセクションでは、これらのエンドポイントに共通する用語、すなわちどの試行が現在のものか、オリジンが書き込みをどのように順序付けて報告するか、タイムスタンプと期限がどのように扱われるかを定義します。

試行と現在の試行

コミットに対して報告される (actor, key, externalId) の組み合わせが 1 つのスイート試行となり、その中の (suite, key, externalId) が 1 つの実行試行となります。同じ externalId を再利用すると、その試行がその場で更新されます。新しい externalId を指定すると新しい試行が開始され、以前の試行は履歴として保持されます。置き換えられた試行も、Get Check Suite と Get Check Run で id を指定すれば引き続き読み取れます。

API がコミットの現在のチェックを示す箇所、つまり List Check Suites For Commit、List Check Runs For Commit、およびプルリクエストの CI 状態と必須チェックでは、オリジンは次の 2 段階で試行を集約します。

(actor, key) ごとの現在のスイート試行は、第 2 段階で選ばれた配下の現在の実行が最も新しい externalUpdatedAt を持つものです。実行を持たないスイートは自身の createdAt で順位付けされます。同値の場合はスイートの createdAt、次に id の順で、新しいものが優先されます。
そのスイート試行の中で、ある key の現在の実行は、最も新しい externalUpdatedAt を持つものです。同値の場合は createdAt、次に id の順で、新しいものが優先されます。

List Check Runs For Suite は、指定したスイートに対して第 2 段階のみを適用します。実行がそのコミットにとって現在のものとなるのは、その実行が属するスイートがコミットの現在のスイート試行である場合に限られます。第 1 段階ではスイート試行全体が順位付けされるため、置き換えられたスイート試行の下に投稿された実行は、別の試行がより新しい externalUpdatedAt を持っている間はコミットのチェックに表示されません。そのタイムスタンプが最新になった時点で、そのスイート試行が現在のものとなり、代わりにもう一方の試行の実行が非表示になります。

キャンセルされた試行が、成功した試行を置き換えることはありません。どちらの段階でも、同じ key のキャンセルされていない試行のうち最新のものが成功している場合、キャンセルされた試行はその key の他の試行より下位に順位付けされます。実行が成功とみなされるのは、completed であり、結論が success、neutral、skipped のいずれかである場合です。スイート試行が成功とみなされるのは、その現在の実行がすべて成功した場合です。また、現在の実行がすべて completed で、少なくとも 1 つの結論が cancelled、残りがすべて成功である場合、そのスイート試行はキャンセル済みとみなされます。成功した試行の再実行が要求された場合、externalUpdatedAt が要求時点以降であるキャンセル済みの試行は、再びタイムスタンプに基づいて順位付けされます。なお、より新しいキャンセル済みのスイート試行は、完全には成功していない古いスイート試行を引き続き置き換えます。

再実行が要求された実行は、その key の現在の試行としての位置を保ち、所有するアプリが応答するまで保留中として読み取られます。Rerequest Check Run を参照してください。

書き込みの順序付け

オリジンは、1つの実行 (スイート内で同じ externalId と key) への投稿を、ミリ秒精度の checkRun.externalUpdatedAt で順序付けします。投稿が適用されるのは、その値が実行に保存された externalUpdatedAt (再リクエストが未処理の間は rerequestedAt まで引き上げられます) 以降である場合のみです。値が等しい場合も適用されるため、後から投稿された方が優先されますが、同様に stale として扱われる例外が2つあります。すなわち、queued または in_progress の投稿は同一タイムスタンプで completed の実行を再オープンできません。また rerequestedAt が設定されている間は、保存されたタイムスタンプとちょうど一致する投稿は無視されます。より新しい値は適用され、completed の実行の再オープンも行われますが、タイムスタンプにかかわらず stale として扱われる例外が1つあります。conclusion が cancelled の completed の投稿は、conclusion が success、neutral、または skipped の completed の実行を置き換えることはできません。

stale な投稿でも成功します。レスポンスは HTTP 200 で、投稿された値ではなく保存されているスイートと実行が返り、実行の updatedAt は変化しません。投稿された各実行は、呼び出し後の保存済み実行である checkRun と、その書き込みが何を行ったかを示す outcome のペアとして返されます。Post Check Run はこのペアをレスポンスのトップレベル、checkSuite の隣に返します。Batch Upsert Check Runs は、投稿された実行ごとに1つのペアを results[] にリクエスト順で返すため、バッチの各要素は単一呼び出しがインラインで返すのと同じ実行ごとの結果を保持します。書き込みが何を行ったかは、outcome、または各 results[].outcome を読んで確認してください。

`outcome`	意味
`created`	スイート内に `(externalId, key)` に対応する実行が存在せず、新たに作成されました。
`updated`	既存の実行が投稿された値で置き換えられました。
`unchanged`	`externalUpdatedAt` を含む投稿された値が保存済みの実行と等しく、何も書き込まれませんでした。
`ignored_stale`	投稿は stale として無視されました。`checkRun` には投稿された値ではなく保存済みの実行が入ります。

unchanged または ignored_stale の投稿では updatedAt は進まないため、この2つを区別することはできません。区別できるのは outcome だけです。認識できない値は「保存済みの実行がレスポンスに入っているが、書き込まれたかどうかは不明」として扱ってください。バッチでは、オリジンはこのルールを各実行に個別に適用します。stale な実行があってもバッチは失敗せず、results[] のその実行のスロットには保存済みの実行が入り、outcome は ignored_stale になります。

Batch Upsert Check Runs では、トップレベルの checkRuns[] は非推奨であり、results[] の使用が推奨されます。同じ保存済み実行が同じ順序で引き続き入りますが、outcome は含まれません。代わりに results[] を読んでください。これはバッチにのみ該当します。Post Check Run では、読むべきトップレベルのフィールドは checkRun と outcome です。

タイムスタンプと期限

externalUpdatedAt、startedAt、completedAt のいずれかが60秒を超えて未来を指す投稿は InvalidArgument (HTTP 400) を返します。同一の投稿に両方が含まれる場合、completedAt は startedAt より前であってはなりません。deadlineAt は24時間を超えて未来であってはなりません。

期限切れになるのは in_progress の実行だけです。deadlineAt を過ぎると、定期的なスイープがその実行を結論 timed_out で完了させ、実行に未設定であれば completedAt を設定し、deadlineAt をクリアして、repository.check_run.completed を配信します。期限切れは期限ちょうどではなく数分後に発生します。スイープは既定で約30分ごとに実行されますが、これは変更され得る運用上の設定のため、この間隔に依存しないでください。queued の実行は期限切れになりません。deadlineAt のない実行も同様です。completed の投稿は期限をクリアします。オリジンは実行をタイムアウトさせる際に externalUpdatedAt を変更しないため、より新しい externalUpdatedAt を持つ後続の投稿は、タイムアウトした実行にも引き続き適用されます。

現在の制限事項

名前空間全体でのリポジトリ一覧取得とリポジトリ作成は、パートナー API ではサポートされていません。リポジトリはインストール経由で検出してください。
コミット比較では、埋め込みのコミット一覧ではなく、要約データが返されます。変更されたファイルには、専用のページネーション対応のエンドポイント比較ファイルの一覧があります。
スレッドは解決時にのみ指定できます。スレッドを直接一覧表示するエンドポイントはないため、含まれるコメントから読み取ってください。
プッシュ Webhook には完全なコミット一覧は含まれません。
プルリクエストのマージはネイティブのオリジンリポジトリでのみサポートされます。ミラーリポジトリは拒否されます。
ミラーリポジトリは、安定したアウトバウンドミラーになるまで、インストールでは参照専用です。ミラーリポジトリを参照してください。

実装チェックリスト

Ed25519 秘密鍵はシークレットマネージャーに保存し、意図的にローテーションします。アプリの署名キーを生成を参照してください。
インストールコールバックでインストールレシートを確認し、そのクレームからインストール ID と state を読み取ります。
短期有効な app JWT を使用し、必要なタイミングでインストールトークンを発行します。
リポジトリスコープの API、チェック実行の書き込み、Git HTTPS には、app JWT ではなくインストールトークンを使用します。
要求するスコープとリポジトリアクセスは最小限にします。
ページトークンは不透明なものとして扱い、フィルターを変更した場合はページネーションを最初からやり直します。
チェックの key 値は安定していて読みやすいものにします。再試行ごとに新しい不変の externalId を使用し、更新時にはより大きい externalUpdatedAt 値を使用します。
Post Check Run のレスポンスごとに outcome を、Batch Upsert Check Runs のレスポンスごとに各 results[].outcome を読み取ります。古い投稿の場合は、保存済みの実行とともに 200 が返されます。チェック実行を参照してください。
解析前に、生のリクエスト本文を使用して webhook 署名を確認します。
webhook-id を使用して配信を重複排除し、2xx を返した後に非同期で処理します。
将来の互換性のため、未知の JSON フィールドは無視します。

Retry-After と X-RateLimit-* ヘッダーの指示に従います。ポイントを消費せずに残りのポイントを監視するには、レート制限を取得を使用します。

エンドポイントリファレンス

すべてのコンポーネントスキーマについては、OpenAPI specification をダウンロードしてください。このドキュメントでは、サーバーとして https://api.cursor.com を宣言し、bearerAuth HTTP Bearer セキュリティスキームを定義しています。また、各操作には、その操作が返しうるレスポンスコードと、リクエストおよびレスポンスの例が記載されています。すべての操作には x-origin-scopes 拡張も付いており、scopes にはその操作が必要とするスコープ、tokenTypes には受け入れる認証情報の種類が入ります。各 webhook のペイロードスキーマには、そのペイロードを配信するイベントを列挙した x-origin-webhook-events 拡張が付いており、プレビューの機能には x-cursor-visibility: PREVIEW が付いています。パスパラメータには、URL で使用されるものと同じ ownerSlug と repoName という名前が付けられています。すべての操作には一意の operationId が付いており、1 つの操作が 2 つの URL 形式に対応する場合、2 番目の形式の id には OriginService_GetRepoTarball_2 のように _2 のサフィックスが付きます。

JSON スニペットには、スキーマに沿ったプレースホルダー値が示されています。レスポンスフィールドの説明は、OpenAPI スキーマと現在のプラットフォーム契約を反映しています。

アプリとインストール

レート制限を取得

GET/v1/origin/rate_limit

AuthApp JWTInstallation tokenUser access token

認証済みプリンシパルの現在のパブリック API レート制限のステータスを返します。

このエンドポイントにアクセスしても、レート制限ポイントは消費されません。レスポンスには、このプリンシパルの他のパブリック API エンドポイントと共有される1分あたりのポイント予算が含まれます。レート制限を参照してください。

レスポンスフィールド

resources オブジェクト

認証済みプリンシパルのレート制限リソース。

resources.core オブジェクト

パブリック API エンドポイントで共有される1分あたりのポイント予算。

resources.core.limit integer

現在のウィンドウで利用可能な最大ポイント数。

resources.core.remaining integer

現在のウィンドウの残りポイント数。

resources.core.reset integer

現在のウィンドウがリセットされる Unix タイムスタンプ (UTC秒) 。

resources.core.used integer

現在のウィンドウで消費されたポイント数。

rate オブジェクト

resources.core の別名です。新しいクライアントでは resources.core を使用してください。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/rate_limit' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "resources": {    "core": {      "limit": 6000,      "remaining": 5994,      "reset": 1785682800,      "used": 6    }  },  "rate": {    "limit": 6000,    "remaining": 5994,    "reset": 1785682800,    "used": 6  }}

認証済みアプリを取得

GET/v1/origin/app

AuthApp JWT

認証済みアプリのメタデータを返します。

レスポンスフィールド

id 文字列

JWT の発行者およびキー ID として使用される Origin アプリの識別子。

displayName 文字列

人が読みやすいアプリの表示名。

webhookUrl 文字列

アプリの Webhook 配信を受信する、登録済みの HTTPS URL。

events 配列

アプリに設定された Webhook イベントのサブスクリプション。installation.* イベントは常に配信されるため、ここには含まれません。

createdAt 文字列

アプリ作成時の RFC 3339 タイムスタンプ。

updatedAt 文字列

最新のアプリメタデータ更新時の RFC 3339 タイムスタンプ。

installationRedirectUris 配列

登録済みのインストールコールバック URI。ローカル以外のコールバックは完全に一致し、HTTPS を使用する必要があります。

namespaceSlug 文字列

アプリを所有する namespace の slug。

description 文字列

publisher が指定したアプリの説明。未設定の場合は空です。

websiteUrl 文字列

publisher の Web サイト。未設定の場合は空です。

defaultScopes 配列

アプリのインストール時に提示されるデフォルトの scope。カタログの scope 文字列として指定されます。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/app' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "app_01k2ja2000e0080000000000a1",  "displayName": "CI Status Bot",  "webhookUrl": "https://ci.acme.dev/webhooks/origin",  "events": [    "pull_request.created",    "pull_request.merged"  ],  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "installationRedirectUris": [    "https://ci.acme.dev/origin/setup"  ],  "namespaceSlug": "acme",  "description": "Posts CI status on pull requests.",  "websiteUrl": "https://ci.acme.dev",  "defaultScopes": [    "repository:contents:read",    "repository:pull_requests:read"  ]}

アプリのインストール一覧

GET/v1/origin/app/installations

AuthApp JWT

認証済みアプリのインストールを一覧表示します。

クエリパラメータ

pageSize 整数

返されるインストールの最大数。未設定または0の場合はデフォルトで30になり、100を超える値は100に制限されます。

pageToken 文字列

前回のレスポンスのnext_page_tokenによる不透明なカーソル。最初のページでは空です。

レスポンスフィールド

installations 配列

認証済みアプリが所有するインストールのページです。

installations[].id 文字列

アプリが保存し、インストール用アクセストークンの発行に使用するインストール識別子。

installations[].appId 文字列

インストール済みアプリの識別子です。

installations[].target オブジェクト

このインストールのために顧客が選択した所有者。

installations[].target.slug 文字列

リポジトリ所有者を識別するために所有者IDとともに使用される、URL 表示用のオーナースラッグです。

installations[].target.id 文字列

オリジン所有者の識別子。

installations[].target.type 文字列

所有者の名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

installations[].createdAt 文字列

RFC 3339 形式のインストール作成タイムスタンプ。

installations[].updatedAt 文字列

最新のインストール更新のRFC3339タイムスタンプ。

installations[].repoSelectionMode 文字列

リポジトリ付与モード: 完全(all)または選択(selected)のいずれか。

installations[].scopes 配列

インストールに対して承認されたスコープです。

installations[].installedBy オブジェクト

直近の再同意を行った主体ではなく、アプリを最初にインストールしたユーザー。出力専用。そのユーザーレコードが読み取れなくなった場合は存在しません。

installations[].installedBy.id 文字列

ユーザーの公開識別子です。user_ のプレフィックスが付きます。

installations[].installedBy.email 文字列

ユーザーのメールアドレスです。

installations[].installedBy.displayName 文字列

ユーザーの表示名。アカウントの名と姓をスペースで連結したもので、製品が表示する名前と同じです。アカウントに名前がない場合は省略されます。

installations[].installedBy.handle 文字列

ユーザーが主張するプロフィールのハンドル。@ プレフィックスは含みません。プロフィールが公開されている間のみ表示され、それ以外の場合は省略されます。

installations[].suspendedAt 文字列

インストールが停止されている間に設定される RFC 3339 形式のタイムスタンプ。インストールが有効な間は省略されます。

installations[].deletedAt 文字列

インストール削除のRFC3339タイムスタンプ。installation.deleted の webhook snapshot にのみ含まれます。削除されたインストールはAPIから解決できなくなるため、この endpoint がこの値を返すことはありません。

nextPageToken 文字列

次のページ用の不透明なカーソル。これ以上ページがない場合は空になります。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/app/installations' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "installations": [    {      "id": "inst_01k2ja2000e0080000000000b2",      "appId": "app_01k2ja2000e0080000000000a1",      "target": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      },      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "repoSelectionMode": "selected",      "scopes": [        "repository:contents:read",        "repository:pull_requests:read"      ]    }  ]}

アプリのインストールを取得

GET/v1/origin/app/installations/{installationId}

AuthApp JWT

認証済みアプリのインストールを1件取得します。

repoSelectionMode は all または selected です。

パスパラメータ

installationId 文字列必須

インストール識別子。

レスポンスフィールド

id 文字列

アプリが保存し、インストールアクセストークンの発行に使用するインストール識別子。

appId 文字列

インストールされたアプリの識別子。

target オブジェクト

このインストールのために顧客が選択した所有者。

target.slug 文字列

リポジトリ所有者を識別するために所有者 ID とともに使用する、URL 向けの所有者スラッグ。

target.id 文字列

Origin の所有者識別子。

target.type 文字列

所有者の名前空間の種類。出力専用。許容される値: team、user。不明な場合は省略されます。

createdAt 文字列

RFC 3339 形式のインストール作成タイムスタンプ。

updatedAt 文字列

最新のインストール更新の RFC 3339 タイムスタンプ。

repoSelectionMode 文字列

リポジトリ付与モード。厳密に "all" または "selected" のいずれかです。

scopes 配列

インストールに対して承認されたスコープ。

installedBy オブジェクト

直近の再同意を行ったユーザーではなく、元々アプリをインストールしたユーザー。出力専用。そのユーザーレコードを読み取れなくなった場合は存在しません。

installedBy.id 文字列

user_ プレフィックスが付いたユーザーの公開識別子。

installedBy.email 文字列

ユーザーのメールアドレス。

installedBy.displayName 文字列

ユーザーの表示名。アカウントの名と姓をスペースで連結したもので、製品が表示する名前と同じです。アカウントに名前が設定されていない場合は省略されます。

installedBy.handle 文字列

@ プレフィックスを除く、ユーザーが申告したプロフィールハンドル。プロフィールが公開されている間のみ存在し、それ以外の場合は省略されます。

suspendedAt 文字列

インストールが一時停止されている間に設定される RFC 3339 タイムスタンプ。インストールが有効な間は省略されます。

deletedAt 文字列

インストール削除の RFC 3339 タイムスタンプ。installation.deleted webhook の snapshot にのみ含まれます。削除済みのインストールは API 経由で解決されなくなるため、この endpoint がこの値を返すことはありません。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/app/installations/INSTALLATION_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "inst_01k2ja2000e0080000000000b2",  "appId": "app_01k2ja2000e0080000000000a1",  "target": {    "slug": "acme",    "id": "ns_01k2ja2000e0080000000000p3",    "type": "team"  },  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "repoSelectionMode": "selected",  "scopes": [    "repository:contents:read",    "repository:pull_requests:read"  ]}

アプリのインストールを削除

DELETE/v1/origin/app/installations/{installationId}

AuthApp JWT

認証済みアプリに属するインストールを削除し、新しいインストールトークンが発行されないようにします。すでに発行された短期間有効なトークンは、有効期限が切れるまで (最長 15 分間) 有効な場合があります。レスポンス本文は空です。

パスパラメータ

installationId 文字列必須

削除するインストールの一意の識別子です。URL パスから取得されます。インストールは認証済みアプリに属している必要があります。

レスポンスフィールド

成功したリクエストではレスポンス本文は返されません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/app/installations/INSTALLATION_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンス:

204 No Content

インストールアクセストークンを作成

POST/v1/origin/app/installations/{installationId}/access_tokens

AuthApp JWT

認証済みアプリ用のインストールアクセストークンを作成します。

GetAuthenticatedApp と同様に、app signing-JWT による認証が必要です。トークンは指定したインストールに限定され、そのインストールは認証済みアプリに属している必要があります。呼び出し元は、トークンをインストールで許可されているスコープとアクセス可能なリポジトリの一部に限定できます。

repositoryIds にはミラーリポジトリを指定できます。生成されるトークンにはインストールのスコープが付与され、Origin は各リクエストにミラーの上限を引き続き適用します。詳細はミラーリポジトリを参照してください。

パスパラメータ

installationId 文字列必須

トークンの対象とするインストールの一意の識別子です。URL パスから取得されます。インストールは認証済みアプリに属している必要があります。

リクエスト本文

scopes 配列

トークンに付与するスコープ文字列です。値は重複せず、インストールで許可されているスコープに含まれている必要があります。空または省略した場合は、許可されているすべてのスコープが適用されます。

repositoryIds 配列

トークンに付与するリポジトリ ID です。値は重複せず、インストールからアクセス可能で、最大 50 件までにする必要があります。空または省略した場合は、アクセス可能なすべてのリポジトリが適用されます。

レスポンスフィールド

token 文字列

oit_ プレフィックスを持つ有効期間の短いインストール認証情報です。

expiresAt 文字列

RFC 3339 形式の有効期限です。トークンは最長 15 分で期限切れとなり、発行に使用した app JWT より長く有効であることはありません。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/app/installations/INSTALLATION_ID/access_tokens' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "scopes": [    "repository:contents:read",    "repository:pull_requests:read"  ],  "repositoryIds": [    "repo_01k2ja2000e0080000000000q4"  ]}'

レスポンスの構造:

{  "token": "oit_2v8xkq4m1c7p9t3w5y0z6r4b",  "expiresAt": "2026-08-01T10:30:00Z"}

インストールユーザートークンの作成

POST/v1/origin/app/installations/{installationId}/user_access_tokens

Installation scopenamespace:user_tokens:writeAuthApp JWT

インストールの名前空間に属するメンバーの代理として動作するインストールユーザートークンを作成します。

インストールは認証済みアプリに属し、namespace:user_tokens:write を承認済みである必要があります。ユーザーは userId または userEmail のどちらか一方だけで指定してください。ユーザーが見つからない、複数のユーザーに該当する、または利用対象外の場合、どの条件に該当したかを明かさずに PermissionDenied (HTTP 403) を返します。

トークンのアクセス権は、インストールとユーザーの両方が持つ権限に限定されます。scopes と repositoryIds の両方を設定した場合、指定したすべてのリポジトリで、各スコープがインストールとユーザーの両方に許可されている必要があります。満たさない場合は PermissionDenied (HTTP 403) を返します。詳しい手順は、ユーザーの代理として操作するを参照してください。

パスパラメータ

installationId string 必須

トークンの対象となるインストールの一意の識別子。URL パスから取得されます。インストールは認証済みアプリに属している必要があります。

リクエスト本文

userId string

アクターのペイロードで返される、ユーザーの user_… ID。userId と userEmail のどちらか一方だけを設定してください。

userEmail string

ユーザーのアカウントのメールアドレス。利用対象となる名前空間のメンバー 1 人だけと一致する必要があります。

scopes array

トークンのスコープを制限する文字列。値は重複せず、インストールが承認したスコープに含まれている必要があります。namespace:user_tokens:write を要求すると InvalidArgument (HTTP 400) が返されます。このスコープはトークンの発行を許可するもので、トークンには委譲できません。空または省略した場合、スコープによる制限は追加されません。

repositoryIds array

トークンの対象を制限するリポジトリ ID。重複は認められず、インストールからアクセスできるリポジトリの ID を最大 50 エントリまで指定できます。空または省略した場合、リポジトリによる制限は追加されません。

レスポンスフィールド

token string

短期有効のインストールユーザートークン。シークレットとして扱い、ログに記録しないでください。

expiresAt string

RFC 3339 形式の有効期限。トークンは最大 15 分で失効し、発行に使用したアプリ JWT より長く有効になることはありません。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/app/installations/INSTALLATION_ID/user_access_tokens' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "userId": "user_01k2ja2000e0080000000000c3",  "scopes": [    "repository:pull_requests:reviews:write"  ],  "repositoryIds": [    "repo_01k2ja2000e0080000000000q4"  ]}'

レスポンスの構造：

{  "token": "YOUR_INSTALLATION_USER_TOKEN",  "expiresAt": "2026-08-01T10:30:00Z"}

アプリのインストール用リポジトリ一覧

GET/v1/origin/installation/repos

AuthInstallation token

認証済みアプリのインストールがアクセス可能なリポジトリを一覧表示します。

CreateInstallationAccessToken で発行されたインストールアクセストークン (oit_) が必要です。

パートナーはこのエンドポイントを通じてリポジトリを発見します。一覧の各項目は簡略化されたリポジトリの概要です。完全なタイムスタンプについては Get Repo を使用してください。Get Repo には出力専用の cloneUrl が含まれます。

結果にはミラーリポジトリが含まれます。ミラーは安定したアウトバウンドミラーになるまで読み取り専用です。ミラーリポジトリを参照してください。

クエリパラメータ

pageSize 整数

返すリポジトリの最大数。未設定または0の場合はデフォルトで30になります。100を超える値は100に制限されます。

pageToken 文字列

前のレスポンスのnext_page_tokenに由来する不透明なカーソル。最初のページでは空です。後続のページをリクエストする際は同じフィルタを使用する必要があります。後続のリクエストでpageSizeを指定すると、そのページにのみ適用されます。前のページサイズを引き継ぐ場合は省略してください。

filter 文字列

リポジトリ名とオーナーの namespace に適用される、大文字・小文字を区別しない部分一致フィルター (任意)。スラッシュ 1 つの owner/repo 形式の値は、前後それぞれを対応するフィールドと照合します。先頭と末尾の空白は無視され、空の値の場合はフィルターが適用されません。

レスポンスフィールド

repositories 配列

簡略化されたリポジトリの概要。完全なタイムスタンプは get-repository を使用してください。

repositories[].id 文字列

Origin リポジトリ識別子。

repositories[].name 文字列

所有者内のリポジトリ名。

repositories[].fullName 文字列

acme/api のように、所有者名とリポジトリ名を組み合わせた名前。

repositories[].owner オブジェクト

リポジトリのオーナー参照。

repositories[].owner.slug 文字列

リポジトリ所有者を識別するために所有者IDとともに使用される、URL表示用の所有者スラッグ。

repositories[].owner.id 文字列

オリジン所有者識別子。

repositories[].owner.type 文字列

所有者の名前空間タイプ。出力専用。許容値: team、user。不明な場合は省略されます。

repositories[].defaultBranch 文字列

リポジトリのデフォルトブランチ名。

repositories[].mirror オブジェクト

ミラーのメタデータ。ネイティブリポジトリとミラーの初回同期が準備できる前は存在しません。

repositories[].mirror.source 文字列

ミラー元。指定可能な値: github。

repositories[].mirror.sourceId 文字列

ソースによって割り当てられた不透明なリポジトリ識別子。

repositories[].mirror.status 文字列

移行中 (カットオーバー完了まで) の実効ミラー方向。許可される値: inbound、outbound。

repositories[].visibility 文字列

リポジトリの可視性。許可される値: internal、private。

repositories[].allowMergeCommit ブール値

プルリクエストをマージコミットとして取り込めるかどうか。

repositories[].allowSquashMerge boolean

プルリクエストをスカッシュマージとしてマージできるかどうか。

repositories[].deleteBranchOnMerge ブール値

マージ時にヘッドブランチを自動的に削除するかどうか。

nextPageToken 文字列

次ページ用の不透明なカーソル。これ以上ページがない場合は空です。

repoSelectionMode 文字列

インストールがすべてのリポジトリに対して権限を付与するか、選択したリポジトリのみに付与するかを報告します。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/installation/repos' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "repositories": [    {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "fullName": "acme/rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      },      "defaultBranch": "main",      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "pushedAt": "2026-08-02T14:45:00Z",      "cloneUrl": "https://origin.cursor.com/git/acme/rocket.git"    }  ],  "repoSelectionMode": "selected"}

Webhook配信の一覧

GET/v1/origin/app/webhook/deliveries

AuthApp JWT

認証済みアプリのWebhook配信を新しい順に一覧表示します。

配信とは、1つのアプリに対して発生する単一のイベントです。ID は受信者が見る webhook-id ヘッダーの値です。delivered=false はリカバリ述語で、障害によりリトライ階段が尽きた配信を含め、2xx を一度も受け取ったことのないすべての配信を選択します。

配信は作成後7日間、かつアプリが配信の名前空間に有効なインストールを持っている間のみ一覧表示できます。installation.deleted のようなアプリを対象とするライフサイクルイベントは、それが説明するアンインストール後も表示されたままになります。

クエリパラメータ

delivered 真偽値

delivered_atと比較します。delivered=falseはリカバリ述語で、サーバー側で評価されるため、呼び出し元が指定する時間窓のように、障害の途中で再試行の階段が尽きた配信を見逃すことはありません。

eventType 文字列

完全一致するイベントタイプ。例: pull_request.created。

installationId 文字列

1つのインストールに絞り込みます (WebhookDelivery.installation.id) 。

createdAfter 文字列

配信の作成時刻で絞り込みます。閲覧用であり、復旧用ではありません。

createdBefore 文字列

pageSize 整数

未設定または0の場合はデフォルトで30になります。100を超える値は100に制限されます。

pageToken 文字列

前のレスポンスのnext_page_tokenに由来する不透明なカーソル。最初のページでは空です。

レスポンスフィールド

deliveries 配列

認証済みアプリのWebhook配信 (新しい順) 。各配信IDは受信者に表示されるwebhook-idです。

deliveries[].id 文字列

安定した配信識別子であり、受信者に表示される webhook-id の値です。冪等性キーとして使用してください。

deliveries[].event オブジェクト

この配信が運ぶイベント。

deliveries[].event.id 文字列

基となる Origin イベントの識別子です。安定した配信 ID と共に存在する場合がありますが、冪等性キーではありません。

deliveries[].event.type 文字列

ルーティングのために配信に含まれるイベントスラッグ。

deliveries[].installation オブジェクト

この配信が属するインストール。id は対象オーナーの現在アクティブなインストールを示します。存在しない場合は未設定になります (アンインストール後のアプリ対象ライフサイクルイベントでのみ発生します) 。

deliveries[].installation.id 文字列

Webhook配信リスト項目に関連付けられたインストール識別子。

deliveries[].installation.target オブジェクト

インストールの対象となる所有者。

deliveries[].installation.target.slug 文字列

リポジトリ所有者を識別するために所有者IDとともに使用される、URL 表示用のオーナースラッグ。

deliveries[].installation.target.id 文字列

オリジン所有者の識別子。

deliveries[].installation.target.type 文字列

オーナーの名前空間の種類。出力専用。許可される値: team、user。不明な場合は省略されます。

deliveries[].createdAt 文字列

createdAfter および createdBefore の閲覧フィルターで使用される配信作成タイムスタンプ。

deliveries[].deliveredAt 文字列

未設定は delivered=false に対応します：受信者がこの配信を 2xx レスポンスで一度も確認していません。

deliveries[].lastAttempt オブジェクト

最新の HTTP 試行 (存在する場合) ：レスポンスのステータスコード、レイテンシ、トランスポートエラー、トリガー、および時刻。

deliveries[].lastAttempt.id 文字列

Webhook配信試行の識別子。

deliveries[].lastAttempt.deliveryId 文字列

この試行に関連付けられた安定した配信識別子。

deliveries[].lastAttempt.trigger 文字列

この配達試行が送信された理由。許容される値: automatic、manual。

deliveries[].lastAttempt.responseStatusCode 整数

POSTでHTTPレスポンスが返されなかった場合 (トランスポートエラー、タイムアウト) は未設定になります。

deliveries[].lastAttempt.latencyMs 整数

配信試行のレイテンシ (ミリ秒) 。

deliveries[].lastAttempt.errorMessage 文字列

HTTPレスポンスがない場合のトランスポートエラーの詳細。そうでない場合は空です。

deliveries[].lastAttempt.attemptedAt 文字列

この配信試行のRFC 3339タイムスタンプ。

nextPageToken 文字列

次のページ用の不透明なカーソル。次のページがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/app/webhook/deliveries' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "deliveries": [    {      "id": "whd_01k2ja2000e0080000000000j9",      "event": {        "id": "evt_01k2ja2000e0080000000000r5",        "type": "pull_request.created"      },      "installation": {        "id": "inst_01k2ja2000e0080000000000b2",        "target": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      },      "createdAt": "2026-08-01T09:30:00Z",      "deliveredAt": "2026-08-02T14:45:05Z",      "lastAttempt": {        "id": "wha_01k2ja2000e0080000000000k0",        "deliveryId": "whd_01k2ja2000e0080000000000j9",        "trigger": "automatic",        "responseStatusCode": 200,        "latencyMs": 182,        "attemptedAt": "2026-08-02T14:45:05Z"      }    }  ]}

Webhook配信を一括再配信

POST/v1/origin/app/webhook/deliveries:batchRedeliver

AuthApp JWT

Origin に配信を再送するよう要求します。

このリクエストは「それぞれについて送信処理が進行中であることを確認する」という意味であり、「別の送信を追加する」という意味ではありません。不正なエントリがあってもバッチ全体を失敗させず、一意の入力ごとに1つの結果を返すため、期限切れの ID が1つあっても、復旧ページの残りがブロックされることはありません。202 は送信がキューに入れられたことを意味します。配信自体は非同期のため、結果は Webhook配信を一覧表示でポーリングしてください。

リクエスト本文

deliveryIds 配列必須

再送する配信です。最大100件の一意のエントリを指定でき、Webhook配信を一覧表示の pageSize 上限に対応しています。重複は削除され、最初に出現した順序が維持されます。空のリスト、または一意のエントリが100件を超える場合は、InvalidArgument (HTTP 400) が返されます。

レスポンスフィールド

results 配列

受け付けられた非同期再配信の結果です。一意の配信 ID ごとに1件で、結果は queued、already_in_flight、または not_found です。

results[].deliveryId 文字列

このバッチ結果に対応する、リクエストされた安定した配信 ID です。

results[].outcome 文字列

再配信の結果です。送信が作成された場合は queued、送信がすでに実行中の場合は already_in_flight、それ以外の場合は not_found です。already_in_flight はエラーではなく成功です。not_found には、不明な ID、7日間の保持期間より古い ID、アプリがすでにインストールされていない名前空間が含まれます。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/app/webhook/deliveries:batchRedeliver' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "deliveryIds": [    "whd_01k2ja2000e0080000000000j9"  ]}'

レスポンスの構造:

{  "results": [    {      "deliveryId": "whd_01k2ja2000e0080000000000j9",      "outcome": "queued"    }  ]}

Webhook Ping

POST/v1/origin/app/webhook/pings

AuthApp JWT

認証済みアプリの webhook URL にテスト配信を送信し、受信側からの応答を返します。

実際のイベントを待たずに、アプリの設定中に受信側を確認できます。認証済みアプリを取得と同様に、app signing-JWT による認証が必要です。

受信側には本番環境と同じ形式で送信されます。ヘッダーと、署名キーで検証可能な v1ed 署名が含まれ、webhook-event-type には ping が設定され、ペイロードにはアプリ名が含まれます。ping はどのインストールにも属さないため、webhook-installation-id ヘッダーとエンベロープの installationId はどちらも含まれません。

Origin は ping を同期的に一度だけ送信し、結果をレスポンスで返します。再試行は行われず、ping はドメインイベントではありません。Webhook 配信を一覧表示には表示されず、再配信もできません。受信側が失敗した場合も、エラーではなくレスポンスで報告されます。webhook URL が設定されていないアプリでは FailedPrecondition (HTTP 400) が返されます。

リクエスト本文

リクエストにフィールドはありません。空の JSON オブジェクトを送信します。

レスポンスフィールド

deliveryId 文字列

テスト配信の webhook-id。受信側に送信されたヘッダーの値と一致します。

eventId 文字列

署名付きエンベロープ内のイベント ID。event.id と同じ値です。

delivered boolean

配信タイムアウト前に受信側が 2xx ステータスで応答した場合は true。常に含まれます。

responseStatusCode integer

受信側から返された HTTP ステータス。接続失敗またはタイムアウトにより応答がなかった場合は 0。常に含まれます。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/app/webhook/pings' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{}'

レスポンスの構造:

{  "deliveryId": "whd_01k2ja2000e0080000000000j9",  "eventId": "evt_01k2ja2000e0080000000000r5",  "delivered": true,  "responseStatusCode": 200}

アプリを取得

GET/v1/origin/apps/{appId}

Scopenamespace:apps:readAuthUser access token

identifier を指定して単一のアプリを返します。これはアプリの publisher 向けの管理用 read です。アプリ自身の JWT credential による自己 read は認証済みアプリを取得を使用します。

パスパラメータ

appId string 必須

app_ のプレフィックスが付いたアプリの identifier。

レスポンスフィールド

id string

app_ のプレフィックスが付いた、グローバルに一意なアプリの identifier。

displayName string

ユーザーに表示されるアプリ名。

webhookUrl string

アプリの webhook deliveries を受信する、登録済みの HTTPS URL。アプリが deliveries を受信しない場合は空になります。

events array

アプリに設定された webhook event の subscriptions。installation.* イベントは常に配信され、ここには表示されません。

createdAt string

アプリ作成時の RFC 3339 タイムスタンプ。

updatedAt string

アプリの metadata が最後に更新された RFC 3339 タイムスタンプ。

installationRedirectUris array

OAuth インストール callback の許可リスト。アプリ起点のインストールが戻り先にできるリダイレクト URI で、authorize 時に完全一致で照合されます。

namespaceSlug string

アプリを所有する namespace の slug。

description string

publisher が指定したアプリの説明。未設定の場合は空になります。

websiteUrl string

publisher のウェブサイト。未設定の場合は空になります。

defaultScopes array

アプリのインストール時に提示されるデフォルトの scopes。catalog の scope の string で表されます。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/apps/{appId}' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "app_01k2ja2000e0080000000000a1",  "displayName": "CI Status Bot",  "webhookUrl": "https://ci.acme.dev/webhooks/origin",  "events": [    "pull_request.created",    "pull_request.merged"  ],  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "installationRedirectUris": [    "https://ci.acme.dev/origin/setup"  ],  "namespaceSlug": "acme",  "description": "Posts CI status on pull requests.",  "websiteUrl": "https://ci.acme.dev",  "defaultScopes": [    "repository:contents:read",    "repository:pull_requests:read"  ]}

アプリの更新

PATCH/v1/origin/apps/{appId}

Scopeapp:settings:writeAuthUser access token

アプリの設定を更新します。省略されたフィールドは変更されません。設定可能なフィールドを少なくとも1つ指定する必要があります。空文字列を送信してwebhookUrlをクリアすると、外部へのWebhook配信が無効になり、アプリの保留中の配信がキャンセルされます。URLを再設定しても、キャンセルされた配信は復元されません。

パスパラメータ

appId string 必須

アプリの識別子。app_ のプレフィックスが付きます。

リクエスト本文

displayName string

ユーザーに表示される新しいアプリ名。指定する場合は空にできません。

webhookUrl string

新しいアウトバウンド webhook の配信 URL (絶対 HTTPS URL) 。空文字列を指定すると webhook 配信が無効になり、アプリの保留中の配信はキャンセルされます。

events オブジェクト

Webhook イベントのサブスクリプションを完全に置き換えます。省略した場合は変更されません。

events.events 配列

アプリのWebhookイベントサブスクリプションの新しい完全なセット。空のリストを指定すると、リポジトリのサブスクリプションがすべてクリアされます。installation.* イベントは常に配信され、ここには指定できません。

description string

新しいアプリの説明。省略した場合は変更されません。空文字列を指定するとクリアされます。

websiteUrl string

新しいパブリッシャーのウェブサイト。省略した場合は変更されません。空の文字列を指定すると設定が解除されます。

installationRedirectUris object

OAuth インストールコールバックの許可リストを完全に置き換えます。省略した場合は変更されません。

installationRedirectUris.installationRedirectUris 配列

新しい許可リストの全体。空のリストを指定すると許可リストが解除されます。

defaultScopes オブジェクト

アプリのデフォルトのインストールスコープを丸ごと置き換えます。変更しない場合は省略してください。

defaultScopes.scopes 配列

デフォルトのインストールスコープの新しい完全なセット。空のリストを指定すると設定が解除されます。

レスポンスフィールド

id string

グローバルに一意なアプリ識別子。app_ のプレフィックスが付きます。

displayName string

ユーザーに表示されるアプリ名。

webhookUrl string

アプリの Webhook 配信を受信する、登録済みの HTTPS URL。アプリが配信を受信しない場合は空になります。

events 配列

アプリに設定されている Webhook イベントのサブスクリプション。installation.* イベントは常に配信され、ここには表示されません。

createdAt string

app の作成日時を示す RFC 3339 形式のタイムスタンプ。

updatedAt string

アプリのメタデータが最後に更新された日時の RFC 3339 タイムスタンプ。

installationRedirectUris 配列

OAuth インストールコールバックの許可リスト: アプリ起点のインストールがリダイレクト先として使用できる URI。認可時に完全一致で照合されます。

namespaceSlug string

app を所有する namespace の slug。

description string

パブリッシャーが提供するアプリの説明。未設定の場合は空。

websiteUrl string

出版元のウェブサイト。未設定の場合は空になります。

defaultScopes 配列

アプリのインストール時に提供されるデフォルトのスコープ。カタログのスコープ文字列で指定します。

curl --request PATCH \  --url 'https://api.cursor.com/v1/origin/apps/APP_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "webhookUrl": "https://ci.acme.dev/webhooks/origin-v2",  "events": {    "events": [      "pull_request.created",      "pull_request.merged",      "repository.pushed"    ]  }}'

レスポンスの構造:

{  "id": "app_01k2ja2000e0080000000000a1",  "displayName": "CI Status Bot",  "webhookUrl": "https://ci.acme.dev/webhooks/origin-v2",  "events": [    "pull_request.created",    "pull_request.merged",    "repository.pushed"  ],  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "installationRedirectUris": [    "https://ci.acme.dev/origin/setup"  ],  "namespaceSlug": "acme",  "description": "Posts CI status on pull requests.",  "websiteUrl": "https://ci.acme.dev",  "defaultScopes": [    "repository:contents:read",    "repository:pull_requests:read"  ]}

アプリの署名キーを追加

POST/v1/origin/apps/{appId}/signing_keys

Scopeapp:settings:writeAuthUser access token

アプリに署名キーを追加します。アプリが保持できる有効な署名キーの数には上限があり、上限を超えてキーを追加しようとすると、別のキーが失効されるまで FailedPrecondition (HTTP 400) が返されます。すでに登録済みのキーの場合は AlreadyExists (HTTP 409 Conflict) が返されます。

パスパラメータ

appId 文字列 Required

app_ のプレフィックスが付いたアプリの識別子。

リクエスト本文

publicKey 文字列 Required

アプリの署名キーセットに追加する PEM SPKI 形式の Ed25519 公開鍵。

レスポンスフィールド

kid 文字列

キー ID：キーの SPKI DER エンコーディングの SHA-256 ダイジェストを base64url でエンコードした値。JWT の kid header や、キーの失効に使用します。

createdAt 文字列

キーが登録された日時を示す RFC 3339 形式のタイムスタンプ。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/apps/APP_ID/signing_keys' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "publicKey": "-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEAq9zTf3hL6wXe1cVj0bYs5mKR8uDnG2oAaPp4NiEkKlM=\n-----END PUBLIC KEY-----"}'

レスポンスの構造:

{  "kid": "3q2xW9dK5fJm8vB1nY6cT0aZrQpLh4eGkVsN7uMxOdI",  "createdAt": "2026-08-02T14:45:00Z"}

アプリの署名キーを取り消す

DELETE/v1/origin/apps/{appId}/signing_keys/{kid}

Scopeapp:settings:writeAuthUser access token

キー ID を指定してアプリの署名キーを取り消します。取り消されたキーで署名されたアプリ JWT は認証に使用できなくなります。最後に残った有効な署名キーは取り消せず、そのリクエストは FailedPrecondition (HTTP 400) を返します。レスポンス本文は空です。

パスパラメータ

appId 文字列必須

app_ のプレフィックスが付いたアプリの識別子。

kid 文字列必須

取り消す署名キーのキー ID。

レスポンスフィールド

リクエストが成功した場合、レスポンス本文は返されません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/apps/{appId}/signing_keys/{kid}' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンス:

204 No Content

List 名前空間 Apps

GET/v1/origin/namespaces/{namespaceSlug}/apps

Scopenamespace:apps:readAuthUser access token

名前空間が所有する app を新しい順に一覧します。レスポンスに含まれるのは表示用の metadata のみです。個々の app の webhook 設定を読み取るには Get App を使用してください。

パスパラメータ

namespaceSlug 文字列 Required

app を一覧する名前空間の slug。

Query Parameters

pageSize integer

返す app の最大数。未設定または 0 の場合は 30 になります。100 を超える値は 100 に制限されます。

pageToken 文字列

前回のレスポンスの next_page_token から得られる不透明なカーソル。最初のページでは空です。

レスポンスフィールド

apps 配列

名前空間が所有する app の 1 ページ分。

apps[].id 文字列

グローバルに一意な app 識別子。app_ のプレフィックスが付きます。

apps[].displayName 文字列

ユーザーに表示される app 名。

apps[].description 文字列

publisher が指定した description。未設定の場合は空です。

nextPageToken 文字列

次のページ用の不透明なカーソル。これ以上ページがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/namespaces/{namespaceSlug}/apps' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "apps": [    {      "id": "app_01k2ja2000e0080000000000a1",      "displayName": "CI Status Bot",      "description": "Posts CI status on pull requests."    },    {      "id": "app_01k2ja2000e0080000000000a2",      "displayName": "Deploy Bot",      "description": ""    }  ],  "nextPageToken": ""}

アプリの作成

POST/v1/origin/namespaces/{namespaceSlug}/apps

Scopenamespace:apps:createAuthUser access token

namespace が所有するアプリを作成します。アプリは非公開として作成されます。Ed25519 キーペアはローカルで生成し、公開鍵のみを送信してください。Origin は公開鍵を保存し、アプリの JWT の検証に使用します。webhook URL、イベントタイプ、リダイレクト URI、またはスコープが無効な場合は、InvalidArgument (HTTP 400) が返されます。

リクエスト時点で、名前空間の所有者はOriginへの書き込み要件を満たしている必要があります。これはCreate Repoと同じ要件です。ユーザー所有者の場合は、Pro、Pro Student、Pro+、Ultra、Startのいずれかのプランに加入している必要があります。チーム所有者の場合は、有効な有料チームプランに加入しており、Privacy Mode (Legacy)を使用しておらず、チーム管理者によってOriginが無効化されていない必要があります。要件を満たしていない所有者の場合はFailedPrecondition (HTTP 400)が返されます。Originが参照するのは名前空間の所有者の要件充足状況であり、呼び出し元ユーザーのものではありません。

パスパラメータ

namespaceSlug string 必須

アプリを所有する名前空間のスラッグ。

リクエストボディ

displayName string 必須

ユーザーに表示されるアプリ名。空にすることはできません。

publicKey string 必須

アプリの署名キーペアの PEM SPKI 形式 Ed25519 公開鍵。アプリの署名キーを生成するを参照してください。

webhookUrl string

アウトバウンドウェブフックの配信先URL (絶対HTTPS URL) 。空の場合、アプリはウェブフックの配信を受け取りません。

events 配列

Webhook のイベントサブスクリプション。Events のイベント slug で指定します。不明なイベントタイプは拒否されます。空のリストを指定するとイベントを購読しないため、アプリが受け取るのは、常に配信され、ここには指定できない installation.* イベントのみです。

description string

アプリの簡単な説明。

websiteUrl string

出版社のウェブサイト。絶対HTTPS URLで指定します。

installationRedirectUris 配列

OAuth インストールコールバックの許可リスト: フラグメントを含まない絶対 HTTPS URI で、承認時に完全一致で照合されます。

defaultScopes 配列

アプリのインストール時に提供されるデフォルトのスコープ。repository:contents:read のようなカタログのスコープ文字列で指定します。インストール時にスコープを明示的に指定することも可能です。

レスポンスフィールド

id string

グローバルに一意なアプリ識別子。app_ プレフィックスが付きます。

displayName string

ユーザーに表示されるアプリ名。

webhookUrl string

アプリのWebhook配信を受信する、登録済みのHTTPS URLです。アプリが配信を受信しない場合は空です。

events 配列

アプリに設定されているWebhookイベントのサブスクリプションです。installation.*イベントは常に配信され、ここには表示されません。

createdAt string

app の作成日時を示す RFC 3339 形式のタイムスタンプ。

updatedAt string

app のメタデータが最後に更新された日時 (RFC 3339 形式のタイムスタンプ) 。

installationRedirectUris 配列

OAuthインストールコールバックの許可リスト: アプリ起点のインストールがリダイレクト先として使用できるURI。認可時に完全一致で照合されます。

namespaceSlug string

アプリを所有するネームスペースのスラッグ。

description string

パブリッシャーが提供するアプリの説明。未設定の場合は空です。

websiteUrl string

パブリッシャーのウェブサイト。未設定の場合は空です。

defaultScopes 配列

アプリのインストール時に提供されるデフォルトのスコープ。カタログのスコープ文字列で指定します。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/namespaces/NAMESPACE_SLUG/apps' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "displayName": "CI Status Bot",  "publicKey": "-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEAv7wFoV1bC9yKq3nZ8dQmXh5uJb2tR4sEwG6aP0iN8kY=\n-----END PUBLIC KEY-----",  "webhookUrl": "https://ci.acme.dev/webhooks/origin",  "events": [    "pull_request.created",    "pull_request.merged"  ],  "description": "Posts CI status on pull requests.",  "websiteUrl": "https://ci.acme.dev",  "installationRedirectUris": [    "https://ci.acme.dev/origin/setup"  ],  "defaultScopes": [    "repository:contents:read",    "repository:pull_requests:read"  ]}'

レスポンスの構造:

{  "id": "app_01k2ja2000e0080000000000a1",  "displayName": "CI Status Bot",  "webhookUrl": "https://ci.acme.dev/webhooks/origin",  "events": [    "pull_request.created",    "pull_request.merged"  ],  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-01T09:30:00Z",  "installationRedirectUris": [    "https://ci.acme.dev/origin/setup"  ],  "namespaceSlug": "acme",  "description": "Posts CI status on pull requests.",  "websiteUrl": "https://ci.acme.dev",  "defaultScopes": [    "repository:contents:read",    "repository:pull_requests:read"  ]}

アプリインストール用リポジトリを追加する

POST/v1/origin/namespaces/{namespaceSlug}/installations/{installationId}/repos

Scopenamespace:installations:writeAuthUser access token

インストールのリポジトリ選択にリポジトリを追加し、更新後のインストールを返します。この書き込みは追加方式です。指定されたリポジトリは現在の選択と合併され、リクエストのリポジトリがすべてすでに付与されている場合は何も変更せずに成功し、インストールのスコープは変更されません。

列挙された各リポジトリはターゲットの名前空間に属している必要があり、そうでない場合はリクエストは FailedPrecondition (HTTP 400) を返し、権限付与は一切行われません。同じエラーは、名前空間内のすべてのリポジトリを既に含んでいるインストール (repoSelectionMode が all) 、一時停止中のインストール、インストール単位のスコープ導入より前に作成されたインストールにも適用されます。存在しないインストール、または別の名前空間に属するインストールは 404 を返します。この endpoint では初回インストールを実行できないため、アプリがその名前空間に一度もインストールされていない場合、メッセージに開くべき同意ページが示されます。

呼び出し元は、その名前空間に対するインストール管理権限を持つ Cherri Code ユーザーの認証情報である必要があります。アプリトークン、インストールトークン、サービスアカウントでは、インストールのリポジトリを変更できません。

パスパラメータ

namespaceSlug string 必須

インストールが属する名前空間の slug。

installationId 文字列必須

インストール識別子。

リクエスト本文

repoIds 配列必須

インストールの選択対象に追加するリポジトリID。1つ以上が必須です。値は重複が除外され、すでに選択対象に含まれているリポジトリは変更なく受け入れられます。リストにあるすべてのリポジトリはその名前空間に属している必要があり、そうでない場合はリクエストは失敗し、何も付与されません。

レスポンスフィールド

id 文字列

アプリが保存し、インストールアクセストークンの発行に使用するインストール識別子。

appId 文字列

インストール済みアプリの識別子。

target オブジェクト

このインストールに対して顧客が選択した所有者。

target.slug 文字列

所有者 ID とともにリポジトリの所有者を識別するために使用される、URL 用の所有者スラッグ。

target.id 文字列

オリジンの所有者識別子。

target.type 文字列

オーナーの namespace の種類。出力専用。使用可能な値: team、user。不明な場合は省略されます。

createdAt 文字列

RFC 3339 形式のインストール作成タイムスタンプ。

updatedAt 文字列

インストールの最終更新日時を示す RFC 3339 形式のタイムスタンプ。

repoSelectionMode 文字列

リポジトリの権限付与モード。all または selected のいずれか。

scopes 配列

インストールで承認されたスコープ。

installedBy オブジェクト

アプリを最初にインストールしたユーザー。直近に再同意を行ったアクターではありません。出力のみ。該当のユーザーレコードを読み取れなくなった場合は含まれません。

installedBy.id 文字列

ユーザーの公開識別子。接頭辞は user_ です。

installedBy.email 文字列

ユーザーのメールアドレス。

installedBy.displayName 文字列

ユーザーの表示名。アカウントの名と姓をスペースで連結したもので、製品上に表示される名前と同じです。アカウントに名前が設定されていない場合は省略されます。

installedBy.handle 文字列

ユーザーが主張するプロフィールハンドル (@プレフィックスは含まない)。そのプロフィールが公開されている場合のみ存在し、それ以外の場合は省略されます。

suspendedAt 文字列

インストールが一時停止中に設定されたRFC 3339タイムスタンプ。インストールが有効なときは省略されます。

deletedAt 文字列

インストールの削除時の RFC 3339 タイムスタンプ。installation.deleted ウェブフックのスナップショットにのみ含まれます。削除されたインストールは API を通じて解決されなくなるため、このエンドポイントはそれを返しません。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/namespaces/NAMESPACE_SLUG/installations/INSTALLATION_ID/repos' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "repoIds": [    "repo_01k2ja2000e0080000000000q4",    "repo_01k2ja2000e0080000000000q5"  ]}'

レスポンスの構造:

{  "id": "inst_01k2ja2000e0080000000000b2",  "appId": "app_01k2ja2000e0080000000000a1",  "target": {    "slug": "acme",    "id": "ns_01k2ja2000e0080000000000p3",    "type": "team"  },  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "repoSelectionMode": "selected",  "scopes": [    "repository:contents:read",    "repository:pull_requests:read",    "repository:metadata:read"  ]}

リポジトリ

cloneUrlは出力専用のHTTPSクローンURLです。Get RepoのレスポンスにはcloneUrlが含まれます。

パートナーはアプリのインストールのリポジトリ一覧を通じてリポジトリを確認します。名前空間全体でのリポジトリの一覧表示と作成は、パートナーAPIの対象外です。

名前空間の一覧取得

GET/v1/origin/namespaces

AuthUser access token

リポジトリを一覧取得できる名前空間を、slug 順に一覧表示します。

対象候補は、所属チームの名前空間、個人の名前空間、およびアクセス権を付与されたリポジトリを含む名前空間です。このうち namespace:repositories:read 権限を持つものだけが返されるため、どの結果も List Repos の ownerSlug としてそのまま使用できます。

呼び出し元は Cherri Code ユーザーの認証情報である必要があります。この呼び出し自体に必要なスコープはありません。アプリトークン、インストールトークン、サービスアカウントで呼び出した場合は PermissionDenied (HTTP 403) が返されます。

クエリパラメータ

pageSize integer

返す名前空間の最大数。未設定または 0 の場合はデフォルトの 30 になります。100 を超える値は 100 に制限されます。

pageToken string

前回のレスポンスの next_page_token で返された不透明なカーソル。最初のページでは空にします。後続のリクエストで pageSize を指定すると、そのページに適用されます。前回のページサイズを引き継ぐ場合は省略してください。

レスポンスフィールド

namespaces array

リポジトリを一覧取得できる名前空間 (slug 順) 。

namespaces[].namespace object

名前空間の所有者への参照。

namespaces[].namespace.slug string

URL で使用される所有者の slug。List Repos の ownerSlug として使用します。

namespaces[].namespace.id string

Origin の所有者識別子。

namespaces[].namespace.type string

オーナーの namespace の種類。出力専用。使用可能な値：team、user。不明な場合は省略されます。

namespaces[].viewerCanCreateRepositories boolean

この名前空間で Create Repo を実行した場合に、認可チェック、および所有者のプランと設定に関するチェックを通過できるかどうか。

nextPageToken string

次のページを取得するための不透明なカーソル。次のページがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/namespaces' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造：

{  "namespaces": [    {      "namespace": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      },      "viewerCanCreateRepositories": true    },    {      "namespace": {        "slug": "jane",        "id": "ns_01k2ja2000e0080000000000p4",        "type": "user"      },      "viewerCanCreateRepositories": false    }  ]}

リポジトリ一覧

GET/v1/origin/repos/{ownerSlug}

Scopenamespace:repositories:readAuthUser access token

オーナーエンティティに属するリポジトリを一覧表示します。

パスパラメータ

ownerSlug 文字列必須

親所有エンティティのスラッグ。

クエリパラメータ

pageSize 整数

返却するリポジトリの最大数。未設定または0の場合はデフォルトで30になります。100を超える値は100に制限されます。

pageToken 文字列

前のレスポンスの next_page_token による不透明なカーソル。最初のページでは空です。後続のリクエストで pageSize を指定すると、そのページに適用されます。省略した場合は前回のページサイズが引き継がれます。

filter 文字列

大文字小文字を区別しない任意の部分文字列フィルター。

レスポンスフィールド

repositories 配列

指定された所有者に属するリポジトリ。

repositories[].id 文字列

オリジンリポジトリの識別子。

repositories[].name 文字列

所有者内のリポジトリ名。

repositories[].fullName 文字列

acme/api のような、オーナー名とリポジトリ名を組み合わせたもの。

repositories[].owner オブジェクト

リポジトリの所有者参照。

repositories[].owner.slug 文字列

オーナーIDと組み合わせてリポジトリのオーナーを識別する、URL 表示用のオーナースラッグ。

repositories[].owner.id 文字列

Originオーナーの識別子。

repositories[].owner.type 文字列

所有者名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

repositories[].defaultBranch 文字列

リポジトリのデフォルトブランチ名。

repositories[].createdAt 文字列

RFC 3339形式のリポジトリ作成タイムスタンプ。

repositories[].updatedAt 文字列

RFC 3339形式のリポジトリ更新タイムスタンプ。

repositories[].pushedAt 文字列

完全なリポジトリのレスポンスに表示される、最新のプッシュの RFC 3339 タイムスタンプ。

repositories[].cloneUrl 文字列

出力専用の HTTPS クローン URL。get-repository レスポンスに含まれます。

repositories[].mirror オブジェクト

ミラーのメタデータ。ネイティブリポジトリの場合や、ミラーの初回同期が完了していない間は存在しません。

repositories[].mirror.source 文字列

ミラー元。指定可能な値: github。

repositories[].mirror.sourceId 文字列

ソースによって割り当てられた不透明なリポジトリ識別子。

repositories[].mirror.status 文字列

移行中 (カットオーバー完了まで) の実効的なミラー方向。許容値: inbound、outbound。

repositories[].visibility 文字列

リポジトリの可視性。許容値: internal、private。

repositories[].allowMergeCommit boolean

プルリクエストをマージコミットとしてマージできるかどうか。

repositories[].allowSquashMerge ブール値

プルリクエストをスカッシュマージでマージできるかどうか。

repositories[].deleteBranchOnMerge ブール値

マージ時にヘッドブランチが自動的に削除されるかどうか。

nextPageToken 文字列

次のページ用の不透明なカーソル。これ以上ページがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "repositories": [    {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "fullName": "acme/rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      },      "defaultBranch": "main",      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "pushedAt": "2026-08-02T14:45:00Z",      "cloneUrl": "https://origin.cursor.com/git/acme/rocket.git"    }  ]}

Get Repo

GET/v1/origin/repos/{ownerSlug}/{repoName}

Scoperepository:metadata:readAuthInstallation tokenUser access token

(owner_id, name) 識別子で指定した単一のリポジトリを返します。

cloneUrl は出力専用の HTTPS クローン URL です。リポジトリの取得結果には cloneUrl が含まれます。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

レスポンスフィールド

id 文字列

Origin リポジトリ識別子。

name 文字列

所有者内のリポジトリ名。

fullName 文字列

acme/api などの、オーナー名とリポジトリ名を組み合わせた名前。

owner オブジェクト

リポジトリの所有者参照。

owner.slug 文字列

リポジトリのオーナーを識別するために、オーナー ID と共に使用される URL 表示用のオーナースラッグ。

owner.id 文字列

Origin オーナー識別子。

owner.type 文字列

オーナーの名前空間タイプ。出力専用。指定可能な値: team, user。不明な場合は省略されます。

defaultBranch 文字列

リポジトリのデフォルトブランチ名。

createdAt 文字列

RFC 3339 形式のリポジトリ作成タイムスタンプ。

updatedAt 文字列

RFC 3339 形式のリポジトリ更新タイムスタンプ。

pushedAt 文字列

リポジトリの完全なレスポンスに表示される、最新のプッシュの RFC 3339 タイムスタンプ。

cloneUrl 文字列

出力専用の HTTPS クローン URL。get-repository のレスポンスに含まれます。

mirror オブジェクト

ミラーのメタデータ。ネイティブリポジトリの場合、またはミラーの初回同期が準備できる前は存在しません。

mirror.source 文字列

ミラー元。指定可能な値: github。

mirror.sourceId 文字列

ソースによって割り当てられる不透明なリポジトリ識別子。

mirror.status 文字列

移行中 (カットオーバー完了まで) の有効なミラー方向。指定可能な値: inbound、outbound。

visibility 文字列

リポジトリの可視性。指定可能な値: internal、private。

allowMergeCommit ブール値

プルリクエストをマージコミットとして取り込めるかどうか。

allowSquashMerge ブール値

プルリクエストをスカッシュマージでマージできるかどうか。

deleteBranchOnMerge boolean

マージ時にヘッドブランチを自動的に削除するかどうか。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "repo_01k2ja2000e0080000000000q4",  "name": "rocket",  "fullName": "acme/rocket",  "owner": {    "slug": "acme",    "id": "ns_01k2ja2000e0080000000000p3",    "type": "team"  },  "defaultBranch": "main",  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "pushedAt": "2026-08-02T14:45:00Z",  "cloneUrl": "https://origin.cursor.com/git/acme/rocket.git"}

リポジトリを更新

PATCH/v1/origin/repos/{ownerSlug}/{repoName}

Scoperepository:settings:writeAuthInstallation tokenUser access token

リポジトリの設定を更新します。省略したフィールドは変更されず、設定可能なフィールドを少なくとも 1 つ指定する必要があります。

設定は、デフォルトブランチ、自動headブランチ削除、可視性、マージ方法の順に、独立したグループとして固定順で適用されます。更新はグループ間でアトミックではありません。あるグループが拒否された場合、その前のグループはすでに適用されており、そのまま適用された状態が維持されます。要求した状態にするには、拒否されたグループを修正して再試行してください。レスポンスには、最後に適用されたグループ時点のリポジトリが含まれます。

フィールドが1つも設定されていないリクエストでは、InvalidArgument (HTTP 400) が返されます。デフォルトブランチへの同時変更では、409 Conflict が返されます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

リクエスト本文

defaultBranch string

新しいデフォルトブランチ。既存のブランチの名前を指定する必要があります。アップストリームからプルもプッシュもしないリポジトリのみでサポートされます。それ以外のリポジトリでは FailedPrecondition (HTTP 400) が返されます。

allowMergeCommit boolean

プルリクエストをマージコミットとしてマージできるかどうか。allowSquashMerge と一緒に送信する必要があり、2つのうち少なくとも一方は true でなければなりません。一方のみを送信した場合は InvalidArgument (HTTP 400) が返されます。

allowSquashMerge boolean

プルリクエストをスカッシュマージとしてマージできるかどうか。allowMergeCommit と一緒に送信する必要があり、2つのうち少なくとも1つは true でなければなりません。片方だけを送信すると InvalidArgument (HTTP 400) が返されます。

deleteBranchOnMerge boolean

マージ時にヘッドブランチを自動的に削除するかどうか。プルリクエストがこの API 上に存在するリポジトリでのみサポートされます。アップストリームのソースから pull するリポジトリの場合は FailedPrecondition (HTTP 400) を返します。

visibility string

変更後のリポジトリの可視性。指定可能な値: internal、private。可視性を変更しない場合は省略します。

レスポンスフィールド

id string

Origin リポジトリ識別子。

name string

所有者内でのリポジトリ名。

fullName string

acme/api のような、所有者名とリポジトリ名を組み合わせた名前。

owner object

リポジトリ所有者のリファレンス。

owner.slug string

リポジトリ所有者を識別するために所有者IDと組み合わせて使用される、URL 表示用の所有者スラッグ。

owner.id string

オリジン所有者識別子。

owner.type string

オーナーの namespace の種類。出力専用。指定可能な値: team、user。不明な場合は省略されます。

defaultBranch string

リポジトリのデフォルトブランチ名。

createdAt string

RFC 3339形式のリポジトリ作成タイムスタンプ。

updatedAt string

RFC 3339 形式のリポジトリ更新タイムスタンプ。

pushedAt string

完全なリポジトリ応答に表示される最新のプッシュのRFC 3339タイムスタンプ。

cloneUrl string

出力専用の HTTPS クローン URL。get-repository のレスポンスに含まれます。

mirror mirror オブジェクト

ミラーのメタデータ。ネイティブリポジトリの場合、およびミラーの初回同期が完了する前は含まれません。

mirror.source string

ミラー元。指定可能な値: github。

mirror.sourceId string

ソースによって割り当てられる不透明なリポジトリ識別子。

mirror.status string

移行中 (切り替えが完了するまで) の有効なミラー方向。許可される値: inbound、outbound。

visibility string

リポジトリの可視性。指定可能な値: internal、private。

allowMergeCommit boolean

プルリクエストをマージコミットとして取り込めるかどうか。

allowSquashMerge boolean

プルリクエストをスカッシュマージとして適用できるかどうか。

deleteBranchOnMerge boolean

マージ時にヘッドブランチが自動的に削除されるかどうか。

curl --request PATCH \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "defaultBranch": "main",  "allowMergeCommit": false,  "allowSquashMerge": true,  "deleteBranchOnMerge": true,  "visibility": "private"}'

レスポンスの構造:

{  "id": "repo_01k2ja2000e0080000000000q4",  "name": "rocket",  "fullName": "acme/rocket",  "owner": {    "slug": "acme",    "id": "ns_01k2ja2000e0080000000000p3",    "type": "team"  },  "defaultBranch": "main",  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "pushedAt": "2026-08-02T14:45:00Z",  "cloneUrl": "https://origin.cursor.com/git/acme/rocket.git",  "visibility": "private",  "allowMergeCommit": false,  "allowSquashMerge": true,  "deleteBranchOnMerge": true}

リポジトリを作成

POST/v1/origin/repos/{ownerSlug}

Scopenamespace:repositories:createAuthUser access token

オーナーに属するリポジトリを作成します。

リクエストが行われた時点で、オーナーは Origin に書き込みできる資格が必要です。ユーザーオーナーは Pro、Pro Student、Pro+、Ultra、または Start プランである必要があります。チームオーナーは有効な有料チームプランを持ち、Privacy Mode (レガシー) になっておらず、チーム管理者によって Origin が無効化されていない必要があります。資格のないオーナーの場合は FailedPrecondition (HTTP 400) が返されます。既存のリポジトリの読み取りにはこの要件は適用されません。

リポジトリ名は大文字と小文字を区別せずに確保されます。オーナーが既に所有しているリポジトリと大文字・小文字だけが異なる名前は拒否されるため、widgets と Widgets は同じ名前空間に共存できません。送信した名前はそのままの表記で保存されます。

新しいリポジトリへの最初のプッシュでは、そのリポジトリのデフォルトブランチが再設定されることがあります。そのプッシュがブランチの作成のみを行い、作成されたブランチのいずれもリポジトリに保存されているデフォルトブランチでない場合、Origin は作成されたブランチをデフォルトブランチに設定します。プッシュで複数のブランチが作成され、その中に main または master という名前が含まれている場合は、それらの名前のいずれかがデフォルトブランチに設定されます。それ以外の場合はデフォルトブランチは変更されません。現在の値は Get Repo から確認してください。

パスパラメータ

ownerSlug 文字列必須

親オーナーエンティティのスラッグ。

リクエスト本文

name 文字列必須

オーナー内で一意のリポジトリ名。作成時に必須です。

defaultBranch 文字列

デフォルトのブランチ名。レスポンスでは常に設定されます。作成時にこのフィールドを省略するか空のままにすると、デフォルトで"main"になります。

レスポンスフィールド

id 文字列

Origin リポジトリ識別子。

name 文字列

所有者内のリポジトリ名。

fullName 文字列

acme/api などの、オーナー名とリポジトリ名を組み合わせた名前。

owner オブジェクト

リポジトリのオーナー参照。

owner.slug 文字列

リポジトリのオーナーを識別するためにオーナーIDと共に使用される、URL表示用のオーナースラッグ。

owner.id 文字列

Origin オーナー識別子。

owner.type 文字列

オーナーの namespace タイプ。出力専用。許容値: team、user。不明な場合は省略されます。

defaultBranch 文字列

リポジトリのデフォルトブランチ名。

createdAt 文字列

RFC 3339 形式のリポジトリ作成タイムスタンプ。

updatedAt 文字列

RFC 3339 準拠のリポジトリ更新タイムスタンプ。

pushedAt 文字列

完全なリポジトリ応答に表示される最新のプッシュの RFC 3339 タイムスタンプ。

cloneUrl 文字列

出力専用の HTTPS クローンの URL。get-repository のレスポンスに含まれます。

mirror オブジェクト

ミラーのメタデータ。ネイティブリポジトリの場合およびミラーの初回同期が準備できる前は存在しません。

mirror.source 文字列

ミラー元。指定できる値は github のみです。

mirror.sourceId 文字列

ソースによって割り当てられた不透明なリポジトリ識別子。

mirror.status 文字列

切替が完了するまでの遷移中に有効なミラーの方向。許容値: inbound、outbound。

visibility 文字列

リポジトリの可視性。許容値: internal、private。

allowMergeCommit ブール値

プルリクエストをマージコミットとして取り込めるかどうか。

allowSquashMerge ブール値

プルリクエストを squash merge としてマージできるかどうか。

deleteBranchOnMerge boolean

マージ時にヘッドブランチが自動的に削除されるかどうか。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "name": "rocket",  "defaultBranch": "main"}'

レスポンスの構造:

{  "id": "repo_01k2ja2000e0080000000000q4",  "name": "rocket",  "fullName": "acme/rocket",  "owner": {    "slug": "acme",    "id": "ns_01k2ja2000e0080000000000p3",    "type": "team"  },  "defaultBranch": "main",  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "pushedAt": "2026-08-02T14:45:00Z",  "cloneUrl": "https://origin.cursor.com/git/acme/rocket.git"}

ブランチ一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/branches

Scoperepository:contents:readAuthInstallation tokenUser access token

リポジトリのブランチとその先端コミットを名前の昇順で取得します。page_size と page_token によるページネーションに対応しています。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

クエリパラメータ

pageSize integer

返すブランチの最大数。未指定または0の場合、デフォルトは30です。100を超える値は100に制限されます。

pageToken 文字列

前のレスポンスの next_page_token から取得した不透明なカーソル。最初のページでは空です。再開位置がエンコードされています。後続リクエストで pageSize を指定すると、そのページに適用されます。前回のページサイズを引き継ぐ場合は省略してください。

レスポンスフィールド

branches 配列

ブランチ名と先端コミットのSHAを含む、ページネーションされたブランチレコード。

branches[].name 文字列

ブランチ名。

branches[].commit オブジェクト

ブランチの先端にあるコミット。

branches[].commit.sha 文字列

ブランチの先端にあるコミットの完全な16進数SHA。

nextPageToken 文字列

次のページの不透明なカーソル。これ以上ページがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/branches' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "branches": [    {      "name": "main",      "commit": {        "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"      }    }  ]}

リポジトリの Tarball を取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/tarball/{ref}

Scoperepository:contents:readAuthInstallation tokenUser access token

ref 時点のリポジトリツリーを gzip 圧縮された tar としてダウンロードします。

Origin は、リポジトリと ref が解決されるコミットを基にアーカイブを識別します。特定のコミットへの最初のリクエストでは、Content-Type: application/gzip を含む 200 が返され、アーカイブがレスポンス本文としてストリーミングされます。同じコミットへの後続のリクエストでは、空の本文を含む 302 と、15 分間有効な署名付きダウンロード URL が Location に返されます。リダイレクトに従ってバイト列を取得してください。アーカイブには {ownerSlug}-{repoName}-{shortSha}/ という名前のトップレベルディレクトリが 1 つ含まれます。shortSha は解決されたコミットの先頭 7 文字の 16 進数で、GitHub の tarball endpoint と同じレイアウトです。空のリポジトリでは ABORTED (HTTP 409 Conflict) が返され、解決できないリファレンスでは 404 が返されます。

"/" を含むリファレンスを指定するには、パスセグメントではなくクエリパラメータとしてリファレンスを送信します: GET /v1/origin/repos/{ownerSlug}/{repoName}/tarball?ref=refs/heads/main。省略すると、リポジトリのデフォルトブランチをアーカイブします。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

ref 文字列必須

コミット SHA (完全または省略形の 16 進数) 、修飾なしのブランチ名またはタグ名、完全修飾の refs/heads/... または refs/tags/...、あるいはシンボリック HEAD。グロブや revspec は使用できないため、<rev>~3 は拒否されます。空の場合はリポジトリのデフォルトブランチが使用されます。

レスポンスフィールド

sha 文字列

解決されたコミットオブジェクト ID。40 または 64 文字の 16 進数です。Connect および JSON の呼び出し元に返されます。REST では、アーカイブのファイル名または署名付き URL から取得します。

downloadUrl 文字列

15 分間有効な短命の署名付きダウンロード URL。レスポンスでアーカイブをインラインでストリーミングする場合は空になります。これは、このリポジトリとコミットへの最初のリクエストの場合です。REST では、同じ URL が 302 の Location ヘッダーとして送信されます。

curl --request GET --location --output repo.tar.gz \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/tarball/HEAD' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "downloadUrl": "https://artifacts.origin.cursor.com/tarballs/0192f7a4-6c1e-7b3a-9f21-3d54c9a7e6b0/9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4.tar.gz?Expires=1767225600&Signature=EXAMPLE&Key-Pair-Id=KEXAMPLE123",  "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"}

ミラーを同期

POST/v1/origin/repos/{ownerSlug}/{repoName}:syncMirror

Scoperepository:contents:readAuthInstallation tokenUser access token

ミラーリポジトリの1つのリファレンスを上流ソースと同期します。同期対象が満たされている場合は HTTP 200、同期がまだ保留中の場合は HTTP 202 を返します。wait=false (デフォルト) は同期をスケジュールし、通常は 202 を返します。sha がすでに ref から到達可能な場合は、直ちに 200 を返します。wait=true は、同期対象が満たされるか待機時間の上限 (約2分) に達するまでブロックします。上限に達した場合も 202 を返し、同期はバックグラウンドで継続します。上流ソースから pull しないリポジトリは拒否されます。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

リクエスト本文

ref 文字列必須

取得する完全な Git リファレンス名。refs/ で始まり、そのプレフィックスに続くリファレンス名を指定する必要があります (例: refs/heads/main、refs/tags/v1) 。main のような短縮名は INVALID_ARGUMENT で拒否されます。

wait boolean

true の場合、同期が完了するか待機時間の上限に達するまでブロックします。デフォルトは false です。

sha 文字列

任意の完全なコミットオブジェクト ID。40文字または64文字の16進数です。ref の先端を待機するには、省略するか空欄のままにします。指定されており ref から到達可能な場合、他のミラー処理の完了を待たずに呼び出しは早期に返ります。それ以外の値は INVALID_ARGUMENT で拒否されます。

レスポンスフィールド

synced boolean

同期対象が満たされていることが確認できる場合は true、同期がまだ保留中の場合は false。常に含まれ、HTTP ステータスを反映します。true の場合は 200、false の場合は 202。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME:syncMirror' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "ref": "refs/heads/main",  "wait": true}'

レスポンスの構造:

{  "synced": true}

ミラーの移行に関するエンドポイントは Origin Migration API に記載されています。ミラーを同期はこのページに残ります。

ミラーリポジトリのカットオーバーを強制

Force Repo Mirror を参照してください。

ミラーリポジトリを移行

Transition Repo Mirror を参照してください。

チェック

初回の実行のupsertでは、対応するスイートが自動的に作成されます。
必須チェックは、インストール元のアプリとスイートのkey、必要に応じて実行のkeyによって照合されます。nameは表示専用で、照合には使用されません。
必須チェックの設定ではkey値が照合に使用されるため、試行をまたいでkey値を安定させ、ユーザーにとってわかりやすい値にしてください。
試行を更新するにはexternalIdを再利用します (その試行の以前の結果は破棄されます) 。再試行には新しいexternalIdを使用すると、以前の試行が履歴として残ります。
人間が読みやすい結果にはcheckRun.outputを使用します。
- title：255文字以内の短い結果見出し。
- summary：65,535 UTF-8バイト以内の主要なMarkdown要約。
- text：65,535 UTF-8バイト以内の詳細なMarkdown情報。
プロバイダーの外部結果ページへのリンクにはdetailsUrlを使用します。

どの試行が現在のものかの定義、externalUpdatedAtによる書き込みの順序付け、outcomeが報告する内容、およびこれらのエンドポイントで共通のタイムスタンプと期限のルールについては、チェック実行を参照してください。

チェック実行後

POST/v1/origin/repos/{ownerSlug}/{repoName}/check-runs

Scoperepository:checks:writeAuthInstallation token

repository:checks:write 権限を持つインストールアクセストークンを使用して、チェックスイートとチェックランを作成または更新します。書き込みは、認証済みインストールを所有するアプリによるものとして記録されます。同じ (repo, head_sha, suite.key, check.key) で再度呼び出すと、重複を作成せず、既存のチェックランがその場で更新されます。

このエンドポイントはスイートの試行をアトミックに解決または作成し、1つのラン試行をアップサートします。externalUpdatedAt は同じラン識別子への更新の順序を決めるため、古いリトライが新しい状態を上書きすることはできず、cancelled による完了が保存済みの成功結果を置き換えることもできません。詳しくは書き込みの順序付けを参照してください。古いものとして無視された投稿と、保存済みの値を繰り返す投稿はいずれも、保存済みのスイートとランを含む 200 を返します。ignored_stale と unchanged を created および updated と区別するには、outcome を確認してください。どちらの場合も updatedAt は更新されないため、これらを区別することはできません。

スイート内では、ある実行の key に対する現在の試行は、externalUpdatedAt が最も新しい実行です。同点の場合は createdAt、次いで id の新しい順で決まります。コミットに対して報告された (actor, key, externalId) の各組み合わせが 1 つのスイート試行であり、(actor, key) ごとの現在の試行は、その実行が最も新しい externalUpdatedAt を持つものです。実行を含まないスイートは、自身の createdAt で順位付けされます。実行がそのコミットにとって現在のものとなるのは、そのスイートがコミットの現在の試行である間だけです。そのため、古いスイートの externalId の下で投稿された実行は、同じスイートの別の試行により新しい活動がある間、コミットスコープの一覧には表示されません。いずれのレベルでも、キャンセルされた試行が成功した試行に取って代わることはありません。詳しいルールは試行と現在の試行を参照してください。置き換えられた試行は id で引き続き読み取れます。

deadlineAt は実行に設定できる任意の期限を記録します。Origin はこの値を保存し、読み取り時に返し、実行が completed に達するとクリアします。24時間を超えて先に設定された期限は、上限値に調整されるのではなく、InvalidArgument (HTTP 400) で拒否されます。

まだ in_progress の実行が期限を過ぎると、Origin はその実行を timed_out の結論で自ら完了し、completedAt が設定されていなければこれを設定して repository.check_run.completed を送信します。期限切れは実行ごとのタイマーではなく定期的なスイープとして実行されるため、期限その時点ではなく数分後に発生します。スイープはデフォルトで約30分ごとに実行されますが、これは運用設定により変更されることがあります。queued の実行や deadlineAt を持たない実行は期限切れになりません。期限前に自分で実行を完了すると期限はクリアされます。Origin は実行をタイムアウトさせる際にその実行の externalUpdatedAt を変更しないため、後からプロバイダーが完了を報告すると timed_out の結論を上書きすることができます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

リポジトリ名。所有者エンティティ内で一意です。

リクエスト本文

headSha string 必須

チェック実行の報告対象となるHEADコミットのSHA (40桁または64桁の16進数) 。

checkSuite オブジェクト必須

チェック実行が属するスイート。チェック実行とともにアップサートされます。

checkSuite.key string 必須

試行をまたいで論理スイートを識別する、アプリが選択した安定したキー。

checkSuite.name string 必須

ユーザー向けに表示されるスイート名。

checkSuite.detailsUrl string

スイート全体の詳細情報への任意のリンク。

checkSuite.externalId string 必須

このスイート試行に対してプロバイダーが割り当てた不変の識別子。

checkRun オブジェクト必須

アップサートするチェック実行。

checkRun.key string 必須

複数回の試行にまたがってその論理チェックを識別する、アプリが選択した安定したキー。

checkRun.name string 必須

ユーザー向けに表示されるチェック実行の名前。

checkRun.status string 必須

設定可能な値: CHECK_RUN_LIFECYCLE_STATUS_UNSPECIFIED、queued、in_progress、completed。スキーマには rerequested も記載されていますが、これは再リクエスト時に Origin のみが設定します。これを含むリクエストは InvalidArgument (HTTP 400) を返します。

checkRun.conclusion string

status == completed の場合にのみ必須です。許可されている値: CHECK_RUN_CONCLUSION_UNSPECIFIED, success, failure, neutral, cancelled, skipped, timed_out, action_required, stale。

checkRun.externalUpdatedAt string 必須

外部システムの最終更新時刻。並行する更新の順序を決めるために使用され、古い再試行が新しい状態を上書きできないようにします。

checkRun.startedAt 文字列

チェック実行の開始時刻。現在より60秒を超えて先の値を指定すると、InvalidArgument (HTTP 400) が返されます。

checkRun.completedAt string

チェック実行が完了した日時。60 秒を超える未来の値は InvalidArgument (HTTP 400) を返します。両方を同時に投稿する場合に startedAt より前の値を指定したときも同様です。

checkRun.detailsUrl 文字列

この特定のチェック実行の詳細への任意のリンク (例：プロバイダーのジョブ／ビルド URL) 。

checkRun.externalId string 必須

このチェック試行に対してプロバイダーが割り当てた不変の識別子。

checkRun.output object

このチェックの実行に対する人間が読みやすい出力。

checkRun.output.title string

出力の短い見出し。最大長: 255文字。

checkRun.output.summary string

出力の概要。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRun.output.text string

詳細な出力。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRun.deadlineAt string

チェック実行の締め切りを RFC 3339 形式のタイムスタンプで指定します。24 時間を超える未来の値は丸められるのではなく、InvalidArgument (HTTP 400) として拒否されます。作成時に省略すると締め切りなしとして記録され、更新時に省略すると保存されている締め切りは変更されません。

checkRun.isRerequestable boolean

リクエストに応じて実行を再実行できることを宣言します。これを true に設定すると、アプリは repository.check_run.rerequested を購読し、配信ごとに同じ head SHA と key に対して新しい実行を投稿して応答することを約束することになります。これは、古い試行を履歴として残す新しい externalId での新しい実行を投稿するか、同じ externalId の下で再リクエストされた実行を更新してその場で更新するかのいずれかです。その新しい投稿が到着するまで、再リクエストされた実行はコミットの最新のチェック状態で保留中と見なされるため、必須のチェックはマージをブロックし、プルリクエストには実行が再実行待ちであると表示されます。応答せずに再リクエスト可能と宣言すると、チェックは宙に浮いた状態になります。投稿時に Origin がサブスクリプションを検証することはありません。省略すると保存されている値が維持され、新しい実行ではデフォルトで false になります。宣言を取り下げるには false を送信してください。

レスポンスフィールド

checkSuite オブジェクト

作成または更新されたチェックスイート。

checkSuite.id string

サーバー割り当てのチェックスイート識別子。

checkSuite.repository オブジェクト

スイートのリポジトリ参照。

checkSuite.repository.id string

コンテナ参照内のリポジトリ識別子。

checkSuite.repository.name string

コンテナ参照内のリポジトリ名。

checkSuite.repository.owner オブジェクト

リポジトリの所有者参照。

checkSuite.repository.owner.slug string

リポジトリの所有者を識別するために owner ID とともに使用される、URL 表示用の所有者スラッグ。

checkSuite.repository.owner.id string

発生元の所有者識別子。

checkSuite.repository.owner.type string

所有者の名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

checkSuite.sha string

スイートが紐づくコミットの SHA。

checkSuite.key string

アプリが選択した「stable」必須チェックの識別子。この必須チェックは名前ではなく、アプリとこのキーの組み合わせで照合されます。

checkSuite.name string

表示専用のスイート名です。必須チェックの照合には使用されません。

checkSuite.detailsUrl string

プロバイダーのスイートレベルの結果への任意のリンク。

checkSuite.createdAt string

スイート作成時の RFC 3339 タイムスタンプ。

checkSuite.updatedAt string

最新のスイート更新時刻を示すRFC 3339タイムスタンプ。

checkSuite.externalId string

このスイート試行のプロバイダー識別子。

checkSuite.actor オブジェクト

スイートを作成したパブリックアクター。

checkSuite.actor.user object

アクターのユーザー版。ユーザーが操作を行ったときに設定されます。

checkSuite.actor.user.id string

ユーザーの公開識別子。

checkSuite.actor.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

checkSuite.actor.user.displayName string

ユーザーの表示名: アカウントの名と姓をスペースでつないだもので、製品が表示する名前と同じです。アカウントに名前がない場合は省略されます。

checkSuite.actor.user.handle string

ユーザーが申請したプロフィールのハンドル (@ プレフィックスを除く) 。そのプロフィールが公開されている間のみ表示され、公開されていない場合は省略されます。

checkSuite.actor.app オブジェクト

アクターのアプリバリアント。アプリが操作を実行したときに設定されます。

checkSuite.actor.app.id 文字列

アプリの公開識別子。

checkSuite.actor.app.displayName string

アプリに登録された表示名。アプリを解決できない場合や Cherri Code のファーストパーティ管理アクターの場合は省略されます。

checkSuite.actor.serviceAccount オブジェクト

アクターのサービスアカウント版。サービスアカウントが操作を実行したときに設定されます。

checkSuite.actor.serviceAccount.id string

サービスアカウントの公開識別子。

checkRun オブジェクト

アップサートされたチェック実行。

checkRun.id string

サーバーが割り当てたチェック実行の識別子。

checkRun.repository オブジェクト

実行のリポジトリ参照。

checkRun.repository.id string

コンテナ参照内のリポジトリ識別子。

checkRun.repository.name string

コンテナ参照内のリポジトリ名。

checkRun.repository.owner オブジェクト

リポジトリの所有者参照。

checkRun.repository.owner.slug string

リポジトリの所有者を識別するために owner ID とともに使用される、URL 表示用の所有者スラッグ。

checkRun.repository.owner.id string

Origin の所有者識別子。

checkRun.repository.owner.type string

所有者の名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

checkRun.checkSuite オブジェクト

このチェックを含むチェックスイートへの参照。

checkRun.checkSuite.id string

このチェックを含むチェックスイートにサーバーが割り当てた識別子。

checkRun.sha string

run が紐づくコミットの SHA。

checkRun.key string

アプリが選択する安定した論理実行識別子。必須チェックは、アプリ、スイートキー、およびこのキーで照合される場合があります。

checkRun.name string

表示専用の実行名です。必須チェックの照合には使用されません。

checkRun.status string

ライフサイクルのステータス：queued、in_progress、completed、またはrerequested。rerequestedの実行とは、再実行が要求された完了済みの実行で、所有アプリがまだ応答していないものです。保留中として扱い、queuedと同様に表示してください。

checkRun.conclusion string

完了済みまたは再リクエストされた実行に存在します。値は success、failure、neutral、cancelled、skipped、timed_out、action_required、stale のいずれかです。再リクエストされた実行では置き換えられた試行の判定結果なので、status が completed の場合にのみ参照してください。

checkRun.detailsUrl 文字列

プロバイダーの完全な結果ページへの個別リンク。

checkRun.externalUpdatedAt string

更新の順序付けに使用される外部更新タイムスタンプ。古い再試行が新しい状態を置き換えられないようにします。

checkRun.startedAt 文字列

提供された場合にプロバイダーが報告する RFC 3339 形式の開始時刻。

checkRun.completedAt string

提供された場合にプロバイダーが報告する RFC 3339 形式の完了時刻。

checkRun.createdAt 文字列

RFC 3339形式のラン作成タイムスタンプ。

checkRun.updatedAt string

最新の永続化された実行更新の RFC 3339 タイムスタンプ。

checkRun.externalId string

1回の試行に対するプロバイダーの識別子。該当の試行を更新するにはこれを再利用し、再試行する場合は新しい値を使用してください。

checkRun.actor オブジェクト

この実行を行ったパブリックアクター。常に、所有するチェックスイートの actor と同じです。

checkRun.actor.user オブジェクト

アクターのユーザー版。ユーザーが操作を行ったときに設定されます。

checkRun.actor.user.id string

ユーザーの公開識別子。

checkRun.actor.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

checkRun.actor.user.displayName string

checkRun.actor.user.handle string

checkRun.actor.app オブジェクト

アクターのアプリ版。アプリがアクションを実行した場合に設定されます。

checkRun.actor.app.id string

アプリの公開識別子。

checkRun.actor.app.displayName string

アプリに登録された表示名。アプリを解決できない場合や Cherri Code のファーストパーティ管理アクターの場合は省略されます。

checkRun.actor.serviceAccount オブジェクト

アクターのサービスアカウント版。サービスアカウントが操作を実行したときに設定されます。

checkRun.actor.serviceAccount.id string

サービスアカウントの公開識別子。

checkRun.output object

タイトル、要約、および提供された場合は長文を含む、人間が読める結果オブジェクト。

checkRun.output.title string

出力の短い見出し。最大長: 255文字。

checkRun.output.summary string

出力の概要。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRun.output.text string

詳細な出力。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRun.deadlineAt string

チェック実行の期限を RFC 3339 形式のタイムスタンプとして記録します。実行に期限がない場合 (実行完了後を含む) は記録されません。

checkRun.isRerequestable boolean

報告アプリがこの実行を再リクエスト可能と宣言したかどうか。

checkRun.rerequestedAt string

未処理の再リクエストの RFC 3339 タイムスタンプ。再リクエストが保留されていない場合は存在せず、実行を所有するアプリが再度投稿するとクリアされます。これが設定されている間は、status は rerequested となり、実行はコミットの最新のチェック状態を維持して保留として表示されます。conclusion と所要時間には置き換えられた結果が引き続き保持されるため、アプリが応答するまで必須チェックによってマージがブロックされます。

checkRun.rerequestedBy オブジェクト

再実行を要求したプリンシパル。actor と同じアクターバリアントを持ちます。rerequestedAt が設定されている間は存在し、それとともにクリアされます。

outcome string

この呼び出しが checkRun に対して行った操作。許容値: created、updated、unchanged、ignored_stale。古いものとして無視された投稿と、保存されている値をそのまま繰り返した投稿はどちらも保存済みの実行を返すため、両者を区別できるのはこのフィールドだけです。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/check-runs' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "checkSuite": {    "key": "ci-8842",    "name": "CI",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "externalId": "build-8842"  },  "checkRun": {    "key": "ci-8842-unit-tests",    "name": "unit-tests",    "status": "completed",    "conclusion": "success",    "externalUpdatedAt": "2026-08-02T14:44:30Z",    "startedAt": "2026-08-02T14:40:00Z",    "completedAt": "2026-08-02T14:44:30Z",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "externalId": "run-8842",    "output": {      "title": "Unit tests",      "summary": "128 tests passed.",      "text": "All suites green."    }  }}'

レスポンスの構造:

{  "checkSuite": {    "id": "crg_01k2ja2000e0080000000000h8",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    },    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "key": "ci-8842",    "name": "CI",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z",    "externalId": "build-8842",    "actor": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    }  },  "checkRun": {    "id": "cr_01k2ja2000e0080000000000g7",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    },    "checkSuite": {      "id": "crg_01k2ja2000e0080000000000h8"    },    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "key": "ci-8842-unit-tests",    "name": "unit-tests",    "status": "completed",    "conclusion": "success",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "externalUpdatedAt": "2026-08-02T14:44:30Z",    "startedAt": "2026-08-02T14:40:00Z",    "completedAt": "2026-08-02T14:44:30Z",    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z",    "externalId": "run-8842",    "actor": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    },    "output": {      "title": "単体テスト",      "summary": "128 tests passed.",      "text": "All suites green."    }  },  "outcome": "created"}

チェック実行の一括アップサート

POST/v1/origin/repos/{ownerSlug}/{repoName}/check-runs:batchUpsert

Scoperepository:checks:writeAuthInstallation token

1つのスイートに属する複数のチェックランを原子的にアップサートします。リクエストは最大10件のランを受け付け、(external_id, key) の重複する識別子は拒否されます。すべてのランがコミットされるか、リクエスト全体がロールバックされます。

各実行では、チェック実行を投稿と同じ任意のdeadlineAtを指定できます。

Origin は externalUpdatedAt による順序付けルールを各実行に個別に適用します。古い (stale) として無視された実行があっても、バッチ全体が失敗することはありません。レスポンスにはその代わりに保存済みの実行が含まれ、results[].outcome が各実行の判定結果をリクエスト順で報告します。

パスパラメーター

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

リクエスト本文

headSha string 必須

チェック実行の報告対象となるヘッドコミットSHA (40文字または64文字の16進数) 。

checkSuite オブジェクト必須

このリクエストの各チェック実行で共有されるスイート。

checkSuite.key 文字列必須

複数回の試行を通じて論理スイートを識別する、アプリが選択する安定したキー。

checkSuite.name string 必須

ユーザーに表示されるスイート名。

checkSuite.detailsUrl string

スイート全体の詳細情報への任意のリンク。

checkSuite.externalId string 必須

このスイート試行に対するプロバイダー割り当ての不変の識別子。

checkRuns array 必須

レスポンス順でアップサートするチェック実行。(external_id, key) が一意のエントリを1〜10件含める必要があります。

checkRuns[0].key string 必須

複数の試行にわたる論理チェックを識別する、アプリが選択する安定したキー。

checkRuns[0].name string 必須

ユーザー向けに表示されるチェックランの名前。

checkRuns[0].status string 必須

設定可能な値: CHECK_RUN_LIFECYCLE_STATUS_UNSPECIFIED、queued、in_progress、completed。スキーマには rerequested も記載されていますが、これは再リクエスト時に Origin のみが設定します。この値を含むリクエストは InvalidArgument (HTTP 400) を返します。

checkRuns[0].conclusion string

status == completed の場合にのみ必須。許容値：CHECK_RUN_CONCLUSION_UNSPECIFIED、success、failure、neutral、cancelled、skipped、timed_out、action_required、stale。

checkRuns[0].externalUpdatedAt string 必須

外部システムの最終更新時刻。並行する更新の順序付けに使用され、古い再試行が新しい状態を上書きできないようにします。

checkRuns[0].startedAt 文字列

チェックの実行が開始された時刻。現在より60秒を超えて先の値は InvalidArgument (HTTP 400) を返します。

checkRuns[0].completedAt string

チェック実行が完了した時刻。60秒を超えて未来の値は InvalidArgument (HTTP 400) を返します。両方を同時に投稿した場合に startedAt より前の値を指定したときも同様です。

checkRuns[0].detailsUrl string

この特定のチェック実行に関する詳細への任意のリンク (例：プロバイダーのジョブ/ビルドの URL) 。

checkRuns[0].externalId string 必須

このチェック試行に対してプロバイダーが割り当てた不変の識別子。

checkRuns[0].output オブジェクト

このチェック実行の人間が読める出力。

checkRuns[0].output.title 文字列

出力の短い見出し。最大長: 255文字。

checkRuns[0].output.summary string

出力の概要。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRuns[0].output.text string

詳細な出力。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRuns[0].deadlineAt string

チェック実行の期限を RFC 3339 形式のタイムスタンプで指定します。24時間を超えて先の日時は上限に丸められるのではなく InvalidArgument (HTTP 400) として拒否されます。作成時に省略すると期限なしとして記録され、更新時に省略すると保存された期限は変更されません。

checkRuns[0].isRerequestable boolean

リクエストに応じて実行を再実行できることを宣言します。true に設定すると、アプリは repository.check_run.rerequested を購読し、各配信に対して同じ head SHA と key に対する新しい実行を投稿して応答することを約束したことになります。新しい externalId の下で新しい実行を作成して古い試行を履歴として残すか、同じ externalId の下で再リクエストされた実行を更新してその場で刷新するかのいずれかです。新しい投稿が届くまで、再リクエストされた実行はコミットの最新のチェック状態で保留中と表示されるため、必須のチェックはマージをブロックし、プルリクエストには再実行待ちとして表示されます。再リクエスト可能と宣言して応答しないと、そのチェックは取り残されます。投稿時に Origin がサブスクリプションを検証することはありません。省略すると保存されている値が維持され、新しい実行ではデフォルトが false になります。宣言を取り消すには false を送信してください。

レスポンスフィールド

checkSuite オブジェクト

返されたすべてのチェック実行で共有される永続化されたスイート。

checkSuite.id string

サーバーによって割り当てられたチェックスイートの識別子。

checkSuite.repository オブジェクト

スイートのリポジトリ参照。

checkSuite.repository.id string

コンテナ参照内のリポジトリ識別子。

checkSuite.repository.name string

コンテナ参照内のリポジトリ名。

checkSuite.repository.owner オブジェクト

リポジトリの所有者参照。

checkSuite.repository.owner.slug string

リポジトリの所有者を識別するために、所有者IDとともに使用されるURL表示用のオーナースラッグ。

checkSuite.repository.owner.id string

オリジンの所有者識別子。

checkSuite.repository.owner.type string

所有者の名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

checkSuite.sha string

スイートが紐付いているコミットの SHA。

checkSuite.key 文字列

アプリが選択する安定した必須チェックの識別子。必須チェックは名前ではなく、アプリとこのキーで照合されます。

checkSuite.name string

表示専用のスイート名です。必須チェックの照合には使用されません。

checkSuite.detailsUrl string

プロバイダーのスイートレベルの結果への任意のリンク。

checkSuite.createdAt string

RFC 3339形式のスイート作成タイムスタンプ。

checkSuite.updatedAt string

スイートの最終更新を示すRFC 3339形式のタイムスタンプ。

checkSuite.externalId string

このスイート試行のプロバイダー識別子。

checkSuite.actor オブジェクト

スイートを作成した公開アクター。

checkSuite.actor.user オブジェクト

ユーザーがアクションを実行したときに設定される、アクターのユーザー固有のバリアント。

checkSuite.actor.user.id string

ユーザーの公開識別子。

checkSuite.actor.user.email string

ユーザーのメールアドレス。user バリアントが存在する場合は常に設定されます。

checkSuite.actor.user.displayName string

ユーザーの表示名: アカウントの名と姓をスペースで結合したもので、製品に表示される名前と同じです。アカウントに名前がない場合は省略されます。

checkSuite.actor.user.handle string

ユーザーが申告したプロフィールのハンドル (@ プレフィックスは含みません) 。そのプロフィールが公開されている場合にのみ表示され、それ以外の場合は省略されます。

checkSuite.actor.app オブジェクト

アクターのアプリバリアント。アプリが操作を実行したときに設定されます。

checkSuite.actor.app.id 文字列

アプリの公開識別子。

checkSuite.actor.app.displayName string

アプリの登録表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターでは省略されます。

checkSuite.actor.serviceAccount オブジェクト

アクターのサービスアカウントのバリアント。サービスアカウントがアクションを実行したときに設定されます。

checkSuite.actor.serviceAccount.id string

サービスアカウントの公開識別子。

checkRuns 配列

非推奨: 代わりに results[].checkRun を読み取ってください。リクエスト順で引き続き設定されています。

checkRuns[].id string

サーバー割り当てのチェック実行識別子。

checkRuns[].repository オブジェクト

この実行のリポジトリ参照。

checkRuns[].repository.id string

コンテナ参照内のリポジトリ識別子。

checkRuns[].repository.name string

コンテナ参照内のリポジトリ名。

checkRuns[].repository.owner object

リポジトリの所有者参照。

checkRuns[].repository.owner.slug string

リポジトリの所有者を識別するために、所有者IDとともに使用されるURL表示用のオーナースラッグ。

checkRuns[].repository.owner.id string

Origin の所有者識別子。

checkRuns[].repository.owner.type string

所有者の名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

checkRuns[].checkSuite オブジェクト

所属するチェックスイートへの参照。

checkRuns[].checkSuite.id string

所属するチェックスイートのサーバー割り当て識別子。

checkRuns[].sha 文字列

実行に紐付けられているコミットのSHAです。

checkRuns[].key string

アプリが選択する安定した論理的実行識別子。必要なチェックはアプリ、スイートキー、およびこのキーで一致する場合があります。

checkRuns[].name string

表示専用の実行名です。必須チェックの照合には使用されません。

checkRuns[].status string

ライフサイクルのステータス: queued、in_progress、completed、または rerequested。rerequested の実行とは、再実行が要求された完了済みの実行であり、所有するアプリがまだ応答していないものです。保留中として扱い、queued と同様に表示してください。

checkRuns[].conclusion string

完了した実行または再リクエストされた実行に対して存在します: success、failure、neutral、cancelled、skipped、timed_out、action_required、または stale。再リクエストされた実行では置き換えられた試行の判定結果となるため、status が completed の場合にのみ読み取ってください。

checkRuns[].detailsUrl 文字列

プロバイダーの完全な結果ページへの個別リンク。

checkRuns[].externalUpdatedAt string

古い再試行が新しい状態を置き換えられないように、更新の順序付けに使用される外部更新タイムスタンプ。

checkRuns[].startedAt string

提供元が指定した場合の RFC 3339 形式の開始時刻。

checkRuns[].completedAt string

提供元が指定した場合の RFC 3339 形式の完了時刻。

checkRuns[].createdAt string

RFC 3339形式の実行作成タイムスタンプ。

checkRuns[].updatedAt string

最後に永続化された実行の更新を示す RFC 3339 形式のタイムスタンプ。

checkRuns[].externalId string

1回の試行に対するプロバイダーの識別子です。その試行を更新するには同じ値を再利用し、再試行する場合は新しい値を使用してください。

checkRuns[].actor オブジェクト

この実行を作成した公開アクター。常に所有するチェックスイートの actor です。

checkRuns[].actor.user オブジェクト

ユーザーがアクションを実行したときに設定される、アクターのユーザー固有のバリアント。

checkRuns[].actor.user.id 文字列

ユーザーの公開識別子。

checkRuns[].actor.user.email 文字列

ユーザーのメールアドレス。user バリアントが存在する場合は常に設定されます。

checkRuns[].actor.user.displayName string

checkRuns[].actor.user.handle string

checkRuns[].actor.app オブジェクト

アクターのアプリバリアント。アプリが操作を実行したときに設定されます。

checkRuns[].actor.app.id string

アプリの公開識別子。

checkRuns[].actor.app.displayName string

アプリの登録表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターの場合は省略されます。

checkRuns[].actor.serviceAccount オブジェクト

アクターのサービスアカウントのバリアント。サービスアカウントがアクションを実行したときに設定されます。

checkRuns[].actor.serviceAccount.id string

サービスアカウントの公開識別子。

checkRuns[].output オブジェクト

タイトル、要約、および (提供されている場合の) 詳細なテキストを含む、人間が読める結果オブジェクト。

checkRuns[].output.title string

出力の短い見出し。最大長: 255文字。

checkRuns[].output.summary string

出力の概要。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRuns[].output.text string

詳細な出力。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRuns[].deadlineAt string

チェック実行の期限。RFC 3339 形式のタイムスタンプとして記録されます。実行に期限がない場合 (完了後を含む) は存在しません。

checkRuns[].isRerequestable boolean

報告元のアプリがこの実行を再リクエスト可能と宣言しているかどうか。

checkRuns[].rerequestedAt string

未処理の再リクエストの RFC 3339 タイムスタンプ。保留中の再リクエストがない場合は存在せず、その実行を所有するアプリが再度投稿するとクリアされます。設定されている間、status は rerequested になり、その実行はコミットの最新のチェック状態のままで保留と見なされます。conclusion とタイミング情報は引き続き置換前の結果を保持するため、必須のチェックはアプリが応答するまでマージをブロックします。

checkRuns[].rerequestedBy オブジェクト

再実行を要求したプリンシパル。actor と同じアクターバリアントを保持します。rerequestedAt が設定されている間に存在し、それとともにクリアされます。

results 配列

投稿された実行ごとに1件の結果を、リクエストの順序で返します。

results[].checkRun オブジェクト

この呼び出し後に保存されたチェック実行。outcome が created または updated の場合は投稿された値、それ以外の場合は既存のままの実行です。checkRuns[] と同じフィールドを保持します。

results[].outcome 文字列

この呼び出しが results[].checkRun に対して行った処理。許容値: created、updated、unchanged、ignored_stale。古くなったため無視された実行と、保存された値をそのまま返した実行はいずれも保存済みの実行を返すため、これらを区別できるのはこのフィールドだけです。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/check-runs:batchUpsert' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "checkSuite": {    "key": "ci-8842",    "name": "CI",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "externalId": "build-8842"  },  "checkRuns": [    {      "key": "ci-8842-unit-tests",      "name": "unit-tests",      "status": "completed",      "conclusion": "success",      "externalUpdatedAt": "2026-08-02T14:44:30Z",      "startedAt": "2026-08-02T14:40:00Z",      "completedAt": "2026-08-02T14:44:30Z",      "detailsUrl": "https://ci.acme.dev/runs/8842",      "externalId": "run-8842",      "output": {        "title": "Unit tests",        "summary": "128 tests passed.",        "text": "All suites green."      }    }  ]}'

レスポンスの構造:

{  "checkSuite": {    "id": "crg_01k2ja2000e0080000000000h8",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    },    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "key": "ci-8842",    "name": "CI",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z",    "externalId": "build-8842",    "actor": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    }  },  "checkRuns": [    {      "id": "cr_01k2ja2000e0080000000000g7",      "repository": {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      },      "checkSuite": {        "id": "crg_01k2ja2000e0080000000000h8"      },      "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "key": "ci-8842-unit-tests",      "name": "unit-tests",      "status": "completed",      "conclusion": "success",      "detailsUrl": "https://ci.acme.dev/runs/8842",      "externalUpdatedAt": "2026-08-02T14:44:30Z",      "startedAt": "2026-08-02T14:40:00Z",      "completedAt": "2026-08-02T14:44:30Z",      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "externalId": "run-8842",      "actor": {        "user": {          "id": "user_01k2ja2000e0080000000000c3",          "email": "[email protected]"        }      },      "output": {        "title": "Unit tests",        "summary": "128 tests passed.",        "text": "All suites green."      }    }  ],  "results": [    {      "checkRun": {        "id": "cr_01k2ja2000e0080000000000g7",        "repository": {          "id": "repo_01k2ja2000e0080000000000q4",          "name": "rocket",          "owner": {            "slug": "acme",            "id": "ns_01k2ja2000e0080000000000p3",            "type": "team"          }        },        "checkSuite": {          "id": "crg_01k2ja2000e0080000000000h8"        },        "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",        "key": "ci-8842-unit-tests",        "name": "unit-tests",        "status": "completed",        "conclusion": "success",        "detailsUrl": "https://ci.acme.dev/runs/8842",        "externalUpdatedAt": "2026-08-02T14:44:30Z",        "startedAt": "2026-08-02T14:40:00Z",        "completedAt": "2026-08-02T14:44:30Z",        "createdAt": "2026-08-01T09:30:00Z",        "updatedAt": "2026-08-02T14:45:00Z",        "externalId": "run-8842",        "actor": {          "user": {            "id": "user_01k2ja2000e0080000000000c3",            "email": "[email protected]"          }        },        "output": {          "title": "Unit tests",          "summary": "128 tests passed.",          "text": "All suites green."        }      },      "outcome": "created"    }  ]}

チェック実行を取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/check-runs/{checkRunId}

Scoperepository:checks:readAuthInstallation tokenUser access token

サーバーによって割り当てられた ID (cr_...) で単一のチェック実行を返します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

checkRunId string 必須

サーバーが割り当てたチェック実行 ID (cr_...)。

レスポンスフィールド

id string

サーバーによって割り当てられたチェック実行の識別子。

repository object

この実行のリポジトリ参照。

repository.id string

コンテナ参照内のリポジトリ識別子。

repository.name string

コンテナ参照内のリポジトリ名。

repository.owner object

リポジトリのオーナー参照。

repository.owner.slug string

リポジトリの所有者を識別するために所有者IDとともに使用される、URLに表示されるオーナースラッグ。

repository.owner.id string

オリジン所有者の識別子。

repository.owner.type string

所有者の名前空間の種類。出力専用。許容値: team, user。不明な場合は省略されます。

checkSuite オブジェクト

このチェックを含むチェックスイートへの参照。

checkSuite.id string

所属するチェックスイートにサーバーが割り当てた識別子。

sha string

run が紐付けられている commit の SHA。

key string

アプリが選択する安定した論理実行ID。必須チェックは app、suite key、この key に基づいて照合される場合があります。

name string

表示専用の実行名です。必須チェックの照合には使用されません。

status string

ライフサイクルのステータス: queued、in_progress、completed、または rerequested。rerequested は再実行が要求された completed の実行で、所有アプリがまだ応答していないものです。保留中として扱い、queued と同様に表示してください。

conclusion string

完了した実行または再リクエストされた実行に存在します: success、failure、neutral、cancelled、skipped、timed_out、action_required、または stale。再リクエストされた実行では、置き換えられた試行の判定結果となるため、status が completed の場合にのみ読み取ってください。

detailsUrl string

プロバイダーの完全な結果ページへの個別リンク。

externalUpdatedAt string

更新の順序付けに使用される外部更新タイムスタンプ。古い再試行が新しい状態を置き換えられないようにするためのものです。

startedAt 文字列

提供されている場合、プロバイダーが報告した RFC 3339 形式の開始時刻。

completedAt string

提供された場合、プロバイダーが報告した RFC 3339 形式の完了時刻。

createdAt string

RFC 3339形式のラン作成タイムスタンプ。

updatedAt string

最後に永続化された実行の更新時刻を示す RFC 3339 タイムスタンプ。

externalId string

1回の試行に対するプロバイダーの識別子です。更新する際はこれを再利用し、再試行する場合は新しい値を使用してください。

actor オブジェクト

実行を生成した公開アクター。常に所有するチェックスイートの actor です。

actor.user オブジェクト

ユーザーがアクションを実行したときに設定される、アクターのユーザー変種。

actor.user.id string

ユーザーの公開識別子。

actor.user.email string

ユーザーのメールアドレス。ユーザーバリアントが存在する場合は常に設定されます。

actor.user.displayName string

actor.user.handle string

ユーザーが申告したプロフィールのハンドル。@ プレフィックスは含みません。プロフィールが公開されている間のみ表示され、それ以外の場合は省略されます。

actor.app object

アクターのアプリのバリアント。アプリがアクションを実行したときに設定されます。

actor.app.id string

アプリの公開識別子。

actor.app.displayName string

アプリに登録された表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターの場合は省略されます。

actor.serviceAccount object

アクターのサービスアカウントのバリアント。サービスアカウントが操作を実行したときに設定されます。

actor.serviceAccount.id string

サービスアカウントの公開識別子。

output object

タイトル、要約、必要に応じて詳細なテキストを含む、人間が読める形式の結果オブジェクト。

output.title string

出力の短い見出し。最大長: 255文字。

output.summary string

出力の要約。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

output.text string

詳細な出力。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

deadlineAt 文字列

チェック実行の期限を RFC 3339 形式のタイムスタンプとして記録します。実行に期限がない場合 (実行完了後を含む) 、このフィールドは存在しません。

isRerequestable boolean

レポートを送信したアプリがこの実行を再リクエスト可能と宣言したかどうか。

rerequestedAt string

保留中の再リクエストの RFC 3339 タイムスタンプ。再リクエストが保留中でない場合は存在せず、その実行を所有するアプリが再度投稿するとクリアされます。設定されている間は status が rerequested となり、実行はコミットの最新のチェック状態に留まり「保留」と表示されます。conclusion とタイミング情報は引き続き置き換え前の結果を保持するため、必須チェックはアプリが応答するまでマージをブロックします。

rerequestedBy object

再実行を要求したプリンシパル。actor と同じアクターバリアントを保持します。rerequestedAt が設定されているときに存在し、それとともにクリアされます。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/check-runs/CHECK_RUN_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "cr_01k2ja2000e0080000000000g7",  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  },  "checkSuite": {    "id": "crg_01k2ja2000e0080000000000h8"  },  "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "key": "ci-8842-unit-tests",  "name": "unit-tests",  "status": "completed",  "conclusion": "success",  "detailsUrl": "https://ci.acme.dev/runs/8842",  "externalUpdatedAt": "2026-08-02T14:44:30Z",  "startedAt": "2026-08-02T14:40:00Z",  "completedAt": "2026-08-02T14:44:30Z",  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "externalId": "run-8842",  "actor": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "output": {    "title": "Unit tests",    "summary": "128 tests passed.",    "text": "All suites green."  }}

チェック実行の一覧注釈

GET/v1/origin/repos/{ownerSlug}/{repoName}/check-runs/{checkRunId}/annotations

Scoperepository:checks:readAuthInstallation tokenUser access token

チェック実行のアノテーションをIDの昇順で一覧表示します。

アノテーション ID は時系列でソート可能なため、ID の昇順は作成順でもあります。ページトークンを送信すると、以降のページネーションではスコープが固定されます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

checkRunId string 必須

サーバーによって割り当てられたチェック実行ID。

クエリパラメータ

pageSize 整数

返す注釈の最大数。省略または 0 の場合はデフォルトで 30 になります。100 を超える値は 100 に制限されます。

pageToken string

前のレスポンスの nextPageToken からの不透明なカーソル。最初のページでは省略してください。後続のリクエストで pageSize を指定すると、そのページに適用されます。省略すると前回のページサイズが維持されます。

レスポンスフィールド

annotations 配列

注釈のページ。IDは昇順で表示されます。

annotations[].id string

Stable Origin アノテーション ID。ID は時間でソート可能です。

annotations[].checkRunId string

この注釈が属するチェック実行のID。

annotations[].annotationLevel string

注釈の重大度。指定可能な値: notice、warning、failure。

annotations[].message string

アノテーションメッセージ。Markdownを含む場合があります。

annotations[].title string

注釈のタイトル。注釈にタイトルがない場合は表示されません。

annotations[].rawDetails string

生の詳細テキスト。アノテーションがない場合は表示されません。

annotations[].createdAt string

アノテーションが作成された日時 (RFC 3339)

annotations[].updatedAt string

アノテーションの最終更新日時 (RFC 3339) 。

annotations[].location オブジェクト

ソースの場所。run レベルの注釈では指定されません。

annotations[].location.path string

リポジトリに対する正規化された相対ファイルパス。

annotations[].location.startLine 整数

範囲の先頭行。行番号は1から始まり、範囲は両端を含みます。

annotations[].location.endLine integer

範囲の最終行。行番号は1から始まり、終端を含みます。

annotations[].location.columns object

列の範囲。注釈が単一行を含む場合にのみ存在します。

annotations[].location.columns.startColumn integer

範囲の先頭列。1始まりで、両端を含みます。

annotations[].location.columns.endColumn integer

範囲の最終列。1始まりで、終端を含みます。

nextPageToken string

次のページ用の不透明なカーソル。結果がこれ以上ない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/check-runs/CHECK_RUN_ID/annotations' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "annotations": [    {      "id": "cra_01k2ja2000e0080000000000v1",      "checkRunId": "cr_01k2ja2000e0080000000000g7",      "annotationLevel": "warning",      "message": "Deprecated API usage; migrate to the v2 client.",      "title": "Deprecated API",      "createdAt": "2026-08-02T14:45:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "location": {        "path": "src/telemetry.ts",        "startLine": 42,        "endLine": 42      }    }  ]}

チェック実行アノテーションの作成

POST/v1/origin/repos/{ownerSlug}/{repoName}/check-runs/{checkRunId}/annotations

Scoperepository:checks:writeAuthInstallation token

1〜25 件の注釈を、単一のアトミックなバッチでチェック実行に追加します。

チェック実行には最大100件のアノテーションを保持できます。この上限を超えるバッチは ResourceExhausted (HTTP 429) で拒否され、何も書き込まれません。1～25件の範囲外のバッチは InvalidArgument (HTTP 400) で拒否されます。この操作は追記のみで冪等ではないため、不確かな通信障害の後に再試行すると重複が追加されて容量を消費する可能性があります。同一の内容は許容されます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

checkRunId string 必須

サーバーが割り当てたチェック実行のID。

リクエスト本文

annotations array 必須

追加するバッチ。エントリを1～25件含める必要があります。

annotations[].annotationLevel string 必須

注釈の重大度。指定可能な値: notice, warning, failure。

annotations[].message string 必須

注釈メッセージ。Markdown を含めることができます。空にできません。UTF-8 で最大 65,535 バイトです。

annotations[].title string

注釈のタイトル。最大長: 255 Unicode 文字。

annotations[].rawDetails string

生の詳細テキスト。UTF-8で最大65,535バイト。

annotations[].location オブジェクト

注釈が指すソースの場所。コード行に紐づかない実行レベルの注釈では省略してください。

annotations[].location.path string 必須

リポジトリ相対の正規化されたファイルパス。最大 4,096 バイト (UTF-8) 。

annotations[].location.startLine integer 必須

範囲の開始行。1始まりで、この行を含みます。

annotations[].location.endLine integer 必須

範囲の最終行。1始まりで包含的で、startLine と同じかそれ以降の行です。

annotations[].location.columns オブジェクト

行内の列範囲。startLine と endLine が同じ行の場合にのみサポートされ、両方の列は一緒に送信する必要があります。

annotations[].location.columns.startColumn integer

範囲の先頭列。1始まりでこの値を含みます。

annotations[].location.columns.endColumn integer

範囲の最終列。1始まりで終端を含み、startColumn 以降です。

レスポンスフィールド

annotations 配列

このリクエストによって作成された注釈。

annotations[].id string

Stable Origin の注釈 ID。ID は時間順に並べ替え可能です。

annotations[].checkRunId string

この注釈が属するチェック実行のID。

annotations[].annotationLevel string

注釈の重大度。指定可能な値: notice, warning, failure。

annotations[].message string

注釈メッセージ。Markdown を含めることがあります。

annotations[].title string

注釈のタイトル。注釈にタイトルがない場合は存在しません。

annotations[].rawDetails string

生の詳細テキスト。注釈に詳細がない場合は存在しません。

annotations[].createdAt string

注釈が作成された日時 (RFC 3339) 。

annotations[].updatedAt string

注釈が最後に更新された日時 (RFC 3339)。

annotations[].location オブジェクト

ソースの場所。実行レベルの注釈では省略されます。

annotations[].location.path string

標準的なリポジトリ相対ファイルパス。

annotations[].location.startLine integer

範囲の開始行。1 始まりで、この行を含みます。

annotations[].location.endLine integer

範囲の最終行。行番号は1始まりで、終端を含みます。

annotations[].location.columns オブジェクト

列の範囲。注釈が単一行を対象とする場合にのみ存在します。

annotations[].location.columns.startColumn integer

範囲の開始列。1始まりでこの値を含みます。

annotations[].location.columns.endColumn integer

範囲の最終列。1始まりで、終端を含みます。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/check-runs/CHECK_RUN_ID/annotations' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "annotations": [    {      "annotationLevel": "warning",      "message": "Deprecated API usage; migrate to the v2 client.",      "title": "Deprecated API",      "location": {        "path": "src/telemetry.ts",        "startLine": 42,        "endLine": 42      }    }  ]}'

レスポンスの構造:

{  "annotations": [    {      "id": "cra_01k2ja2000e0080000000000v1",      "checkRunId": "cr_01k2ja2000e0080000000000g7",      "annotationLevel": "warning",      "message": "Deprecated API usage; migrate to the v2 client.",      "title": "Deprecated API",      "createdAt": "2026-08-02T14:45:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "location": {        "path": "src/telemetry.ts",        "startLine": 42,        "endLine": 42      }    }  ]}

チェック実行を再リクエスト

POST/v1/origin/repos/{ownerSlug}/{repoName}/check-runs/{checkRunId}/rerequest

Scoperepository:contents:writeAuthInstallation tokenUser access token

チェック実行を報告したアプリに再実行を要求します。Origin はそのリクエストを実行の rerequestedAt として記録し、所有アプリに repository.check_run.rerequested で通知します。アプリは同じヘッド SHA と key に対する新しい実行 (新規の実行またはこの実行の更新) を投稿して応答し、これにより rerequestedAt がクリアされ、投稿されたステータスが保存されます。リクエストが保留中の間、実行の status は rerequested となり、その conclusion とタイミングは置き換えられた試行のまま記述されます。この呼び出しは rerequestedAt が設定され status が rerequested の実行を返します。

対象の実行は completed であり、isRerequestable を持ち、その key における現在の試行であり、かつオープンなプルリクエストの現在の head 上にある必要があります。これ以外の場合は FailedPrecondition (HTTP 400) を返します。

実行ごとに未処理の再リクエストは1件までです。rerequestedAt が設定されている間に繰り返しリクエストすると AlreadyExists (HTTP 409 Conflict) が返され、所有するアプリが応答するとその実行は再び再リクエスト可能になります。repository:contents:write を持つ任意のプリンシパルは、報告したアプリにかかわらず再リクエスト可能な任意の実行を再リクエストできます。不明な checkRunId、または別のリポジトリに属する checkRunId の場合は 404 が返されます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

checkRunId string 必須

サーバーが割り当てたチェック実行 ID (cr_...)。

リクエストボディ

このリクエストにフィールドはありません。空の JSON オブジェクトを送信してください。

レスポンスフィールド

id string

サーバー割り当てのチェック実行識別子。

repository object

この実行のリポジトリ参照。

repository.id string

コンテナ参照内のリポジトリ識別子。

repository.name string

コンテナ参照内のリポジトリ名。

repository.owner object

リポジトリのオーナー参照。

repository.owner.slug string

リポジトリの所有者を識別するために所有者IDとともに使用される、URLに表示されるオーナースラッグ。

repository.owner.id string

オリジン所有者の識別子。

repository.owner.type string

所有者の名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

checkSuite オブジェクト

このチェックを含むチェックスイートへの参照。

checkSuite.id string

所属するチェックスイートにサーバーが割り当てた識別子。

sha string

実行に紐づけられているコミットの SHA。

key string

アプリが選択する安定した論理的実行識別子。必須チェックは app、suite key、およびこの key に基づいて照合される場合があります。

name string

表示専用の実行名です。必須チェックの照合には使用されません。

status string

ライフサイクルのステータス: queued、in_progress、completed、rerequested のいずれか。rerequested の実行とは、再実行が要求された completed の実行で、所有アプリからの応答がまだないものを指します。保留中として扱い、queued と同様に表示してください。

conclusion string

完了した実行または再リクエストされた実行に存在します: success、failure、neutral、cancelled、skipped、timed_out、action_required、または stale。再リクエストされた実行では、置き換えられた試行の結果を示すため、status が completed の場合にのみ参照してください。

detailsUrl string

プロバイダーの完全な結果ページへの個別リンク。

externalUpdatedAt string

更新の順序付けに使用される外部更新タイムスタンプ。古い再試行が新しい状態を置き換えられないようにします。

startedAt 文字列

提供された場合、プロバイダーが報告した RFC 3339 形式の開始時刻。

completedAt string

提供されている場合、プロバイダーが報告した RFC 3339 形式の完了時刻。

createdAt string

RFC 3339 形式の run 作成タイムスタンプ。

updatedAt string

最後に永続化された実行の更新時刻を示す RFC 3339 タイムスタンプ。

externalId string

1回の試行に対するプロバイダーの識別子です。その試行を更新するには再利用し、再試行する場合は新しい値を使用してください。

actor オブジェクト

実行を生成した公開アクター。常に所有するチェックスイートのactorです。

actor.user オブジェクト

アクターのユーザー版。ユーザーが操作を行ったときに設定されます。

actor.user.id string

ユーザーの公開識別子。

actor.user.email string

ユーザーのメールアドレス。ユーザーバリアントが存在する場合は常に設定されます。

actor.user.displayName string

actor.user.handle string

actor.app object

アクターのアプリのバリアント。アプリがその操作を行った場合に設定されます。

actor.app.id string

アプリの公開識別子。

actor.app.displayName string

アプリに登録された表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターの場合は省略されます。

actor.serviceAccount object

アクターのサービスアカウントのバリアント。サービスアカウントが操作を実行したときに設定されます。

actor.serviceAccount.id string

サービスアカウントの公開識別子。

output object

タイトル、要約、必要に応じてより長いテキストを含む、人間が読める形式の結果オブジェクト。

output.title string

出力の短い見出し。最大長: 255文字。

output.summary string

出力の要約。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

output.text string

詳細な出力。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

deadlineAt 文字列

チェック実行の期限を RFC 3339 形式のタイムスタンプで記録します。実行に期限がない場合 (実行完了後を含む) は存在しません。

isRerequestable boolean

レポート元のアプリがこの実行を再リクエスト可能と宣言したかどうか。

rerequestedAt string

未解決の再リクエストの RFC 3339 タイムスタンプ。再リクエストが保留中でない場合は存在せず、実行を所有するアプリが再度投稿するとクリアされます。設定されている間、status は rerequested となり、実行はコミットの最新のチェック状態に留まり保留として表示されます。conclusion と各時刻は引き続き旧結果を保持しているため、必須チェックはアプリが応答するまでマージをブロックします。

rerequestedBy object

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/check-runs/CHECK_RUN_ID/rerequest' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{}'

レスポンスの構造:

{  "id": "cr_01k2ja2000e0080000000000g7",  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  },  "checkSuite": {    "id": "crg_01k2ja2000e0080000000000h8"  },  "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "key": "ci-8842-unit-tests",  "name": "unit-tests",  "status": "rerequested",  "conclusion": "failure",  "detailsUrl": "https://ci.acme.dev/runs/8842",  "externalUpdatedAt": "2026-08-02T14:44:30Z",  "startedAt": "2026-08-02T14:40:00Z",  "completedAt": "2026-08-02T14:44:30Z",  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T15:02:10Z",  "externalId": "run-8842",  "actor": {    "app": {      "id": "app_01k2ja2000e0080000000000a1",      "displayName": "Acme CI"    }  },  "output": {    "title": "Unit tests",    "summary": "3 of 128 tests failed."  },  "isRerequestable": true,  "rerequestedAt": "2026-08-02T15:02:10Z",  "rerequestedBy": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  }}

チェックスイートの取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/check-suites/{checkSuiteId}

Scoperepository:checks:readAuthInstallation tokenUser access token

サーバーによって割り当てられた ID (crg_...) でチェックスイートのメタデータを取得します。チェック実行は含まれません。スイートのチェック実行は ListCheckRunsForSuite を使用して取得してください。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

リポジトリ名。オーナーエンティティ内で一意です。

checkSuiteId string 必須

サーバー割り当てのチェックスイートID (crg_...) 。

レスポンスフィールド

id string

サーバーによって割り当てられたチェック・スイート識別子。

repository object

スイートのリポジトリ参照。

repository.id string

コンテナ参照内のリポジトリ識別子。

repository.name string

コンテナ参照内のリポジトリ名。

repository.owner object

リポジトリの所有者への参照。

repository.owner.slug string

リポジトリのオーナーを識別するために、オーナーIDとともに使用されるURL向けのオーナースラッグです。

repository.owner.id string

Origin の所有者識別子。

repository.owner.type string

所有者の名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

sha 文字列

スイートに関連付けられたコミットのSHA。

key string

app が選択する安定した必須チェック識別子です。必須チェックは name ではなく、app とこのキーの組み合わせで照合されます。

name string

表示専用のスイート名です。必須チェックの照合には使用されません。

detailsUrl string

プロバイダーのスイートレベルの結果への任意のリンク。

createdAt string

RFC 3339形式のスイート作成タイムスタンプ。

updatedAt 文字列

スイートの最終更新を示す RFC 3339 形式のタイムスタンプ。

externalId string

このスイート試行のプロバイダー識別子。

actor オブジェクト

スイートを作成した公開アクター。

actor.user オブジェクト

アクターがユーザーである場合のバリアント。ユーザーがアクションを実行したときに設定されます。

actor.user.id string

ユーザーの公開識別子。

actor.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

actor.user.displayName string

ユーザーの表示名: アカウントの名と姓をスペースで結合した、製品に表示される名前です。アカウントに名前がない場合は省略されます。

actor.user.handle string

ユーザーが主張するプロフィールのハンドル。@ プレフィックスは含みません。プロフィールが公開されている場合にのみ表示され、それ以外は省略されます。

actor.app object

アクターがアプリである場合のバリアント。アプリがアクションを実行したときに設定されます。

actor.app.id string

アプリの公開識別子。

actor.app.displayName string

アプリの登録表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターでは省略されます。

actor.serviceAccount オブジェクト

アクターのサービスアカウント版。サービスアカウントがアクションを実行したときに設定されます。

actor.serviceAccount.id string

サービスアカウントの公開識別子。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/check-suites/CHECK_SUITE_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "crg_01k2ja2000e0080000000000h8",  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  },  "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "key": "ci-8842",  "name": "CI",  "detailsUrl": "https://ci.acme.dev/runs/8842",  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "externalId": "build-8842",  "actor": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  }}

スイートのチェック実行一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/check-suites/{checkSuiteId}/check-runs

Scoperepository:checks:readAuthInstallation tokenUser access token

スイートの現在のチェック実行を一覧表示します。スイート内で実行キーが複数回報告されている場合、そのキーに対する最新の試行のみが返され、上書きされた試行は省略されます。チェック実行を投稿でどの試行が最新であるかを定義します。再リクエストされた実行は一覧に残り、所有するアプリが応答するまで status が rerequested、rerequestedAt が設定された保留状態として表示され、上書きされた conclusion やタイミングは変更されません。上書きされた試行はその ID を指定してチェック実行を取得で読み取ることができます。ページネーション対応。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

checkSuiteId string 必須

サーバー割り当てのチェックスイートID (crg_...) 。

クエリパラメータ

pageSize 整数

返されるチェック実行の最大数。未設定または0の場合のデフォルトは30です。100を超える値は100に切り捨てられます。

pageToken string

前のレスポンスの next_page_token による不透明なカーソル。最初のページでは空です。このスイートにスコープされた最後に確認したチェックランのIDをエンコードします。後続リクエストで指定した pageSize はそのページに適用されます。前回のページサイズを維持するには省略してください。

レスポンスフィールド

checkRuns 配列

指定されたスイートに属するページネーション対応のチェック実行。

checkRuns[].id string

サーバー割り当てのチェック実行識別子。

checkRuns[].repository object

実行のリポジトリ参照。

checkRuns[].repository.id string

コンテナ参照内のリポジトリ識別子。

checkRuns[].repository.name string

コンテナ参照内のリポジトリ名。

checkRuns[].repository.owner オブジェクト

リポジトリの所有者参照。

checkRuns[].repository.owner.slug string

リポジトリの所有者を識別するために所有者IDとともに使用される、URL 表示用のオーナースラッグ。

checkRuns[].repository.owner.id string

オリジン所有者識別子。

checkRuns[].repository.owner.type string

オーナーの名前空間の種類。出力専用。許容値: team, user。不明な場合は省略されます。

checkRuns[].checkSuite オブジェクト

所属するチェックスイートへの参照。

checkRuns[].checkSuite.id string

所属するチェックスイートのサーバー割り当て識別子。

checkRuns[].sha string

実行に関連付けられているコミット SHA。

checkRuns[].key string

アプリ側で選択される安定した論理実行識別子。必須のチェックはアプリ、スイートキー、およびこのキーで一致することがあります。

checkRuns[].name string

表示専用の実行名です。必須チェックの照合には使用されません。

checkRuns[].status string

ライフサイクルのステータス: queued、in_progress、completed、rerequested のいずれか。rerequested の実行とは、再実行がリクエストされた完了済みの実行で、所有するアプリがまだ応答していないものです。保留中として扱い、queued と同様に表示してください。

checkRuns[].conclusion string

完了した実行または再リクエストされた実行に存在します: success、failure、neutral、cancelled、skipped、timed_out、action_required、または stale。再リクエストされた実行では上書きされた試行の判定結果となるため、status が completed の場合にのみ読み取ってください。

checkRuns[].detailsUrl string

プロバイダーの完全な結果ページへの個別リンク。

checkRuns[].externalUpdatedAt string

古い再試行が新しい状態を置き換えないよう、更新の順序を決めるために使用される外部更新タイムスタンプ。

checkRuns[].startedAt string

プロバイダーから提供された場合の RFC 3339 形式の開始時刻。

checkRuns[].completedAt string

提供されている場合、プロバイダーが報告した RFC 3339 形式の完了時刻。

checkRuns[].createdAt string

RFC 3339 形式の実行作成タイムスタンプ。

checkRuns[].updatedAt string

最後に永続化された実行の更新時刻を表す RFC 3339 タイムスタンプ。

checkRuns[].externalId string

1回の試行に対するプロバイダー識別子です。試行を更新する際はこれを再利用し、再試行する場合は新しい値を使用してください。

checkRuns[].actor オブジェクト

実行を作成した公開アクター。常に所有するチェックスイートの actor です。

checkRuns[].actor.user オブジェクト

ユーザーがアクションを実行したときに設定される、アクターのユーザー用バリアント。

checkRuns[].actor.user.id string

ユーザーの公開識別子。

checkRuns[].actor.user.email string

ユーザーのメールアドレス。ユーザーバリアントが存在する場合は常に設定されます。

checkRuns[].actor.user.displayName string

ユーザーの表示名: アカウントの名と姓をスペースで結合したもので、製品に表示されるのと同じ名前です。アカウントに名前がない場合は省略されます。

checkRuns[].actor.user.handle string

ユーザーが所有を主張するプロフィールのハンドル (@ プレフィックスなし) 。そのプロフィールが公開されている間のみ表示され、それ以外は省略されます。

checkRuns[].actor.app object

アクターのアプリのバリアント。アプリがアクションを実行したときに設定されます。

checkRuns[].actor.app.id string

アプリの公開識別子。

checkRuns[].actor.app.displayName string

アプリに登録された表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターの場合は省略されます。

checkRuns[].actor.serviceAccount オブジェクト

アクターのサービスアカウント版。サービスアカウントが操作を実行したときに設定されます。

checkRuns[].actor.serviceAccount.id string

サービスアカウントの公開識別子。

checkRuns[].output object

タイトル、要約、および提供された場合のより長いテキストを含む、人間が読める形式の結果オブジェクト。

checkRuns[].output.title string

出力の短い見出し。最大長: 255文字。

checkRuns[].output.summary string

出力の概要。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRuns[].output.text 文字列

詳細な出力。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRuns[].deadlineAt string

チェック実行の期限を RFC 3339 形式のタイムスタンプで記録します。実行に期限がない場合 (実行完了後を含む) は存在しません。

checkRuns[].isRerequestable boolean

報告アプリがこの実行を再リクエスト可能と宣言したかどうか。

checkRuns[].rerequestedAt string

未処理の再リクエストの RFC 3339 タイムスタンプ。再リクエストが保留されていない場合は存在せず、その実行を所有するアプリが再度投稿するとクリアされます。これが設定されている間、status は rerequested となり、実行はコミットの最新のチェック状態に残ったまま保留中として扱われます。conclusion とタイミングには置き換えられる前の結果が引き続き保持されるため、必須のチェックはアプリが応答するまでマージをブロックします。

checkRuns[].rerequestedBy object

再実行を要求したプリンシパル。actor と同じアクターバリアントを保持します。rerequestedAt が設定されている場合に存在し、それとともにクリアされます。

nextPageToken string

次のページ用の不透明なカーソル。これ以上ページがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/check-suites/CHECK_SUITE_ID/check-runs' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "checkRuns": [    {      "id": "cr_01k2ja2000e0080000000000g7",      "repository": {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      },      "checkSuite": {        "id": "crg_01k2ja2000e0080000000000h8"      },      "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "key": "ci-8842-unit-tests",      "name": "unit-tests",      "status": "completed",      "conclusion": "success",      "detailsUrl": "https://ci.acme.dev/runs/8842",      "externalUpdatedAt": "2026-08-02T14:44:30Z",      "startedAt": "2026-08-02T14:40:00Z",      "completedAt": "2026-08-02T14:44:30Z",      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "externalId": "run-8842",      "actor": {        "user": {          "id": "user_01k2ja2000e0080000000000c3",          "email": "[email protected]"        }      },      "output": {        "title": "Unit tests",        "summary": "128 tests passed.",        "text": "All suites green."      }    }  ]}

コミットのチェック実行一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/commits/{sha}/check-runs

Scoperepository:checks:readAuthInstallation tokenUser access token

すべてのスイートにわたるコミットの現在のチェック実行を一覧表示します。各スイートの最新の試行に属する実行のみが対象で、各スイート内では実行キーごとに最新の試行のみが含まれます。置き換えられた試行は省略されます。チェック実行を投稿で、どの試行が最新かを定義します。再リクエストされた実行は、それを所有するアプリが応答するまで一覧に残り、status が rerequested、rerequestedAt が設定された保留中として表示され、置き換えられた時点の conclusion や時間情報は変更されません。置き換えられた試行はその ID を指定してチェック実行を取得で取得できます。チェック名とステータスで任意にフィルタリングできます。ページネーション対応。

フィルターは集約されたセットに適用されるため、実行は最新の試行のステータスに基づいて一致し、フィルターは置き換えられた試行を再表示することはありません。ページトークンには発行時のフィルターが埋め込まれるため、異なるフィルターの下で再生されたトークンは拒否されます。フィルターが変更された場合はページネーションを再起動してください。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

sha string 必須

チェック実行を一覧表示する対象のコミットSHA (40文字または64文字の16進数) 。

クエリパラメータ

pageSize 整数

返されるチェック実行の最大数。未設定または0の場合の既定値は30です。100を超える値は100に丸められます。

pageToken string

前のレスポンスのnext_page_tokenによる不透明なカーソル。最初のページでは空です。このコミットおよび以下のフィルターにスコープされた最後に確認されたチェックランIDがエンコードされており、異なるフィルターでトークンを再利用するとInvalidArgument (HTTP 400) が返されます。後続リクエストで指定したpageSizeはそのページに適用されます。省略すると前のページサイズが維持されます。

checkName string

任意の完全一致チェック実行名フィルター。checkRuns[].name に対して照合されます。省略すると任意の名前の実行が一覧表示されます。

status string

任意のステータスフィルター。許可される値: queued、in_progress、completed、rerequested。それ以外の値を指定すると InvalidArgument (HTTP 400) が返されます。省略するとすべてのステータスの実行を一覧表示します。

レスポンスフィールド

checkRuns 配列

解決されたコミット SHA に関連付けられたページネーション対応のチェック実行。

checkRuns[].id string

サーバーによって割り当てられたチェック実行識別子。

checkRuns[].repository object

実行のリポジトリ参照。

checkRuns[].repository.id string

コンテナ参照内のリポジトリ識別子。

checkRuns[].repository.name string

コンテナ参照内のリポジトリ名。

checkRuns[].repository.owner オブジェクト

リポジトリのオーナー参照。

checkRuns[].repository.owner.slug string

リポジトリの所有者を識別するために所有者 ID とともに使用される、URL 表示用のオーナースラッグ。

checkRuns[].repository.owner.id 文字列

Origin のオーナー識別子。

checkRuns[].repository.owner.type string

所有者のネームスペースの種類。出力専用。許可される値: team、user。不明な場合は省略されます。

checkRuns[].checkSuite object

このチェックを含むチェック・スイートへの参照。

checkRuns[].checkSuite.id string

所属するチェックスイートのサーバー割り当て識別子。

checkRuns[].sha 文字列

実行に関連付けられたコミット SHA。

checkRuns[].key string

アプリが選択する安定した論理実行識別子。必要なチェックは app、suite key、およびこの key で一致する場合があります。

checkRuns[].name string

表示専用の実行名。必須チェックの照合には使用されません。

checkRuns[].status string

ライフサイクルのステータス: queued、in_progress、completed、または rerequested。rerequested の実行とは、完了済みの実行に対して再実行が要求され、所有アプリがまだ応答していないものを指します。保留中として扱い、queued と同様に表示してください。

checkRuns[].conclusion string

完了した実行または再リクエストされた実行で存在します。値は success、failure、neutral、cancelled、skipped、timed_out、action_required、または stale です。再リクエストされた実行では置き換えられた試行の判定結果を示すため、status が completed の場合にのみ参照してください。

checkRuns[].detailsUrl string

プロバイダーの詳細な結果ページへの個別リンク。

checkRuns[].externalUpdatedAt 文字列

古い再試行が新しい状態を置き換えられないよう、更新の順序付けに使用される外部更新タイムスタンプ。

checkRuns[].startedAt 文字列

提供されている場合、プロバイダーが報告した RFC 3339 形式の開始時刻。

checkRuns[].completedAt string

提供されている場合の、プロバイダーが報告した RFC 3339 形式の完了時刻。

checkRuns[].createdAt 文字列

RFC 3339 実行作成のタイムスタンプ。

checkRuns[].updatedAt string

最新の永続化された実行更新の RFC 3339 タイムスタンプ。

checkRuns[].externalId string

1回の試行に対するプロバイダーの識別子です。同じ試行を更新するにはこれを再利用し、再試行する場合は新しい値を使用してください。

checkRuns[].actor オブジェクト

この実行を生成した公開アクター。常に所有するチェックスイートのactorです。

checkRuns[].actor.user オブジェクト

実行者のユーザー版。ユーザーが操作を行ったときに設定されます。

checkRuns[].actor.user.id 文字列

ユーザーの公開識別子。

checkRuns[].actor.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

checkRuns[].actor.user.displayName string

checkRuns[].actor.user.handle string

ユーザーが申告したプロフィールのハンドル。@プレフィックスは含みません。プロフィールが公開されている間のみ表示され、そうでない場合は省略されます。

checkRuns[].actor.app object

アクターのアプリバリアント。アプリがアクションを実行したときに設定されます。

checkRuns[].actor.app.id string

アプリの公開識別子。

checkRuns[].actor.app.displayName string

アプリの登録表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターでは省略されます。

checkRuns[].actor.serviceAccount object

アクターのサービスアカウント変種。サービスアカウントが操作を実行したときに設定されます。

checkRuns[].actor.serviceAccount.id string

サービスアカウントの公開識別子。

checkRuns[].output object

タイトル、要約、および (指定された場合の) より長いテキストを含む、人間が読みやすい結果オブジェクト。

checkRuns[].output.title string

出力の短い見出し。最大長: 255文字。

checkRuns[].output.summary string

出力の概要。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRuns[].output.text 文字列

詳細な出力。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRuns[].deadlineAt 文字列

チェック実行の締め切りを RFC 3339 形式のタイムスタンプで記録します。実行に締め切りがない場合 (実行完了後を含む) は存在しません。

checkRuns[].isRerequestable boolean

報告元のアプリがこの実行を再リクエスト可能と宣言しているかどうか。

checkRuns[].rerequestedAt 文字列

保留中の再リクエストの RFC 3339 タイムスタンプ。再リクエストが保留中でない場合は存在せず、そのランを所有するアプリが再度投稿するとクリアされます。設定されている間、status は rerequested となり、ランはコミットの最新のチェック状態のまま「保留中」と表示されます。conclusion と各時刻は引き続き置き換え前の結果を保持するため、必須のチェックはアプリが応答するまでマージをブロックします。

checkRuns[].rerequestedBy object

再実行をリクエストしたプリンシパル。actorと同じアクターバリアントを持ちます。rerequestedAtが設定されている場合に存在し、rerequestedAtとともにクリアされます。

nextPageToken string

次ページ用の不透明なカーソル。次のページがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/commits/SHA/check-runs' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "checkRuns": [    {      "id": "cr_01k2ja2000e0080000000000g7",      "repository": {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      },      "checkSuite": {        "id": "crg_01k2ja2000e0080000000000h8"      },      "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "key": "ci-8842-unit-tests",      "name": "unit-tests",      "status": "completed",      "conclusion": "success",      "detailsUrl": "https://ci.acme.dev/runs/8842",      "externalUpdatedAt": "2026-08-02T14:44:30Z",      "startedAt": "2026-08-02T14:40:00Z",      "completedAt": "2026-08-02T14:44:30Z",      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "externalId": "run-8842",      "actor": {        "user": {          "id": "user_01k2ja2000e0080000000000c3",          "email": "[email protected]"        }      },      "output": {        "title": "Unit tests",        "summary": "128 tests passed.",        "text": "All suites green."      }    }  ]}

コミットのチェックスイートを一覧表示

GET/v1/origin/repos/{ownerSlug}/{repoName}/commits/{sha}/check-suites

Scoperepository:checks:readAuthInstallation tokenUser access token

コミットに報告されたチェックスイートを一覧表示します。報告アクターとスイートキーごとに各スイートの最新の試行のみを返します。置き換えられた試行は省略され、どの試行が最新であるかはチェック実行の作成で定義されます。置き換えられた試行はそのIDを指定してチェックスイートを取得で参照できます。スイートのメタデータのみを返します (実行の埋め込みは含まれません) 。ページネーション対応です。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

sha string 必須

チェックスイートを一覧表示する対象のコミットSHA (40文字または64文字の16進数) です。

クエリパラメータ

pageSize 整数

返却するスイートの最大数。未設定または0の場合はデフォルトで30になります。100を超える値は100に制限されます。

pageToken string

前回のレスポンスのnext_page_tokenによる不透明なカーソル。最初のページでは空です。このコミットに紐づく最後に確認されたチェックスイートIDがエンコードされています。後続リクエストでpageSizeを指定すると、そのページに適用されます。省略すると前回のページサイズが維持されます。

レスポンスフィールド

checkSuites 配列

解決されたコミットSHAに紐づくページ分割されたチェックスイート。

checkSuites[].id string

サーバー割り当てのチェックスイート識別子。

checkSuites[].repository オブジェクト

スイートのリポジトリ参照。

checkSuites[].repository.id string

コンテナ参照内のリポジトリ識別子。

checkSuites[].repository.name string

コンテナ参照内のリポジトリ名。

checkSuites[].repository.owner object

リポジトリのオーナー参照。

checkSuites[].repository.owner.slug string

リポジトリの所有者を識別するために所有者IDとともに使用される、URL 表示用のオーナースラッグ。

checkSuites[].repository.owner.id 文字列

オリジン所有者の識別子。

checkSuites[].repository.owner.type string

所有者の名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

checkSuites[].sha string

スイートが紐づけられているコミットのSHA。

checkSuites[].key string

app が指定する安定した必須チェックの識別子。必須チェックは name ではなく、app とこのキーで照合されます。

checkSuites[].name string

表示専用のスイート名。必須チェックの照合には使用されません。

checkSuites[].detailsUrl 文字列

プロバイダーのスイートレベルの結果への任意のリンク。

checkSuites[].createdAt 文字列

RFC 3339 形式の suite 作成タイムスタンプ。

checkSuites[].updatedAt 文字列

最新のスイート更新時刻を示すRFC 3339タイムスタンプ。

checkSuites[].externalId string

このスイート試行のプロバイダーの識別情報。

checkSuites[].actor オブジェクト

スイートを作成した公開アクター。

checkSuites[].actor.user オブジェクト

アクターのユーザー版。ユーザーが操作を行ったときに設定されます。

checkSuites[].actor.user.id string

ユーザーの公開識別子。

checkSuites[].actor.user.email string

ユーザーのメールアドレス。ユーザーのバリアントがある場合は常に設定されます。

checkSuites[].actor.user.displayName string

checkSuites[].actor.user.handle string

checkSuites[].actor.app オブジェクト

アクターのアプリのバリアント。アプリが操作を実行したときに設定されます。

checkSuites[].actor.app.id string

アプリの公開識別子。

checkSuites[].actor.app.displayName string

アプリに登録されている表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターの場合は省略されます。

checkSuites[].actor.serviceAccount オブジェクト

アクターのサービスアカウント版。サービスアカウントが操作を実行したときに設定されます。

checkSuites[].actor.serviceAccount.id string

サービスアカウントの公開識別子。

nextPageToken string

次ページ用の不透明なカーソル。これ以上ページがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/commits/SHA/check-suites' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "checkSuites": [    {      "id": "crg_01k2ja2000e0080000000000h8",      "repository": {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      },      "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "key": "ci-8842",      "name": "CI",      "detailsUrl": "https://ci.acme.dev/runs/8842",      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "externalId": "build-8842",      "actor": {        "user": {          "id": "user_01k2ja2000e0080000000000c3",          "email": "[email protected]"        }      }    }  ]}

コミットとコンテンツ

コミットでは、commit 配下の Git オブジェクトのメタデータと、トップレベルのリポジトリ関係を分けています。一覧レスポンスには stats は含まれません。コミットを取得には、コミット全体の集計 stats が含まれます。変更ファイルは、ページネーション対応のコミットファイルを一覧表示コレクションでのみ返されます。author と committer は、Origin ユーザーオブジェクトではなく、コミットに記録された Git ID 情報です。

比較は概要のみです。コミット一覧やファイル diff が埋め込まれることはありません。status は identical、ahead、behind、または diverged のいずれかです。aheadBy と behindBy はコミット数です。baseCommit、headCommit、mergeBaseCommit は簡略化されたコミット表現を使用します (stats やファイルは含まれません) 。

コミット一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/commits

Scoperepository:contents:readAuthInstallation tokenUser access token

ブランチまたは開始リファレンスのコミットを一覧表示します。

一覧結果には stats は含まれません。集計統計についてはコミットを取得を、ページネーション対応のファイル差分についてはコミットファイルを一覧表示を使用してください。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

所有者エンティティ内で一意のリポジトリ名。

クエリパラメータ

sha string

一覧表示の開始位置となる SHA、ブランチ、タグ、またはシンボリック ref (例: HEAD) 。空の場合はリポジトリのデフォルトブランチを使用します。

pageSize integer

返されるコミットの最大数。未指定または0の場合はデフォルトで30になります。100を超える値は100に制限されます。

pageToken string

前のレスポンスのnextPageTokenに由来する不透明なカーソル。最初のページでは空です。開始する ref、走査位置、メールアドレスのフィルターがエンコードされています。トークンが指定されている場合、sha、pageSize、authorEmails、committerEmails は無視されます。nextPageToken が設定されていても、フィルター適用後のページに含まれるコミット数は pageSize より少ないか、0件の場合があります。nextPageToken が空になるまでページを取得し続けてください。

authorEmails 配列

Git の作成者メールアドレスによる任意の絞り込み。前後の空白を除去し、大文字と小文字を区別せずに、指定されたメールアドレスのいずれかと照合します。空のエントリと重複は無視されます。異なるメールアドレスを最大100件指定できます。空の場合は絞り込みません。対象は Git の作成者メールアドレスであり、オリジンのアクター ID ではありません。各ページで、一致するコミットを探すために最大1,000件のコミットを調べます。

committerEmails 配列

Git コミッターのメールアドレスで絞り込むための任意のフィルターです。authorEmails と同じ正規化処理とメールアドレス100件の上限が適用されます。空の場合はフィルターを適用しません。両方のフィルターを設定した場合、コミットは両方のリストに一致する必要があります。各ページでは、一致するコミットを探すために最大1,000件のコミットを走査します。

レスポンスフィールド

commits 配列

stats を含まない簡略化されたコミット。変更されたファイルは埋め込まれません。

commits[].sha string

コミットの完全なSHA。

commits[].commit オブジェクト

トップレベルのリポジトリ関係とは別にネストされた Git オブジェクトのメタデータ。

commits[].commit.author オブジェクト

Origin のユーザーオブジェクトではなく、コミットに記録された Git の作成者情報。

commits[].commit.author.name string

Git の作成者情報に記録された名前。

commits[].commit.author.email string

Git の著者情報に記録されたメールアドレス。

commits[].commit.author.date string

Git の作成者情報に記録された RFC 3339 形式の日付。

commits[].commit.committer object

Origin のユーザーオブジェクトではなく、コミットに記録された Git コミッターの識別情報。

commits[].commit.committer.name string

Git の識別情報に記録された名前。

commits[].commit.committer.email string

Gitのユーザー情報に登録されているメールアドレス。

commits[].commit.committer.date string

Git署名の元のタイムゾーンオフセットを保持するISO-8601タイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

commits[].commit.message string

コミットメッセージ。

commits[].commit.tree オブジェクト

コミットが参照するツリー。

commits[].commit.tree.sha string

コミットが参照するツリーの SHA。

commits[].parents 配列

各親コミットへの参照。各参照にはSHAが含まれます。

commits[].parents[].sha string

親コミットのSHA。

nextPageToken string

次のページ用の不透明なカーソル。これ以上ページがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/commits' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "commits": [    {      "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "commit": {        "author": {          "name": "Jane Doe",          "email": "[email protected]",          "date": "2026-08-01T09:30:00Z"        },        "committer": {          "name": "Jane Doe",          "email": "[email protected]",          "date": "2026-08-01T09:30:00Z"        },        "message": "Add launch telemetry",        "tree": {          "sha": "a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8"        }      },      "parents": [        {          "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"        }      ],      "stats": {        "additions": 128,        "deletions": 46,        "total": 174      }    }  ]}

コミットを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/commits/{sha}

Scoperepository:contents:readAuthInstallation tokenUser access token

SHA または ref による単一のコミットを返し、コミット全体の集計 stats を含みます。変更されたファイルは含まれません。コミットファイルの一覧表示を使用してください。

author と committer はコミットに記録された Git アイデンティティであり、Origin ユーザーオブジェクトではありません。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

sha string 必須

取得するコミットの SHA、ブランチ、タグ、またはシンボリック ref (例: HEAD) 。短縮 SHA は Git コミットを取得の場合と同じ方法で解決されます。

レスポンスフィールド

sha string

コミットの完全な SHA。

commit object

トップレベルのリポジトリ関係とは別にネストされた Git オブジェクトのメタデータ。

commit.author object

コミットに記録された Git 作成者の識別情報であり、Origin のユーザーオブジェクトではありません。

commit.author.name string

Git の作成者情報に記録された名前。

commit.author.email string

Git author ID に記録されたメールアドレス。

commit.author.date string

Git の author アイデンティティに記録された RFC 3339 形式の日付。

commit.committer object

コミットに記録された Git コミッターの識別情報であり、Origin のユーザーオブジェクトではありません。

commit.committer.name string

Git の識別情報に記録されている名前。

commit.committer.email string

Git IDに記録されたメールアドレス。

commit.committer.date string

git署名に記録された元のタイムゾーンオフセットを保持するISO-8601タイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

commit.message string

コミットメッセージ。

commit.tree オブジェクト

コミットが参照するツリー。

commit.tree.sha string

コミットが参照するツリーの SHA。

parents 配列

各親コミットの参照には、それぞれSHAが含まれます。

parents[].sha string

親コミットのSHA。

stats object

コミット全体の追加、削除、および合計の集計；get-commit では含まれ、list のプロジェクションでは省略されます。

stats.additions 整数

コミットで追加された行数の合計。

stats.deletions integer

コミットで削除された行数の合計。

stats.total integer

コミットにおける追加と削除の合計。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/commits/SHA' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "commit": {    "author": {      "name": "Jane Doe",      "email": "[email protected]",      "date": "2026-08-01T09:30:00Z"    },    "committer": {      "name": "Jane Doe",      "email": "[email protected]",      "date": "2026-08-01T09:30:00Z"    },    "message": "Add launch telemetry",    "tree": {      "sha": "a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8"    }  },  "parents": [    {      "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"    }  ],  "stats": {    "additions": 128,    "deletions": 46,    "total": 174  }}

コミットで変更されたファイルを一覧表示

GET/v1/origin/repos/{ownerSlug}/{repoName}/commits/{sha}/files

Scoperepository:contents:readAuthInstallation tokenUser access token

コミットで変更されたファイルを一覧表示します。

sha はコミットの SHA、ブランチ、タグ、または HEAD のようなシンボリック参照を示す場合があります。結果はデフォルトで 30 件のファイルが返され、上限は 100 件です。ページトークンは解決されたコミットおよびファイルカーソルを固定するため、後続のリクエストでは sha がトークンと一致している必要があります。各ファイルには filename、status、additions、deletions、changes、patch が含まれ、名前が変更またはコピーされた場合は previousFilename も含まれます。バイナリファイルの場合、patch は空になります。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

sha string 必須

ファイルを一覧表示するコミットの SHA、ブランチ、タグ、またはシンボリック参照 (例: HEAD) 。短縮 SHA は Get Git Commit と同様に解決されます。

クエリパラメータ

pageSize integer

返す変更ファイルの最大数。未指定または0の場合のデフォルトは30です。100を超える値は100に制限されます。

pageToken string

前のレスポンスのnext_page_tokenに由来する不透明なカーソル。最初のページでは空です。このトークンは解決されたコミットとファイルカーソルを固定するため、後続のリクエストではshaがトークンと一致している必要があります。後続のリクエストで指定したpageSizeはそのページに適用されます。省略すると前のページサイズが維持されます。

レスポンスフィールド

files 配列

ファイル名、ステータス、行数、パッチ、および名前変更またはコピーされたファイルの previousFilename を含むページ分割された変更ファイル。バイナリパッチは空です。

files[].filename string

変更されたファイルのパス。

files[].status string

変更ステータス: 追加、削除、変更、名前変更、またはコピー。

files[].additions integer

ファイルの追加された行数。

files[].deletions integer

ファイルから削除された行数。

files[].changes integer

ファイル内で変更された行の合計数。

files[].patch string

統合形式のパッチ。バイナリファイルの場合は空です。

files[].previousFilename string

ファイルが名前変更またはコピーされたときの以前のパス。

nextPageToken string

トークンは解決済みコミットおよびファイルカーソルを固定します。以降の sha の値はそれと一致している必要があります。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/commits/SHA/files' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "files": [    {      "filename": "src/telemetry.ts",      "status": "modified",      "additions": 6,      "deletions": 3,      "changes": 9,      "patch": "@@ -12,6 +12,9 @@\n import { ignite } from \"./ignition\";\n+import { emitLaunchTelemetry } from \"./telemetry\";\n"    }  ]}

コミットの比較

GET/v1/origin/repos/{ownerSlug}/{repoName}/compare/{basehead}

Scoperepository:contents:readAuthInstallation tokenUser access token

マージベースに対してコミット、ref、またはタグを比較します。basehead は "{base}...{head}" です。スラッシュ ("/") を含む ref は SHA を使用する必要があります。

base と head はそれぞれ SHA、ブランチ、タグ、または HEAD のようなシンボリック参照にできます。レスポンスはページネーションされていない要約で、status は identical、ahead、behind、または diverged のいずれかです。3つのコミットオブジェクトは簡略化されており、stats とファイル情報を省略します。totalCommits、埋め込みの commits、および files フィールドは返されません。無関係な履歴の場合は 404 が返されます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

basehead string 必須

"{base}...{head}"。各リビジョンは SHA、ブランチ、タグ、または HEAD のようなシンボリック参照で指定できます。

レスポンスフィールド

status string

比較状態: 完全に一致、先行、遅延、または分岐しています。

aheadBy integer

HEAD が先行しているコミット数。

behindBy 整数

HEAD が遅れているコミット数。

baseCommit object

stats やファイルを含まない、スパースに解決されたベースコミット。

baseCommit.sha string

コミットの完全な SHA。

baseCommit.commit オブジェクト

トップレベルのリポジトリ関係とは別にネストされたGitオブジェクトのメタデータ。

baseCommit.commit.author object

コミットに記録された Git の著者情報であり、Origin のユーザーオブジェクトではありません。

baseCommit.commit.author.name string

Git の作成者 ID に記録される名前。

baseCommit.commit.author.email string

Git の作成者情報に記録されるメールアドレス。

baseCommit.commit.author.date string

Git作者の識別情報に記録された RFC 3339 形式の日付。

baseCommit.commit.committer オブジェクト

コミットに記録された Git コミッターの識別情報であり、Origin のユーザーオブジェクトではありません。

baseCommit.commit.committer.name string

Git の識別情報に記録された名前。

baseCommit.commit.committer.email string

Git の識別情報に記録されているメールアドレス。

baseCommit.commit.committer.date string

git署名の元のタイムゾーンオフセットを保持するISO-8601タイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

baseCommit.commit.message string

コミットメッセージ。

baseCommit.commit.tree オブジェクト

コミットが参照するツリー。

baseCommit.commit.tree.sha string

コミットが参照するツリーの SHA。

baseCommit.parents 配列

親コミットへの参照。それぞれ SHA を含みます。

baseCommit.parents[].sha string

親コミットの SHA。

headCommit オブジェクト

統計やファイルを含まないスパース解決済みヘッドコミット。

headCommit.sha string

コミットの完全な SHA。

headCommit.commit オブジェクト

トップレベルのリポジトリ関係とは別にネストされた Git オブジェクトのメタデータ。

headCommit.commit.author object

コミットに記録された Git の著者情報であり、Origin のユーザーオブジェクトではありません。

headCommit.commit.author.name string

Git の作成者 ID に記録される名前。

headCommit.commit.author.email string

Git の作成者情報に記録されるメールアドレス。

headCommit.commit.author.date string

Git作者の識別情報に記録された RFC 3339 形式の日付。

headCommit.commit.committer オブジェクト

コミットに記録された Git コミッターの識別情報であり、Origin のユーザーオブジェクトではありません。

headCommit.commit.committer.name string

Git の識別情報に記録された名前。

headCommit.commit.committer.email string

Git の識別情報に記録されているメールアドレス。

headCommit.commit.committer.date string

git署名の元のタイムゾーンオフセットを保持するISO-8601タイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

headCommit.commit.message string

コミットメッセージ。

headCommit.commit.tree オブジェクト

コミットが参照するツリー。

headCommit.commit.tree.sha string

コミットが参照するツリーの SHA。

headCommit.parents array

親コミットへの参照。各参照は SHA を含みます。

headCommit.parents[].sha string

親コミットの SHA。

mergeBaseCommit オブジェクト

統計やファイルを含まないスパースなマージベースコミット。

mergeBaseCommit.sha string

コミットの完全な SHA。

mergeBaseCommit.commit オブジェクト

トップレベルのリポジトリ関係とは別にネストされた Git オブジェクトのメタデータ。

mergeBaseCommit.commit.author オブジェクト

コミットに記録された Git の著者情報であり、Origin のユーザーオブジェクトではありません。

mergeBaseCommit.commit.author.name string

Git の作成者 ID に記録される名前。

mergeBaseCommit.commit.author.email string

Git の作成者情報に記録されるメールアドレス。

mergeBaseCommit.commit.author.date string

Git作者の識別情報に記録された RFC 3339 形式の日付。

mergeBaseCommit.commit.committer オブジェクト

コミットに記録された Git コミッターの識別情報であり、Origin のユーザーオブジェクトではありません。

mergeBaseCommit.commit.committer.name string

Git の識別情報に記録された名前。

mergeBaseCommit.commit.committer.email string

Git の識別情報に記録されているメールアドレス。

mergeBaseCommit.commit.committer.date string

git署名の元のタイムゾーンオフセットを保持するISO-8601タイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

mergeBaseCommit.commit.message string

コミットメッセージ。

mergeBaseCommit.commit.tree オブジェクト

コミットが参照するツリー。

mergeBaseCommit.commit.tree.sha string

コミットが参照するツリーの SHA。

mergeBaseCommit.parents 配列

親コミットへの参照。それぞれ SHA を含みます。

mergeBaseCommit.parents[].sha string

親コミットの SHA。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/compare/BASE...HEAD' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "status": "ahead",  "aheadBy": 2,  "behindBy": 0,  "baseCommit": {    "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8",    "commit": {      "author": {        "name": "Jane Doe",        "email": "[email protected]",        "date": "2026-08-01T09:30:00Z"      },      "committer": {        "name": "Jane Doe",        "email": "[email protected]",        "date": "2026-08-01T09:30:00Z"      },      "message": "Add launch telemetry",      "tree": {        "sha": "a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8"      }    },    "parents": [      {        "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"      }    ],    "stats": {      "additions": 128,      "deletions": 46,      "total": 174    }  },  "headCommit": {    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "commit": {      "author": {        "name": "Jane Doe",        "email": "[email protected]",        "date": "2026-08-01T09:30:00Z"      },      "committer": {        "name": "Jane Doe",        "email": "[email protected]",        "date": "2026-08-01T09:30:00Z"      },      "message": "Add launch telemetry",      "tree": {        "sha": "a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8"      }    },    "parents": [      {        "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"      }    ],    "stats": {      "additions": 128,      "deletions": 46,      "total": 174    }  },  "mergeBaseCommit": {    "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8",    "commit": {      "author": {        "name": "Jane Doe",        "email": "[email protected]",        "date": "2026-08-01T09:30:00Z"      },      "committer": {        "name": "Jane Doe",        "email": "[email protected]",        "date": "2026-08-01T09:30:00Z"      },      "message": "Add launch telemetry",      "tree": {        "sha": "a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8"      }    },    "parents": [      {        "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"      }    ],    "stats": {      "additions": 128,      "deletions": 46,      "total": 174    }  }}

リスト比較ファイル

GET/v1/origin/repos/{ownerSlug}/{repoName}/compare/{basehead}/files

Scoperepository:contents:readAuthInstallation tokenUser access token

比較によって変更されたファイルを一覧表示します。すなわち、base と head のマージベースに対する head の差分です。

basehead は "{base}...{head}" です。"/" を含むリファレンスは SHA を使用する必要があります。ファイル一覧は常に Compare Commits の要約と一致するため、identical または behind の比較では空の一覧が返され、無関係な履歴の場合は 404 が返されます。結果はデフォルトで 30 ファイル、上限は 100 ファイルです。各ファイルには List Commit Files と同じフィールドが含まれます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

basehead string 必須

"{base}...{head}"。各リビジョンには SHA、ブランチ、タグ、または HEAD のようなシンボリック参照を指定できます。

クエリパラメータ

pageSize integer

返す変更ファイルの最大数。未指定または0の場合はデフォルトで30になります。100を超える値は100に制限されます。

pageToken string

前のレスポンスのnext_page_tokenに由来する不透明なカーソル。最初のページでは空です。このトークンは解決された比較およびファイルカーソルに紐づけられているため、後続のリクエストではbaseheadがトークンと一致している必要があります。Origin は各ページで比較を再解決します。トークン発行後にコミットが移動している場合、リクエストはInvalidArgument (HTTP 400) を返し、一覧は最初のページからやり直す必要があります。後続のリクエストで指定したpageSizeはそのページに適用されます。前のページサイズを維持する場合は省略してください。

レスポンスフィールド

files 配列

ファイル名、ステータス、行数、パッチ、およびリネームまたはコピーされたファイルの previousFilename を含むページ分割された変更ファイル。バイナリパッチは空です。

files[].filename string

変更されたファイルのパス。

files[].status string

変更ステータス: 追加、削除、変更、名前変更、またはコピー。

files[].additions 整数

ファイルの行数を追加しました。

files[].deletions integer

ファイルの削除行数。

files[].changes integer

ファイル内で変更された行の合計数。

files[].patch string

統合形式のパッチ。バイナリファイルの場合は空です。

files[].previousFilename string

ファイルが名前変更またはコピーされたときの以前のパス。

nextPageToken string

次のページ用の不透明なカーソル。これ以上ファイルがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/compare/BASE...HEAD/files' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "files": [    {      "filename": "src/telemetry.ts",      "status": "modified",      "additions": 6,      "deletions": 3,      "changes": 9,      "patch": "@@ -12,6 +12,9 @@\n import { ignite } from \"./ignition\";\n+import { emitLaunchTelemetry } from \"./telemetry\";\n"    }  ]}

コンテンツを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/contents

Scoperepository:contents:readAuthInstallation tokenUser access token

指定したリファレンスにおけるファイルまたはディレクトリの内容を返します。ファイルパスは path クエリパラメータで指定します (ネストしたパスに対応) 。リポジトリのルートディレクトリを指定する場合は、省略するか空欄のままにします。1 MiB (デコード後) を超えるファイルは FailedPrecondition (HTTP 400) で拒否されます。

ファイルにはbase64コンテンツが含まれます。ディレクトリには entries に直接の子要素が含まれます。ディレクトリエントリは type、name、path、sha、size を含む簡略化された子要素です。子パスを取得してそのコンテンツを読み取ります。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

クエリパラメータ

path string

リポジトリのルートからの相対ファイルまたはディレクトリパス。空の場合はルートディレクトリを返します。

ref string

読み取り元のコミット、ブランチ、タグ、またはシンボリックリファレンス (例: HEAD) 。空の場合はリポジトリのデフォルトブランチを使用します。

レスポンスフィールド

type string

コンテンツの種類。file または dir。

encoding string

ファイルエンコーディング。ファイルのレスポンスには base64 を使用します。

size string

デコード後のコンテンツサイズ (バイト) 。API の64ビット整数の規約に従い、JSON文字列としてエンコードされます。1 MiBを超えるファイルペイロードは拒否されます。

name string

ファイルまたはディレクトリのベース名。

path string

リポジトリのルートからの相対パス。

sha string

ファイルの場合は Blob SHA、ディレクトリの場合は tree SHA。

content string

base64エンコードされたファイル本文。取得したファイルに含まれます。

entries array

ディレクトリの直接の簡略化された子要素。エントリには type、name、path、sha、size が含まれます。子パスを取得してそのコンテンツを読み取ります。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/contents' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "type": "file",  "encoding": "base64",  "size": "312",  "name": "telemetry.ts",  "path": "src/telemetry.ts",  "sha": "c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0",  "content": "Y29uc29sZS5sb2coImxhdW5jaCIpOwo="}

コンテンツを一括取得

POST/v1/origin/repos/{ownerSlug}/{repoName}/contents:batchGet

Scoperepository:contents:readAuthInstallation tokenUser access token

1 回のリクエストで、指定したリファレンスにおける複数の明示的なパスのコンテンツを返します。リクエストした各パスについて、見つかったかどうかを示す結果が返されます。見つかったパスには GetContents と同じ Content 形式が含まれます (ファイルは base64、ディレクトリは直下の entries、シンボリックリンクはファイルとして扱います) 。パスは完全一致で照合され、グロブやパターンは使用できません。要求できるパスは最大 20 件で、重複は削除されます。レスポンスの結果はリクエストで最初に現れた順序を保持します。コンテンツを取得の 1 MiB 上限を超える単一のファイルがあると、バッチ全体が FailedPrecondition (HTTP 400) で失敗します。パス一覧がリクエスト本文で送信されるため、POST を使用します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

所有者エンティティ内で一意のリポジトリ名。

リクエスト本文

paths array 必須

リポジトリのルートからの相対パスで取得する正確なパス (glob やパターンは使用できません) 。最大20件まで指定可能で、重複は削除されます。空文字列を指定するとリポジトリのルートディレクトリが要求されます。

ref string

読み取り元のコミット、ブランチ、タグ、またはシンボリック参照 (例: HEAD) 。空の場合はリポジトリのデフォルトブランチを使用します。

レスポンスフィールド

results array

返された各正確なパスごとに1件の結果を返し、最初に見つかったリクエストの順序を保持します。

results[].path string

この結果に対応するリクエストパス。

results[].found boolean

解決されたコミット時点でリクエストされたパスが存在するかどうか。

results[].content オブジェクト

found が true の場合のコンテンツ値。found が false の場合は省略されます。

results[].content.type string

コンテンツの種類: ファイルまたはディレクトリ。

results[].content.encoding string

ファイルのエンコーディング。ファイル応答は base64 を使用します。

results[].content.size string

デコードされたコンテンツのサイズ (バイト単位) 。API の 64 ビット整数規約に従って JSON 文字列としてエンコードされます。1 MiB を超えるファイルペイロードは拒否されます。

results[].content.name string

ファイルまたはディレクトリのベース名。

results[].content.path string

リポジトリのルートからの相対パス。

results[].content.sha string

ファイルの場合は Blob SHA、ディレクトリの場合は tree SHA。

results[].content.content string

Base64 エンコードされたファイル本文。取得したファイルに含まれます。

results[].content.entries array

ディレクトリの直接のスパースな子要素。エントリには type、name、path、sha、size が含まれます。子のパスを取得してその内容を読み取ります。

resolvedCommitSha string

リクエストした ref が解決されたコミット SHA。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/contents:batchGet' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "paths": [    "src/telemetry.ts"  ],  "ref": "main"}'

レスポンスの構造:

{  "results": [    {      "path": "src/telemetry.ts",      "found": true,      "content": {        "type": "file",        "encoding": "base64",        "size": "312",        "name": "telemetry.ts",        "path": "src/telemetry.ts",        "sha": "c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0",        "content": "Y29uc29sZS5sb2coImxhdW5jaCIpOwo="      }    }  ],  "resolvedCommitSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"}

コンテンツをGrep検索

POST/v1/origin/repos/{ownerSlug}/{repoName}:grep

Scoperepository:contents:readAuthInstallation tokenUser access token

指定した ref 時点のリポジトリ内にあるファイルのテキストを検索し、一致した行と、要求された場合は前後のコンテキスト行を返します。検索は行単位で行われ、pattern が改行をまたいで一致することはなく、返される各エントリは 1 行です。リクエストごとにリポジトリ全体がスキャンされるため、ページネーションもカーソルもありません。レスポンスが完全な結果となるのは limitHit が false の場合のみです。ref を持たない空のリポジトリでは、一致は返されず limitHit は false になります。検索パラメータはリクエスト本文で送信されるため、POST を使用します。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

リポジトリ名。オーナーエンティティ内で一意です。

リクエスト本文

ref 文字列

検索対象のコミット、ブランチ、タグ、またはシンボリック参照 (例: HEAD) 。空の場合はリポジトリのデフォルトブランチが対象になります。

query 文字列必須

検索するパターン。デフォルトでは、文字クラス、量指定子、選択 (alternation)、グループ、アンカーをサポートする正規表現として扱われます。テキストを完全一致で検索したい場合は literal を指定してください。空白文字も意味を持ち、指定されたとおりに検索されます。literal が false の場合、大文字小文字を区別しないマッチングはパターンの先頭に (?i) を付けて表し (例: (?i)launch)、単語全体のマッチングはその前後を \b で囲んで表します (例: \blaunch\b)。パターンが空の場合は InvalidArgument (HTTP 400) を返します。UTF-8 の最大サイズ: 4096 バイト。

literal boolean

query を正規表現ではなく完全一致のテキストとして検索します。

caseInsensitive boolean

大文字小文字を同等として扱います。literal が true の場合にのみ適用されます。正規表現検索では無視されるため、代わりに query の先頭に (?i) を記述してください。

wholeWord boolean

単語全体のみ一致させます。literal が true の場合にのみ適用されます。正規表現検索では無視されるため、代わりにパターンの前後に \b を記述してください。

contextBefore integer

各一致行の直前の何行をコンテキストとして返すか。10 を超える値は 10 に丸められます。

contextAfter integer

一致した各行の直後からコンテキストとして返す行数。10 を超える値は 10 に切り捨てられます。

filterPath 文字列

リポジトリのルートからの相対パスで、検索対象をこのファイルまたはディレクトリに限定します。空欄にするとリポジトリ全体を検索します。最大 UTF-8 サイズ: 4096 バイト。

includes 配列

検索対象のパスを指定するグロブパターン。マッチングは大文字小文字を区別しません。/ を含まないパターンは任意の深さでマッチし、* は1つのパスセグメント内にマッチし、** はセグメントをまたいでマッチします。include が1つでも存在する場合、それらのいずれにもマッチしないパスは検索されません。エントリは最大20件。パターンごとの最大 UTF-8 サイズ: 4096 バイト。

excludes 配列

除外するパスを指定するグロブパターン。構文は includes と同じです。exclude は include より優先され、ディレクトリを除外するとその配下はすべて除外されます。エントリは最大20件。パターンごとの最大 UTF-8 サイズ: 4096 バイト。

maxResults integer

返す一致箇所の最大数。0 を指定するとデフォルトの 1000 が適用され、1000 を超える値は 1000 に丸められます。コンテキスト行はこの上限に含まれません。

レスポンスフィールド

matches 配列

一致した行とそのコンテキスト行。ファイルおよび行が返される順序は規定されておらず、同一のリクエストでも異なる場合があります。

matches[].path 文字列

リポジトリのルートからの相対パスで指定するファイルのパス。

matches[].lineNumber integer

ファイル内におけるこの行の行番号 (1 始まり)。

matches[].line 文字列

行のテキスト (末尾の行終端文字を除く) 。

matches[].kind 文字列

この行がマッチを含むか、コンテキストとして返されたか。許可される値: match、context。

matches[].submatches 配列

line 内でマッチが位置する箇所。コンテキスト行では常に空です。limitHit が true の場合、マッチした最後の行にはマッチの一部しか含まれないことがあります。line の範囲を完全に超える範囲は省略され、line の範囲をはみ出す範囲は残りのバイトまでに切り詰められます。

matches[].submatches[].start integer

行内でのマッチの先頭バイトのバイトオフセット。

matches[].submatches[].end integer

行内のマッチの最終バイトの1バイト後を指すバイトオフセット。

limitHit boolean

検索が maxResults に達したかどうか。query、filterPath、または glob リストを絞り込んで、検索対象のファイルを減らしてください。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME:grep' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "ref": "main",  "query": "emitLaunchTelemetry\\(",  "contextBefore": 1,  "contextAfter": 1,  "includes": [    "*.ts"  ],  "excludes": [    "**/node_modules/**"  ],  "maxResults": 50}'

{  "matches": [    {      "path": "src/telemetry.ts",      "lineNumber": 11,      "line": "export function emitLaunchTelemetry(stage: string): void {",      "kind": "match",      "submatches": [        {          "start": 16,          "end": 37        }      ]    },    {      "path": "src/telemetry.ts",      "lineNumber": 12,      "line": "  console.log(\"launch\", stage);",      "kind": "context",      "submatches": []    }  ],  "limitHit": false}

Git データ

低レベルの git オブジェクト。読み取りには repository:contents:read が必要で、空のリポジトリでは 409 が返されます。Create Commit From Files と Create Git Ref は git オブジェクトを書き込むため、repository:contents:write が必要です。

ブランチやタグに加えて、Git リファレンスを取得は pull/{pullNumber}/merge (refs/pull/{pullNumber}/merge に正規化されます) でプルリクエストのマージプレビューを読み取れます。これは、最後の更新時点でプルリクエストの現在の head をそのベースブランチの tip にマージしたコミットです。オリジンは、プルリクエストの作成時、head のプッシュ時、ターゲットの変更時、再オープン時に、対応する pull_request.* webhook イベントが発行される前に、一定の時間内で更新します。時間内に完了しなかった更新では以前の ref がそのまま残り、イベントは引き続き発行されます。ベースブランチが独自に進んだことを理由とする更新は行われず、マージにコンフリクトがある場合はこの ref を削除します。そのため、オープンなプルリクエストで 404 が返される場合は、コンフリクトがあるか、プレビューがまだ準備されていないことを意味します。プルリクエストの各バージョンでは、独自のテストマージも version.potentialMergeCommit で報告され、その state でこの2つのケースを区別できます。プルリクエストを参照してください。プルリクエストの mergeCommitSha は別のコミットであり、マージされた後にのみ設定されます。

Blob を取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/git/blobs/{sha}

Scoperepository:contents:readAuthInstallation tokenUser access token

SHA を指定して Git blob オブジェクトを取得します。デフォルトでは、MIME エンコードされた base64 の content を含む JSON を返します。代わりに生の blob バイトを受け取るには、REST で Accept: application/vnd.origin.raw+json (または application/vnd.origin.raw) を指定します。4 MiB (デコード後) を超える blob は拒否されます。より大きなファイルは、Git HTTPS 経由でリポジトリをクローンして取得してください。空のリポジトリでは 409 Conflict が返されます。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

sha 文字列必須

blob オブジェクトの完全または省略形の 16 進数 SHA。

レスポンスフィールド

sha 文字列

Git blob オブジェクトの SHA。

size integer

JSON 数値としてのデコード後の blob サイズ。4 MiB を超える blob は JSON エンドポイントで拒否されます。

encoding 文字列

JSON blob レスポンスでは base64 エンコーディングを使用します。

content 文字列

base64 エンコードされた blob バイト。呼び出し元は Accept: application/vnd.origin.raw を指定して生のバイトをリクエストできます。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/blobs/SHA' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "sha": "c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0",  "size": 312,  "encoding": "base64",  "content": "Y29uc29sZS5sb2coImxhdW5jaCIpOwo="}

Gitコミットを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/git/commits/{sha}

Scoperepository:contents:readAuthInstallation tokenUser access token

SHA (または解決可能なリビジョン) によって Git コミットオブジェクトを返します。これは低レベルの Git Database のコミット形式 (フラットな author/message/tree) であり、/commits/{sha} の下にある高レベルの GetCommit リソースとは異なります。sha にはコミット SHA、ブランチ、タグ、または HEAD のようなシンボリック参照を指定できます。空のリポジトリは 409 Conflict を返します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

sha string 必須

コミットオブジェクトの完全または短縮された16進数のSHA、またはブランチ、タグ、HEAD のようなシンボリックリファレンス。短縮形は16進数で5文字以上必要で、コミットオブジェクトの中からのみ解決されます。一致するコミットが存在しない場合や、複数のコミットに一致する場合は失敗します。

レスポンスフィールド

sha string

完全な16進数のコミットSHA。

author object

Gitオブジェクトの作成者の署名。

author.name string

Gitの識別情報に記録された名前。

author.email string

GitのIDに記録されたメールアドレス。

author.date string

git署名の元のタイムゾーンオフセットを保持したISO-8601タイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

committer object

Gitオブジェクトからのコミッター署名。

committer.name string

Gitの識別情報に記録された名前。

committer.email string

GitのIDに記録されたメールアドレス。

committer.date string

git署名の元のタイムゾーンオフセットを保持したISO-8601タイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

message string

コミットメッセージ全文。

tree object

このコミットが指すツリー。

tree.sha string

コミットが参照するツリーの SHA。

parents array

親コミットのSHA (ルートコミットの場合は空です) 。

parents[].sha string

親コミットのSHA。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/commits/SHA' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "author": {    "name": "Jane Doe",    "email": "[email protected]",    "date": "2026-08-01T09:30:00Z"  },  "committer": {    "name": "Jane Doe",    "email": "[email protected]",    "date": "2026-08-01T09:30:00Z"  },  "message": "Add launch telemetry",  "tree": {    "sha": "a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8"  },  "parents": [    {      "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"    }  ]}

ファイルから commit を作成

POST/v1/origin/repos/{ownerSlug}/{repoName}/git/commits:createFromFiles

Scoperepository:contents:writeAuthInstallation tokenUser access token

インラインのファイル変更からブランチにコミットを作成し、ブランチをそのコミットまで進めます。

変更は expectedHeadSha の tree に適用され、その tree が新しい commit の parent になります。branch が移動している、または存在しない場合、tree に変化をもたらさない changes の set、tree に存在しない path の delete、push ruleset によって block される write、contents が別の host からミラーリングされている repository のいずれの場合も、FailedPrecondition (HTTP 400) が返されます。

1 回のリクエストで扱えるのは、ファイル変更が最大 1,000 件、1 ファイルあたり 8 MiB、コンテンツ合計 32 MiB までです。上限を超えた場合、同じパスを重複して指定した場合、または形式が不正なフィールドを送信した場合は InvalidArgument (HTTP 400) が返され、google.rpc.BadRequest のフィールド違反で問題のある files[i] エントリが示されます。

ブランチは事前に存在している必要があります。まず Create Git Ref で作成してから、そのブランチにコミットしてください。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意の slug。

repoName string 必須

リポジトリ名。オーナーエンティティ内で一意です。

リクエストボディ

targetBranch string 必須

コミットを受け取るブランチ。<branch>、heads/<branch>、refs/heads/<branch> のいずれかの形式で指定します。ブランチは既に存在している必要があります。HEAD はどの表記でも受け付けられません。

expectedHeadSha string 必須

ターゲットブランチが現在指している必要がある完全な16進SHA。これが新しいコミットの親になります。すべてゼロのSHAは拒否されます。

message string 必須

コミットメッセージ。

author object 必須

コミットの作成者。タイムスタンプはサーバー側で付与されます。

author.name string 必須

Git の ID に記録されている名前。

author.email string 必須

Git IDに記録されているメールアドレス。

committer オブジェクト

コミットのコミッター。省略時は author が使用されます。

committer.name string

Git IDに記録される名前。committer が指定されている場合は必須です。

committer.email string

Git IDに記録されているメールアドレス。committer がある場合は必須です。

files array 必須

ブランチの tip の tree に適用されるファイル変更です。変更は少なくとも 1 つ必要で、パスは 1 つのリクエスト内で一意である必要があります。

files[].path string 必須

/ 区切りで表したリポジトリからの相対パス (例: docs/changelog.md) 。

files[].content string

新しいファイルの内容。files[].encoding に従ってエンコードします。ファイルを作成するか、その内容を置き換えます。files[].content と files[].delete のうち、いずれか一方のみを指定してください。

files[].delete boolean

ファイルを削除します。指定する場合は true にする必要があります。files[].content と files[].delete のうち、いずれか一方のみを指定してください。

files[].encoding string

files[].content のエンコーディング。指定できる値: utf-8 (デフォルト) 、base64。削除の場合は無視されます。

files[].mode string

files[].content のファイルモード。指定できる値は file (デフォルト) 、executable、symlink で、symlink の場合はコンテンツがリンクのターゲットになります。削除の場合は無視されます。

レスポンスフィールド

sha string

新しいコミットの SHA。現在のブランチの tip です。

treeSha string

新しい commit のルート tree の SHA。

previousHeadSha string

書き込み前のブランチ先端。新しいコミットの親になります。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/commits:createFromFiles' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "targetBranch": "feature/login",  "expectedHeadSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "message": "Add login telemetry",  "author": {    "name": "Jane Doe",    "email": "[email protected]"  },  "files": [    {      "path": "src/login/telemetry.ts",      "content": "export const LOGIN_EVENT = 1;"    },    {      "path": "assets/login.png",      "content": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==",      "encoding": "base64"    },    {      "path": "src/login/legacy.ts",      "delete": true    }  ]}'

レスポンスの構造:

{  "sha": "5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9a8b7c6d",  "treeSha": "a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8",  "previousHeadSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"}

Git リファレンスを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/git/ref/{ref}

Scoperepository:contents:readAuthInstallation tokenUser access token

名前で指定した単一の Git リファレンスを返します。ref は通常、heads/<branch> または tags/<tag> (先頭の refs/ の有無は問いません)、あるいはシンボリック HEAD です。完全一致のみをサポートします。プレフィックスで検索する場合は ListMatchingGitRefs を使用してください。空のリポジトリでは 409 Conflict が返されます。

pull/<number>/merge はプルリクエストのマージプレビューです。前回の更新時点におけるベースブランチの先端に、現在の head をマージしたコミットです。これは、プルリクエストがマージされた後にのみ設定されるプルリクエストの mergeCommitSha とは異なるコミットです。プルリクエストの version.potentialMergeCommit は、バージョンごとのテストマージを示します。あるバージョンが最新で、かつその state が prepared である間は、その sha がこのリファレンスの指すコミットになります。

Origin は、プルリクエストの作成時、head のプッシュ時、ターゲット変更時、再オープン時に、対応する pull_request.* webhook イベントが公開される前かつ制限された時間内にプレビューを更新します。更新が時間内に完了しない場合、以前のリファレンスが維持され、イベントは引き続き公開されます。ベースブランチが単に進んだだけでは Origin は更新しません。また、マージ競合がある場合はリファレンスを削除します。そのため、オープン中のプルリクエストでの 404 は、マージ競合があるか、プレビューがまだ準備されていないことを意味します。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

ref 文字列必須

Git リファレンス名。通常は heads/<branch> または tags/<tag> です。先頭の refs/ は受け付けられ、正規化されます。シンボリック HEAD も受け付けられます (ref: "HEAD" として、先端のコミットとともに返されます)。プルリクエストのマージプレビューには pull/<number>/merge も使用できます。完全なリファレンス名との完全一致が必要です。

レスポンスフィールド

ref 文字列

完全なリファレンス名。例: "refs/heads/main"。

object オブジェクト

このリファレンスが直接指すオブジェクト (展開されていないもの) 。注釈付きタグの場合、object.type は "tag"、object.sha はタグオブジェクトの SHA です。

object.sha 文字列

ターゲットオブジェクトの 16 進数 SHA。

object.type 文字列

"commit"、"tree"、"blob"、または "tag" のいずれか。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/ref/REF' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "ref": "refs/heads/main",  "object": {    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "type": "commit"  }}

Git Ref の作成

POST/v1/origin/repos/{ownerSlug}/{repoName}/git/refs

Scoperepository:contents:writeAuthInstallation tokenUser access token

既存の commit を指すブランチリファレンスを作成します。

作成できるのはブランチリファレンスのみです。tag やその他のリファレンス namespace を指定した場合、およびリポジトリ内の commit の完全な hex SHA ではない sha を指定した場合は、InvalidArgument (HTTP 400) を返します。すでに sha を指しているブランチを作成した場合は成功し、既存のリファレンスを返します。別の commit を指すブランチがすでに存在する場合は AlreadyExists (HTTP 409 Conflict) を返します。作成が push ルールセットによってブロックされる場合、またはコンテンツが別の host からミラーリングされているリポジトリでの作成は、FailedPrecondition (HTTP 400) を返します。

Path Parameters

ownerSlug string 必須

所有エンティティの unique slug。

repoName string 必須

オーナーエンティティ内で一意なリポジトリ名。

Request Body

ref string 必須

作成するブランチリファレンス。refs/heads/<branch> または heads/<branch> の形式で指定します。

sha string 必須

新しいブランチが指す既存の commit の完全な hex SHA。

Response Fields

ref string

完全なリファレンス名。例: "refs/heads/main"。

object object

このリファレンスが直接指している object (展開されていないもの) 。ブランチの場合、object.type は "commit" です。

object.sha string

ターゲット object の hex SHA。

object.type string

"commit"、"tree"、"blob"、"tag" のいずれか。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/refs' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "ref": "refs/heads/feature/login",  "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"}'

レスポンスの構造:

{  "ref": "refs/heads/feature/login",  "object": {    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "type": "commit"  }}

Git リファレンスを削除

DELETE/v1/origin/repos/{ownerSlug}/{repoName}/git/refs/{ref}

Scoperepository:contents:writeAuthInstallation tokenUser access token

ブランチのリファレンスを削除します。レスポンス本文は空です。

削除できるのはブランチのリファレンスのみです。存在しないブランチを指定した場合は 404 が返されます。リポジトリのデフォルトブランチ、削除ルールで保護されたブランチ、およびコンテンツが別のホストからミラーリングされたリポジトリでは、FailedPrecondition (HTTP 400) が返されます。削除したブランチを head とするプルリクエストは、push による削除の場合と同様にクローズされます。削除の処理中に tip が移動したブランチは、FailedPrecondition (HTTP 400) または Aborted (HTTP 409 Conflict) で失敗します。新しい tip を削除するには再試行してください。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

ref 文字列必須

削除するブランチのリファレンス。refs/heads/<branch> または heads/<branch> の形式で指定します。

レスポンスフィールド

成功したリクエストではレスポンス本文は返されません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/refs/REF' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンス:

204 No Content

一致する Git リファレンスを一覧表示

GET/v1/origin/repos/{ownerSlug}/{repoName}/git/matching-refs

Scoperepository:contents:readAuthInstallation tokenUser access token

名前が指定したプレフィックスで始まる Git リファレンスを一覧表示します。REST レスポンスは response_body を介して JSON 配列として直接返されます。ref の末尾のスラッシュは保持されます (heads/ → refs/heads/) 。シンボリック HEAD は完全一致で照合されます (refs/ 配下にはありません) 。空のリポジトリでは 409 Conflict が返されます。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

クエリパラメータ

ref 文字列

照合するプレフィックス。通常は heads/<prefix> または tags/<prefix> です。先頭の refs/ は受け付けられ、正規化されます。空の場合はすべてのリファレンスを一覧表示します (末尾のパスセグメントなしの REST バインディング) 。

レスポンスフィールド

レスポンスは配列です。各項目には次が含まれます。

ref 文字列

完全なリファレンス名。例: "refs/heads/main"。

object オブジェクト

このリファレンスが直接指すオブジェクト (展開されていないもの) 。注釈付きタグの場合、object.type は "tag" で、object.sha はタグオブジェクトの SHA です。

object.sha 文字列

ターゲットオブジェクトの 16 進数 SHA。

object.type 文字列

"commit"、"tree"、"blob"、または "tag" のいずれか。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/matching-refs' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "refs": [    {      "ref": "refs/heads/main",      "object": {        "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",        "type": "commit"      }    }  ]}

パスで一致する Git リファレンスを一覧表示

GET/v1/origin/repos/{ownerSlug}/{repoName}/git/matching-refs/{ref}

Scoperepository:contents:readAuthInstallation tokenUser access token

指定したプレフィックスで名前が始まる Git リファレンスを一覧表示します。REST レスポンスは response_body を介して JSON 配列として直接返されます。ref の末尾のスラッシュは保持されます (heads/ → refs/heads/) 。シンボリック HEAD は完全一致で照合されます (refs/ 配下にはありません) 。空のリポジトリでは 409 Conflict が返されます。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

ref 文字列必須

照合するプレフィックス。通常は heads/<prefix> または tags/<prefix> を指定します。先頭の refs/ は指定可能で、正規化されます。空の場合はすべてのリファレンスを一覧表示します (末尾のパスセグメントなしの REST バインディング) 。

レスポンスフィールド

レスポンスは配列です。各項目には以下が含まれます。

ref 文字列

完全なリファレンス名。例: "refs/heads/main"。

object オブジェクト

object.sha 文字列

ターゲットオブジェクトの 16 進数 SHA。

object.type 文字列

"commit"、"tree"、"blob"、または "tag" のいずれか。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/matching-refs/REF' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "refs": [    {      "ref": "refs/heads/main",      "object": {        "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",        "type": "commit"      }    }  ]}

タグを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/git/tags/{sha}

Scoperepository:contents:readAuthInstallation tokenUser access token

SHA で指定した注釈付き Git タグオブジェクトを返します。軽量タグはタグオブジェクトではないため、NotFound が返されます。空のリポジトリでは 409 Conflict が返されます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

sha string 必須

注釈付きタグオブジェクトの完全な、または省略形式の 16 進数 SHA。

レスポンスフィールド

sha string

タグオブジェクトの SHA (16 進数) 。

tag string

タグ名 (例: "v1.0") 。

message string

タグメッセージ。

tagger object

タグオブジェクトに記録されたタグ作成者の署名。

tagger.name string

Git ID に記録された名前。

tagger.email string

Git ID に記録されたメールアドレス。

tagger.date string

Git 署名の元のタイムゾーンオフセットを保持する ISO-8601 タイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

object object

このタグが指すオブジェクト。

object.sha string

ターゲットオブジェクトの 16 進数 SHA。

object.type string

"commit"、"tree"、"blob"、または "tag" のいずれか。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/tags/SHA' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "sha": "e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2",  "tag": "v1.2.0",  "message": "Release v1.2.0",  "tagger": {    "name": "Jane Doe",    "email": "[email protected]",    "date": "2026-08-01T09:30:00Z"  },  "object": {    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "type": "commit"  }}

ツリーを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/git/trees/{sha}

Scoperepository:contents:readAuthInstallation tokenUser access token

SHA または解決可能なリビジョンで Git ツリーオブジェクトを返します。sha にはツリー SHA、コミット SHA、ブランチ、タグ、または HEAD のようなシンボリック ref を指定できます。recursive=true (または 1) を設定するとツリー全体を走査します。パラメータを省略するか他の値を渡すと直下の子のみが一覧表示されます。再帰的な一覧は 100,000 エントリまたは 7 MiB で切り詰められ、truncated=true が設定されます。空のリポジトリでは 409 Conflict が返されます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーに対して一意のリポジトリ名。

sha string 必須

ツリー SHA、コミット SHA、ブランチ、タグ、または HEAD のようなシンボリックリファレンス。

クエリパラメータ

recursive boolean

true の場合、ツリー全体を再帰的に巡回して返します。クエリ値 true または 1 を指定すると再帰が有効になります。パラメータを省略するか、false や 0 を含むそれ以外の値を指定した場合は、直接の子のみが一覧表示されます。

レスポンスフィールド

sha string

ツリーオブジェクトの SHA (16進数) 。

tree array

このツリー配下のエントリ (直下の子、またはツリー全体の再帰的走査) 。

tree[].path string

リクエストされたツリーのルートからの相対パス。

tree[].mode string

8進数文字列としての Git モード: "100644"、"100755"、"040000"、"120000"、"160000"。

tree[].type string

"blob"、"tree"、または"commit" (gitlink/サブモジュール) のいずれか。

tree[].sha string

オブジェクト SHA (16進)。

tree[].size integer

Blob のサイズ (バイト) 。ツリーおよび gitlink では未設定です。int32 により REST JSON は数値を出力します。個々の blob が 2 GiB を超える場合は表現できません。

truncated boolean

再帰的なツリー一覧が省略されている場合に true となることがあります。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/trees/SHA' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "sha": "a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8",  "tree": [    {      "path": "src/telemetry.ts",      "mode": "100644",      "type": "blob",      "sha": "c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0",      "size": 312    }  ],  "truncated": false}

Grants

grant は、1 つの principal を 1 つのリポジトリまたは 1 つの owner に、1 つの permission で結び付けるものです。これらの endpoint は resource に直接設定された grant を read、set、remove するため、access の変更をコードと同じようにスクリプト化して確認できます。write は Codebase permissions UI の背後にあるチェックを再利用し、repository.access_changed と namespace.access_changed という同じ audit イベントを記録します。principal の種類、2 つの permission 階層、owner レベルの grant とリポジトリレベルの grant の関係については、Origin Grants API を参照してください。

リポジトリのグラント一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/grants

Scoperepository:settings:readAuthInstallation tokenUser access token

リポジトリに対して直接付与された権限を持つユーザー、グループ、所有チームのグループを一覧表示します。リポジトリのオーナーから継承された権限は含まれません。

パスパラメーター

ownerSlug string 必須

所有エンティティの一意な slug。

repoName string 必須

リポジトリ名。オーナーエンティティ内で一意です。

クエリパラメータ

pageSize integer

返す grants の最大数。未設定または 0 の場合は 30 がデフォルトです。100 を超える値は 100 に制限されます。

pageToken string

前のレスポンスの next_page_token から取得した opaque cursor。最初のページでは空にします。後続のリクエストで pageSize を指定すると、そのページに適用されます。前のページサイズを維持する場合は省略してください。

レスポンスフィールド

grants 配列

リポジトリに直接付与されているグラントです。プリンシパルの種類 (グループ、所有チームの管理者、所有チームのメンバー、ユーザー) の順に並び、次に ID 順に並びます。アクティブなユーザー、グループ、または所有チームに解決されなくなったプリンシパルは省略されるため、1 ページに含まれるグラント数が pageSize 未満になることがあります。

grants[].user object

ユーザー principal。user、group、teamGroup のうち、いずれか 1 つのみが存在します。

grants[].user.id string

ユーザーの公開識別子。プレフィックスはuser_です。

grants[].user.email string

ユーザーのメールアドレス。

grants[].user.displayName string

grants[].user.handle string

ユーザーが取得済みのプロフィールハンドル (@ プレフィックスなし) 。そのプロフィールが公開されている間のみ含まれ、それ以外の場合は省略されます。

grants[].group オブジェクト

Cherri Code のグループのプリンシパルです。所有者のチームが所有するグループ、またはそのチームの組織内のグループを指します。

grants[].group.id string

グループの公開識別子。grp_ のプレフィックスが付きます。

grants[].teamGroup オブジェクト

所有元チームの組み込みグループの 1 つ。リポジトリ自体に対して付与されるもので、オーナーから継承されたものとは別のものです。

grants[].teamGroup.kind string

grant を保持する built-in グループ。指定可能な値: members、admins。

grants[].permission string

プリンシパルがリポジトリに対して持つ権限。指定可能な値: read、write、admin、custom。custom はカスタムポリシーを示し、Upsert Repository Grant では受け入れられません。

repository object

このレスポンス内の各grantが属するリポジトリ。Get Repo と同じフィールドを持ちます。

nextPageToken string

次のページを取得するための opaque cursor。以降のページがない場合は空になります。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/{ownerSlug}/{repoName}/grants' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "grants": [    {      "group": {        "id": "grp_01k2ja2000e0080000000000n2"      },      "permission": "admin"    },    {      "teamGroup": {        "kind": "admins"      },      "permission": "admin"    },    {      "teamGroup": {        "kind": "members"      },      "permission": "write"    },    {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      },      "permission": "read"    }  ],  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  },  "nextPageToken": ""}

リポジトリのグラントをアップサート

POST/v1/origin/repos/{ownerSlug}/{repoName}/grants

Scoperepository:settings:writeAuthInstallation tokenUser access token

ユーザー、グループ、または所有チームのグループがリポジトリに対して直接保持する権限を設定し、そのプリンシパルに以前直接付与されていた権限を置き換えます。プリンシパルがすでに保持している権限を再度付与した場合も、変更は発生せず成功します。ユーザーはリポジトリ所有者のチームまたは組織の有効なメンバーである必要があります。グループは所有者のチームが所有するグループ、またはそのチームの組織の有効なグループである必要があります。条件を満たさない場合、リクエストは FailedPrecondition (HTTP 400) を返します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意の slug。

repoName string 必須

リポジトリ名。オーナーエンティティ内で一意である必要があります。

リクエストボディ

user オブジェクト

ユーザープリンシパル。user、group、または teamGroup のうち正確に1つが存在します。

user.id string

ユーザーの公開識別子。接頭辞は user_ です。

user.email string

ユーザーのメールアドレス。

user.displayName string

ユーザーの表示名: アカウントの名と姓をスペースで連結した名前で、製品上に表示される名前と同じです。アカウントに名前が設定されていない場合は省略されます。

user.handle string

group オブジェクト

Cherri Code のグループプリンシパル: 所有者のチームが所有するグループ、またはそのチームの組織に属するグループ。

group.id string

グループの公開識別子。プレフィックスは grp_ です。

teamGroup オブジェクト

所有チームの組み込みグループのうちの1つで、リポジトリ自体に付与され、オーナーから継承されるものとは別のものです。

teamGroup.kind string

grant を保持する built-in グループ。指定可能な値: members、admins。

permission string 必須

付与する権限。指定可能な値: read、write、admin。custom は InvalidArgument (HTTP 400) を返します。カスタムポリシーはこの API の対象外です。

レスポンスフィールド

user オブジェクト

ユーザープリンシパル。user、group、teamGroup のうち、必ず 1 つだけが含まれます。

user.id string

ユーザーの公開識別子。プレフィックスは user_ です。

user.email string

ユーザーのメールアドレス。

user.displayName string

user.handle string

ユーザーが主張するプロフィールのハンドル (@ プレフィックスは含まない) 。そのプロフィールが公開されている間のみ表示され、それ以外の場合は省略されます。

group オブジェクト

Cherri Code のグループ主体: 所有者のチームが所有するグループ、またはそのチームの組織内のグループ。

group.id string

グループの公開識別子。プレフィックスは grp_ です。

teamGroup オブジェクト

所有チームの組み込みグループのうちの1つで、リポジトリ自体に付与され、オーナーから継承されるグループとは別のものです。

teamGroup.kind string

grant を保持する組み込みグループ。許可される値: members、admins。

permission string

プリンシパルが現在リポジトリに対して保持している権限です。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/grants' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "user": {    "id": "user_01k2ja2000e0080000000000c3"  },  "permission": "write"}'

レスポンスの構造:

{  "user": {    "id": "user_01k2ja2000e0080000000000c3",    "email": "[email protected]"  },  "permission": "write"}

リポジトリの Grant を削除

DELETE/v1/origin/repos/{ownerSlug}/{repoName}/grants

Scoperepository:settings:writeAuthInstallation tokenUser access token

user、group、または所有チームの group がリポジトリに対して直接保持している権限を削除します。リポジトリの owner から継承された権限は影響を受けないため、所有チームの group は owner レベルの default に戻ります。principal が直接保持していない権限を削除した場合も、変更は行われずに成功します。レスポンスの body は空です。

Path Parameters

ownerSlug string Required

所有エンティティの一意な slug。

repoName string Required

オーナーエンティティ内で一意な repo 名。

Request Body

user object

user の principal。user、group、teamGroup のいずれか 1 つだけが含まれます。

user.id string

user の public 識別子。user_ のプレフィックスが付きます。

user.email string

user の email アドレス。

user.displayName string

user の display name。account の姓と名をスペースで連結したもので、製品上で表示される名前と同じです。account に名前が設定されていない場合は省略されます。

user.handle string

user が取得した profile の handle (@ プレフィックスなし) 。その profile が public に表示されている間のみ含まれ、それ以外では省略されます。

group object

Cherri Code group の principal。owner のチームが所有する group、またはそのチームの organization 内の group です。

group.id string

group の public 識別子。grp_ のプレフィックスが付きます。

teamGroup object

所有チームの built-in グループのいずれか。リポジトリ自体に付与されたもので、owner から継承されたものとは区別されます。

teamGroup.kind string

どの built-in グループが grant を保持しているか。指定可能な値: members、admins。

Response Fields

成功したリクエストは response body を返しません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/grants' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "group": {    "id": "grp_01k2ja2000e0080000000000n2"  }}'

レスポンス:

204 No Content

namespace の grants 一覧を取得

GET/v1/origin/owners/{ownerSlug}/grants

Scopenamespace:settings:readAuthInstallation tokenUser access token

オーナーへのアクセス権が付与されている対象 (ユーザー、グループ、および所有チームの組み込みの admin グループと member グループ) を一覧表示します。各付与は、そのオーナー配下のすべてのリポジトリに対してその権限を与えます。個々のリポジトリに対して行われた付与は含まれません。そちらは List Repository Grants を参照してください。

パスパラメータ

ownerSlug string 必須

グラントを一覧表示する対象の所有者の slug。

クエリパラメータ

pageSize integer

返すグラントの最大数。未設定または 0 の場合は 30 がデフォルトです。100 を超える値は 100 に制限されます。

pageToken string

前回のレスポンスの next_page_token からの不透明なカーソル。最初のページでは空です。後続のリクエストで指定した pageSize はそのページに適用されます。省略すると前回のページサイズが維持されます。

レスポンスフィールド

grants 配列

このページの grant。Admin の grant が先頭に並び、各 run 内では principal の種類 (group、所有チームの admin、所有チームの member、user) 順、続いて id 順に並びます。有効な user、group、所有チームに解決できなくなった principal は除外されるため、1 ページに含まれる grant が pageSize 未満になる場合があります。

grants[].user object

ユーザー主体。user、group、または teamGroup のうち、正確に 1 つのみが存在します。

grants[].user.id string

ユーザーの公開識別子。接頭辞は user_ です。

grants[].user.email string

ユーザーのメールアドレス。

grants[].user.displayName string

ユーザーの表示名。アカウントの名と姓をスペースでつないだもので、製品上で表示される名前と同じです。アカウントに名前が設定されていない場合は省略されます。

grants[].user.handle string

grants[].group オブジェクト

Cherri Code のグループプリンシパル: 所有者のチームが所有するグループ、またはそのチームの組織に所属するグループ。

grants[].group.id string

グループの公開識別子。プレフィックスはgrp_です。

grants[].teamGroup オブジェクト

所有チームの built-in グループのいずれか。チームがオーナーに対して持つデフォルトのアクセス権です。

grants[].teamGroup.kind string

grant を保持する built-in グループ。指定可能な値: members、admins。

grants[].permission string

principal が owner 配下のすべてのリポジトリに対して保持する permission。指定可能な値: PERMISSION_READ、PERMISSION_CONTRIBUTOR、PERMISSION_WRITE、PERMISSION_ADMIN、PERMISSION_CUSTOM。PERMISSION_CUSTOM は custom policy が設定されていることを示し、この値は Upsert Namespace Grant では受け入れられません。

nextPageToken string

次のページの不透明なカーソル。これ以上ページがない場合は空になります。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/owners/{ownerSlug}/grants' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "grants": [    {      "group": {        "id": "grp_01k2ja2000e0080000000000n2"      },      "permission": "PERMISSION_ADMIN"    },    {      "teamGroup": {        "kind": "admins"      },      "permission": "PERMISSION_ADMIN"    },    {      "teamGroup": {        "kind": "members"      },      "permission": "PERMISSION_CONTRIBUTOR"    },    {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      },      "permission": "PERMISSION_WRITE"    }  ],  "nextPageToken": ""}

Namespace Grant の Upsert

POST/v1/origin/owners/{ownerSlug}/grants

Scopenamespace:settings:writeAuthInstallation tokenUser access token

ユーザー、グループ、または所有チームのグループが所有者に対して直接保持する権限を設定し、それまでにそのプリンシパルに直接付与されていた権限を置き換えます。プリンシパルがすでに保持している付与を繰り返して行っても、変更はなく成功します。ユーザーが所有チームまたはその組織のアクティブなメンバーでない場合、グループがそのチームに所有されておらずその組織のアクティブなグループでもない場合、または書き込みにより所有者に管理者がいなくなる場合、リクエストは FailedPrecondition (HTTP 400) を返します。

パスパラメータ

ownerSlug string 必須

オーナーの slug。

リクエストボディ

user オブジェクト

ユーザーのプリンシパルです。user、group、teamGroup のうち正確に 1 つが存在します。

user.id string

ユーザーの公開識別子。プレフィックスは user_ です。

user.email string

ユーザーのメールアドレス。

user.displayName string

user.handle string

ユーザーが取得したプロフィールのハンドル (@ プレフィックスなし) 。そのプロフィールが公開されている間のみ含まれ、それ以外の場合は省略されます。

group オブジェクト

Cherri Code のグループプリンシパル：所有者のチームが所有するグループ、またはそのチームの組織に属するグループ。

group.id string

グループの公開識別子。接頭辞は grp_ です。

teamGroup オブジェクト

所有チームの組み込みグループの一つ: オーナーに対するチームのデフォルトのアクセス権。

teamGroup.kind string

grant を保持する組み込みグループ。指定可能な値: members、admins。

permission string 必須

付与する権限。指定可能な値: PERMISSION_READ、PERMISSION_CONTRIBUTOR、PERMISSION_WRITE、PERMISSION_ADMIN。PERMISSION_READ、PERMISSION_CONTRIBUTOR、PERMISSION_WRITE は owner の internal リポジトリに対してそのレベルの権限を付与し、PERMISSION_ADMIN は owner 自体を管理します。PERMISSION_CUSTOM を指定すると InvalidArgument (HTTP 400) が返されます。

レスポンスフィールド

user オブジェクト

ユーザープリンシパル。user、group、または teamGroup のうち正確に1つが存在します。

user.id string

ユーザーの公開識別子。プレフィックスは user_ です。

user.email string

ユーザーのメールアドレス。

user.displayName string

ユーザーの表示名。アカウントの名と姓をスペースで連結したもので、製品上で表示される名前と同じです。アカウントに名前が設定されていない場合は省略されます。

user.handle string

ユーザーが主張するプロフィールのハンドル (@ プレフィックスなし) 。そのプロフィールが公開されている間のみ表示され、それ以外の場合は省略されます。

group オブジェクト

Cherri Code のグループプリンシパル: 所有者のチームが所有するグループ、またはそのチームの組織内のグループ。

group.id string

グループの公開識別子。grp_ というプレフィックスが付きます。

teamGroup オブジェクト

所有チームの built-in グループのいずれか。オーナーに対するチームのデフォルトのアクセス権です。

teamGroup.kind string

grant を保持する組み込みグループ。許可される値: members、admins。

permission string

プリンシパルがオーナー配下のすべてのリポジトリに対して現在保持している権限。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/owners/OWNER_SLUG/grants' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "user": {    "id": "user_01k2ja2000e0080000000000c3"  },  "permission": "PERMISSION_WRITE"}'

レスポンスの構造:

{  "user": {    "id": "user_01k2ja2000e0080000000000c3",    "email": "[email protected]"  },  "permission": "PERMISSION_WRITE"}

Namespace grant の削除

DELETE/v1/origin/owners/{ownerSlug}/grants

Scopenamespace:settings:writeAuthInstallation tokenUser access token

user、group、または owning-team group が owner に対して直接保持している permission を削除します。リポジトリごとの grant には影響しません。principal が直接保持していない permission を削除した場合も、変更なしで成功します。owner に admin が 1 人もいなくなるような削除は FailedPrecondition (HTTP 400) を返します。レスポンス本文は空です。

パスパラメータ

ownerSlug 文字列 Required

Owner の slug。

リクエスト本文

user オブジェクト

user principal。user、group、teamGroup のうち、いずれか 1 つのみが存在します。

user.id 文字列

user の公開識別子。プレフィックスは user_。

user.email 文字列

user の email address。

user.displayName 文字列

user の display name。account の姓と名をスペースで結合したもので、製品上で表示される名前と同じです。account に名前が設定されていない場合は省略されます。

user.handle 文字列

user が取得した profile の handle (@ プレフィックスなし) 。その profile が公開されている間のみ存在し、それ以外では省略されます。

group オブジェクト

Cherri Code group の principal。owner のチームが所有する group、またはそのチームの organization 内の group です。

group.id 文字列

group の公開識別子。プレフィックスは grp_。

teamGroup オブジェクト

owning team の built-in グループのいずれか。owner に対するチームの default アクセスを表します。

teamGroup.kind 文字列

grant を保持している built-in グループ。指定可能な値: members、admins。

レスポンスフィールド

成功した requests はレスポンス本文を返しません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/owners/OWNER_SLUG/grants' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "group": {    "id": "grp_01k2ja2000e0080000000000n2"  }}'

レスポンス:

204 No Content

ラベル

ラベル定義は1つのリポジトリに属し、名前で指定します。プルリクエストへのラベルの割り当ては別の機能です。プルリクエストのラベルを設定を参照してください。

ラベルを一覧表示

GET/v1/origin/repos/{ownerSlug}/{repoName}/labels

Scoperepository:labels:readAuthInstallation tokenUser access token

リポジトリに定義されているラベルを名前順に一覧表示します。

ページトークンは、発行先のリポジトリに紐付けられます。別のリポジトリに対して再利用されたトークンや、その他の不正なトークンでは InvalidArgument (HTTP 400) が返されます。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

クエリパラメータ

pageSize integer

返すラベルの最大数。省略時またはゼロの場合はデフォルトで30となり、100を超える値は100に制限されます。

pageToken 文字列

前のレスポンスの nextPageToken で返された不透明なカーソル。最初のページでは省略します。後続のリクエストで pageSize を指定すると、そのページに適用されます。前回のページサイズを引き継ぐ場合は省略してください。

レスポンスフィールド

labels 配列

名前順のラベル定義のページ。

labels[].id 文字列

ラベルの公開識別子。

labels[].name 文字列

リポジトリ内で一意のラベル名。読み取りおよび書き込みエンドポイントでは、名前でラベルを指定します。

labels[].color 文字列

先頭の # を除く6桁の16進数カラーコード。

labels[].description 文字列

ラベルの説明。ラベルに説明がない場合は含まれません。

nextPageToken 文字列

次のページ用の不透明なカーソル。結果がこれ以上ない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/labels' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "labels": [    {      "id": "lbl_01k2ja2000e0080000000000m1",      "name": "bug",      "color": "d73a4a",      "description": "Something isn't working"    }  ]}

ラベルを作成

POST/v1/origin/repos/{ownerSlug}/{repoName}/labels

Scoperepository:labels:writeAuthInstallation tokenUser access token

リポジトリにラベルを作成します。

リポジトリ内の別のラベルですでに使用されている名前を指定すると、AlreadyExists (HTTP 409 Conflict) が返されます。color が6桁の16進数でない場合、name が50文字を超える場合、または description が255文字を超える場合は、InvalidArgument (HTTP 400) が返されます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

リクエスト本文

name string 必須

ラベル名。先頭と末尾の空白はトリミングされます。最大長: 50文字。

color string 必須

先頭の # を除く6文字の16進数カラーコード。大文字の入力は小文字で保存されます。

description string

ラベルの説明。最大長: 255文字。

レスポンスフィールド

id string

ラベルの公開識別子。

name string

リポジトリ内で一意のラベル名。読み取りおよび書き込みエンドポイントでは、この名前でラベルを指定します。

color string

先頭の # を除く6文字の16進数カラーコード。

description string

ラベルの説明。説明がない場合は含まれません。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/labels' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "name": "bug",  "color": "d73a4a",  "description": "Something isn'\''t working"}'

レスポンスの構造:

{  "id": "lbl_01k2ja2000e0080000000000m1",  "name": "bug",  "color": "d73a4a",  "description": "Something isn't working"}

ラベルを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/labels/{labelName}

Scoperepository:labels:readAuthInstallation tokenUser access token

名前を指定して単一のリポジトリラベルを取得します。

名前が不明な場合は 404 を返します。labelName が空の場合は InvalidArgument (HTTP 400) を返します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

所有エンティティ内で一意のリポジトリ名。

labelName string 必須

ラベル名。検索前に先頭と末尾の空白がトリミングされます。

レスポンスフィールド

id string

ラベルの公開識別子。

name string

リポジトリ内で一意のラベル名。読み取りおよび書き込みエンドポイントでは、この名前でラベルを指定します。

color string

先頭の # を除く6文字の16進数カラーコード。

description string

ラベルの説明。説明がない場合は含まれません。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/labels/LABEL_NAME' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "lbl_01k2ja2000e0080000000000m1",  "name": "bug",  "color": "d73a4a",  "description": "Something isn't working"}

ラベルを削除

DELETE/v1/origin/repos/{ownerSlug}/{repoName}/labels/{labelName}

Scoperepository:labels:writeAuthInstallation tokenUser access token

名前でリポジトリのラベルを削除します。レスポンス本文は空です。

ラベルを削除すると、割り当てられているすべてのプルリクエストからも削除されます。不明な名前を指定すると 404 が返されます。labelName が空の場合は InvalidArgument (HTTP 400) が返されます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意の slug。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

labelName string 必須

ラベル名。検索前に先頭と末尾の空白がトリミングされます。

レスポンスフィールド

成功したリクエストではレスポンス本文は返されません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/labels/LABEL_NAME' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンス:

204 No Content

ラベルを更新

PATCH/v1/origin/repos/{ownerSlug}/{repoName}/labels/{labelName}

Scoperepository:labels:writeAuthInstallation tokenUser access token

現在の名前で指定したリポジトリラベルを更新します。

省略したフィールドは変更されません。3つのフィールドをすべて省略した場合は、現在のラベルがそのまま返されます。別のラベルですでに使用されている名前に変更すると、AlreadyExists (HTTP 409 Conflict) が返されます。不明なlabelNameを指定した場合は404が返されます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のslug。

repoName string 必須

所有エンティティ内で一意のリポジトリ名。

labelName string 必須

現在のラベル名。検索前に先頭と末尾の空白はトリミングされます。

リクエスト本文

name string

新しいラベル名。先頭と末尾の空白はトリミングされます。最大50文字。変更しない場合は省略します。

color string

先頭の#を除く6文字の16進数カラーコード。変更しない場合は省略します。

description string

ラベルの説明。最大255文字。変更しない場合は省略します。

レスポンスフィールド

id string

ラベルの公開識別子。

name string

リポジトリ内で一意のラベル名。読み取りおよび書き込みエンドポイントでは、この名前でラベルを指定します。

color string

先頭の#を除く6文字の16進数カラーコード。

description string

ラベルの説明。説明がないラベルでは返されません。

curl --request PATCH \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/labels/LABEL_NAME' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "color": "b60205"}'

レスポンスの構造：

{  "id": "lbl_01k2ja2000e0080000000000m1",  "name": "bug",  "color": "b60205",  "description": "Something isn't working"}

プルリクエスト

クローズまたはマージされたプルリクエストには、closedAt、mergedAt、mergeCommitSha が追加で含まれる場合があります。head.ref と base.ref は不透明な Origin リファレンス文字列として扱ってください。短いブランチ名の場合もあれば、完全修飾された refs/heads/… 値の場合もあります。

version は、そのプルリクエストの最新の番号付きリビジョンです。head がプッシュされたとき、プルリクエストが別の base に再ターゲットされたとき、およびクローズ中に head が移動したプルリクエストが再オープンされたときに、Origin は新しいバージョンを記録し、それぞれが独自の headSha、baseSha、diff 統計を持ちます。バージョンを記録する再オープンでは、プッシュ時と同じイベントである pull_request.head_ref.pushed が送信されます。base ブランチが単独で進んでも何も記録されないため、version.baseSha (およびそれをミラーする base.sha) は、そのバージョンが記録された時点で解決された base の tip であり、次のバージョンが記録されるまで、ブランチの現在の tip より遅れることがあります。ブランチの現在の tip は Get Git Ref で取得してください。

mergeCommitSha は、マージが base ブランチに書き込んだコミットです。マージされると設定され、それ以前は未設定です。マージ前のプレビューは pull/{pullNumber}/merge リファレンスであり、別のコミットです。Git data を参照してください。

version.potentialMergeCommit は、そのバージョンに対する Origin のテストマージの状態を示します。状態は prepared、merge_conflict、unknown のいずれかで、prepared の場合はマージコミットの sha と、その作成に使用された baseSha も示します。対象はそのバージョンだけなので、プルリクエストがマージされた後も報告されます。pull_request.* のウェブフックペイロードには、イベント時点の値が含まれます。イベントがテストマージの準備を待つ時間には上限があるため、後からプルリクエストを取得すると prepared と表示される場合でも、イベントでは unknown となることがあります。プルリクエストを再取得するか、次のイベントを待ってください。

確認の verdict は approve、request_changes、comment のいずれかです。未送信の下書き確認には submittedAt はありません。判定が有効な間、dismissal はありません。却下された確認も確認一覧に表示され続けます。新しい判定によって自動的に置き換えられた確認には、サーバー生成のメッセージが付与されます。

コメントには、グループ化用の thread リファレンスが含まれます。返信時のコメント作成リクエストでは、引き続きスカラーの threadId コマンドパラメータを受け付けます。プルリクエスト Thread を更新してスレッドを解決または再オープンします。

プルリクエストの一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls

Scoperepository:pull_requests:readAuthInstallation tokenUser access token

リポジトリ内のプルリクエストを一覧表示します。head ブランチ、base ブランチ、作成者、作成日時の範囲、状態で任意に絞り込めます。各プルリクエストには割り当てられたラベルが含まれます。

結果は、sortBy で作成順または最終更新順を選択して並べ替えられ、いずれも新しいものが先に表示されます。逆順にするには direction=asc を設定してください。ページトークンには発行時のソート順とフィルターが埋め込まれているため、異なるソート順またはフィルターの組み合わせでトークンを再利用すると拒否されます。どちらかを変更した場合は、ページネーションを最初からやり直してください。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

クエリパラメータ

head string

完全一致するブランチ (head-ref) のフィルター (任意) 。省略するとすべてのブランチを一覧表示します。

state string

ライフサイクルフィルター。指定できる値: open (デフォルト) 、closed、merged、all。closed は、マージ済みのものも含め、オープンでなくなったすべてのプルリクエストを対象とします。merged はマージ済みのプルリクエストだけに絞り込みます。その他の値を指定すると InvalidArgument (HTTP 400) が返されます。

pageSize 整数

返す結果の最大件数。デフォルトは30、最大は100です。

pageToken 文字列

前のレスポンスの nextPageToken による不透明なカーソル。最初のページでは省略してください。後続のリクエストに指定した pageSize はそのページに適用されます。省略した場合は前のページサイズが維持されます。

author string

任意の作成者フィルター。このエンドポイントが pullRequests[].author.user.id、pullRequests[].author.app.id、または pullRequests[].author.serviceAccount.id として返す公開アクター ID (user_…、app_…、または sa_…) をそのまま渡すか、ユーザーの正確なメールアドレスを指定してください。メールアドレスの照合では大文字と小文字が区別されません。アプリとサービスアカウントにはメールアドレスの識別情報がないため、この方法で選択できるのはユーザーの作成者のみです。プルリクエストがない作成者を指定した場合や、メールアドレスから単一のユーザーを特定できない場合は、空のリストが返されます。共有の origin-cursor-managed-actor ID を含むその他の値を指定すると、InvalidArgument (HTTP 400) が返されます。

base string

完全一致のベースブランチフィルター (任意)。短い名前 (main) または完全修飾リファレンス (refs/heads/main) を受け付けます。省略すると全てのベースにわたって一覧表示されます。

direction string

sortBy に沿ったソート方向。デフォルトは "desc" で、sortBy=created では作成が新しい順、sortBy=updated では更新が新しい順に返します。"asc" はそれぞれ逆順になります。その他の値は InvalidArgument (HTTP 400) を返します。

since string

作成時刻の下限 (指定した時刻を含む、任意) 。2026-08-01T00:00:00Z のような RFC 3339 形式のタイムスタンプで指定します。その時点以降に作成されたプルリクエストのみが返されます。形式が不正なタイムスタンプを指定すると InvalidArgument (HTTP 400) が返されます。

until 文字列

since と同じ RFC 3339 形式で指定する、作成時刻の上限値 (任意、指定時刻を含む) 。その時点以前に作成されたプルリクエストのみを返します。形式が不正なタイムスタンプを指定すると InvalidArgument (HTTP 400) が返されます。

sortBy string

ソートキー。指定できる値は created (作成順、デフォルト) または updated (最終更新時刻) です。その他の値は InvalidArgument (HTTP 400) を返します。

headSha 文字列

任意の head コミットフィルター: プルリクエストの head の完全な 40 文字または 64 文字の 16 進 SHA。大文字小文字を区別せずに照合されます。記録されているいずれかのバージョン (現在のものまたは置き換えられたもの) にその head コミットが含まれている場合にプルリクエストを選択します。両者を区別するには、各結果の head.sha を比較してください。他のフィルターは引き続き適用され、state のデフォルトは open です。マージ済みおよびクローズ済みのプルリクエストを取得するには state=all を指定してください。形式が不正な SHA、省略された SHA、未知の SHA は一致しません。

stackId 文字列

スタックフィルター (任意) ：pullRequests[].stack.id で返されるスタック ID を指定します。そのスタックのメンバーのみを、スタック順ではなく要求されたソート順で返すため、各メンバーの stack.parentPullRequest からスタックを再構築してください。state のデフォルトは引き続き open で、マージ済みのメンバーは除外されます。スタック全体を取得するには state=all を指定してください。このリポジトリ内に存在しないスタックを示す、形式が正しい ID を指定した場合は空のリストを返し、それ以外の値を指定した場合は InvalidArgument (HTTP 400) を返します。

レスポンスフィールド

pullRequests 配列

PullRequest のスナップショットのページ。レスポンス番号とバージョン番号は JSON 文字列です。

pullRequests[].id string

Stable Origin のプルリクエスト識別子。

pullRequests[].number string

JSON文字列としてエンコードされたリポジトリローカルのプルリクエスト番号。

pullRequests[].state string

プルリクエストの状態 (オープンまたはクローズ) 。マージ済みのプルリクエストはクローズ状態となり、merged は true に設定されます。

pullRequests[].draft boolean

プルリクエストがドラフトかどうか。

pullRequests[].merged boolean

プルリクエストがマージされているかどうか。

pullRequests[].title string

プルリクエストのタイトル。

pullRequests[].body string

プルリクエストの説明本文。

pullRequests[].head オブジェクト

変更元 — マージされる内容。

pullRequests[].head.ref string

Origin に記録されている、この側の ref が指す対象。

pullRequests[].head.sha string

変更の最新版におけるこの側の先端コミットのSHA。

pullRequests[].base オブジェクト

変更のターゲット側 — マージされる先。

pullRequests[].base.ref string

Origin に記録されている、この側の ref が指す対象。

pullRequests[].base.sha string

変更の最新版におけるこの側の先端コミットのSHA。

pullRequests[].author オブジェクト

プルリクエストを作成した公開アクター。

pullRequests[].author.user オブジェクト

アクターのユーザーバリアント。ユーザーがアクションを実行した場合に設定されます。

pullRequests[].author.user.id 文字列

ユーザーの公開識別子。

pullRequests[].author.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

pullRequests[].author.user.displayName string

ユーザーの表示名：アカウントの名と姓をスペースで結合したもので、製品に表示される名前と同じです。アカウントに名前がない場合は省略されます。

pullRequests[].author.user.handle string

ユーザーが申告したプロフィールのハンドル。@ プレフィックスは含みません。プロフィールが公開されている場合のみ表示され、それ以外の場合は省略されます。

pullRequests[].author.app オブジェクト

アクターのアプリのバリアント。アプリがアクションを実行したときに設定されます。

pullRequests[].author.app.id string

アプリの公開識別子。

pullRequests[].author.app.displayName 文字列

アプリの登録表示名。アプリを解決できない場合やCherri Codeのファーストパーティ管理アクターの場合は省略されます。

pullRequests[].author.serviceAccount オブジェクト

アクターのサービスアカウントのバリアント。サービスアカウントが操作を行ったときに設定されます。

pullRequests[].author.serviceAccount.id string

サービスアカウントの公開識別子。

pullRequests[].createdAt 文字列

RFC 3339 形式のプルリクエスト作成タイムスタンプ。

pullRequests[].updatedAt string

最新のプルリクエストの更新日時 (RFC 3339形式) 。

pullRequests[].closedAt string

RFC 3339形式のクローズ時刻。クローズ済みまたはマージ済みのプルリクエストに表示される場合があります。

pullRequests[].mergedAt string

RFC 3339形式のマージタイムスタンプ。マージ済みのプルリクエストに表示されることがあります。

pullRequests[].mergeCommitSha string

マージによってベースブランチに書き込まれたコミットの SHA。プルリクエストがマージされると設定され、それ以前は存在しません。マージ前のプレビューは別のコミットであり、Git リファレンスを取得を使用して pull/<number>/merge リファレンスから読み取れます。

pullRequests[].additions 整数

現在のプルリクエストのバージョンに追加された行。

pullRequests[].deletions integer

現在のプルリクエストのバージョンで削除された行。

pullRequests[].changedFiles integer

現在のプルリクエストのバージョンで変更されたファイル数。

pullRequests[].labels 配列

現在プルリクエストに割り当てられているラベル。名前順に並べられます。割り当てがない場合は空です。

pullRequests[].labels[].id string

ラベルの公開識別子。

pullRequests[].labels[].name string

リポジトリ内で一意のラベル名。書き込み用エンドポイントでは名前でラベルを指定します。

pullRequests[].labels[].color string

先頭に # を付けない6桁の16進数カラーコード。

pullRequests[].labels[].description 文字列

ラベルの説明。説明がない場合は含まれません。

pullRequests[].stack オブジェクト

スタックへの所属: このプルリクエストが属する、依存関係にあるプルリクエストの連なりです。それぞれのプルリクエストは、その土台となるプルリクエストの上に積み重ねられます。このプルリクエストがスタックの一部でない場合は表示されません。

pullRequests[].stack.id string

スタック内のすべてのメンバーで共有される安定したスタック識別子。ほかのメンバーを読み取るには、stackId としてプルリクエストの一覧に渡してください。

pullRequests[].stack.parentPullRequest オブジェクト

このプルリクエストの親となっているプルリクエスト。スタックのルートでは表示されません。マージ済みの親は、子のターゲットブランチが変更されるか、別の親に付け替えられるまで参照されます。

pullRequests[].stack.parentPullRequest.id 文字列

親プルリクエストの Stable Origin 識別子。

pullRequests[].stack.parentPullRequest.number 文字列

JSON文字列としてエンコードされた、親プルリクエストのリポジトリ内番号。

pullRequests[].stack.parentPullRequest.repository オブジェクト

親が属するリポジトリ。チェック実行の repository と同じ id、name、owner フィールドを持ちます。スタックがリポジトリをまたぐことはないため、これは常にそのプルリクエスト自身のリポジトリです。

pullRequests[].version オブジェクト

現在の番号付きプルリクエストのバージョンと、その head/base の SHA。

pullRequests[].version.number 文字列

JSON文字列としてエンコードされた単調増加のプルリクエストのバージョン番号。

pullRequests[].version.headSha string

このプルリクエストのこのバージョンで取得された Head SHA。

pullRequests[].version.baseSha string

このプルリクエストのバージョンで取得されたベース SHA。

pullRequests[].version.createdAt string

このプルリクエストのバージョンが作成された日時を示す RFC 3339 タイムスタンプ。

pullRequests[].version.potentialMergeCommit オブジェクト

このバージョンに対する Origin のテストマージ (headSha をベースブランチの先端にマージしたコミット) と、その準備の進捗状況。すべてのバージョンに含まれます。このバージョンのみを対象とし、プルリクエストのマージ後も読み取れます。mergeCommitSha とは別のコミットです。スタックされたプルリクエストではベースブランチが親のブランチになるため、テストマージの対象は、その上に積まれたこのプルリクエストの変更のみです。

pullRequests[].version.potentialMergeCommit.state 文字列

テストマージの準備の進行状況。指定できる値: unknown、prepared、merge_conflict。unknown はテストマージが未準備であることを示します。バージョンが準備待ちか、準備がタイムアウトまたは失敗した状態です。新しいバージョンはすべて unknown から始まるため、別のバージョンのコミットを引き継ぐことはありません。prepared はテストマージが存在し、sha と baseSha がその内容を表すことを示します。merge_conflict は headSha をベースブランチの先端にマージした際にコンフリクトが発生し、テストマージが存在しないことを示します。これはプルリクエストのマージ可否を取得が merge_conflict ブロッカーとして報告する状態で、プルリクエストを再オープンするとバージョンが再度準備されます。認識できない値は unknown として扱ってください。

pullRequests[].version.potentialMergeCommit.sha 文字列

2つの親を持つテストマージコミットの SHA。このオブジェクトの baseSha が第1の親で、このバージョンの headSha が第2の親です。state が prepared の場合にのみ存在します。このバージョンが最新である間、pull/{pullNumber}/merge ref はこのコミットを指します。その後もコミットを取得を通じて SHA で読み取れますが、Git 経由で SHA を指定してフェッチすることはできません。

pullRequests[].version.potentialMergeCommit.baseSha 文字列

テストマージの作成時に基準としたベースブランチの先端。state が prepared の場合のみ存在します。pullRequests[].version.baseSha より新しい場合がありますが、ベースブランチが進んだだけではオリジンはこの値を更新しません。

nextPageToken string

一覧レスポンスで返される不透明な継続トークン。空文字列は次のページがないことを意味します。解析や生成を行わないでください。リポジトリやフィルターが変更された場合はページネーションをやり直してください。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "pullRequests": [    {      "id": "pr_01k2ja2000e0080000000000d4",      "number": "17",      "state": "open",      "draft": false,      "merged": false,      "title": "Add launch telemetry",      "body": "Adds structured launch telemetry to the ignition path.",      "head": {        "ref": "add-telemetry",        "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"      },      "base": {        "ref": "add-telemetry-schema",        "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"      },      "author": {        "user": {          "id": "user_01k2ja2000e0080000000000c3",          "email": "[email protected]"        }      },      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "additions": 128,      "deletions": 46,      "changedFiles": 5,      "labels": [        {          "id": "lbl_01k2ja2000e0080000000000m1",          "name": "bug",          "color": "d73a4a",          "description": "Something isn't working"        }      ],      "stack": {        "id": "stk_01k2ja2000e0080000000000s1",        "parentPullRequest": {          "id": "pr_01k2ja2000e0080000000000d3",          "number": "16",          "repository": {            "id": "repo_01k2ja2000e0080000000000q4",            "name": "rocket",            "owner": {              "slug": "acme",              "id": "ns_01k2ja2000e0080000000000p3",              "type": "team"            }          }        }      },      "version": {        "number": "3",        "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",        "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8",        "createdAt": "2026-08-01T09:30:00Z"      }    }  ]}

プルリクエストを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}

Scoperepository:pull_requests:readAuthInstallation tokenUser access token

割り当てられたラベルを含む単一のプルリクエストを返します。

クローズ済みまたはマージ済みのプルリクエストには、closedAt、mergedAt、mergeCommitSha が追加で含まれる場合があります。head.ref と base.ref は不透明な Origin リファレンス文字列として扱ってください。これらは短いブランチ名である場合も、完全修飾された refs/heads/… の値である場合もあります。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

レスポンスフィールド

id string

Stable Origin のプルリクエスト識別子。

number string

JSON文字列としてエンコードされたリポジトリ内のプルリクエスト番号。

state string

プルリクエストの状態: open または closed。マージされたプルリクエストは closed になり、merged が true に設定されます。

draft boolean

プルリクエストがドラフトかどうか。

merged boolean

プルリクエストがマージされているかどうか。

title string

プルリクエストのタイトル。

body string

プルリクエストの説明本文。

head オブジェクト

変更元 — マージされる内容です。

head.ref string

Origin が記録している、この側が指す ref。

head.sha string

変更の最新バージョンにおけるこの側の先端コミットのSHA。

base オブジェクト

変更の対象側 — マージ先。

base.ref string

Origin に記録されている、この側が指す ref。

base.sha string

変更の最新バージョンにおけるこの側の先端コミットのSHA。

author オブジェクト

プルリクエストを作成した公開アクター。

author.user オブジェクト

アクターのユーザー版。ユーザーが操作を実行したときに設定されます。

author.user.id string

ユーザーの公開識別子。

author.user.email string

ユーザーのメールアドレス。user バリアントが存在する場合は常に設定されます。

author.user.displayName string

author.user.handle string

ユーザーが申告したプロフィールのハンドル。@プレフィックスは含みません。そのプロフィールが公開されている間のみ表示され、それ以外の場合は省略されます。

author.app オブジェクト

アクターのアプリのバリアント。アプリが操作を実行したときに設定されます。

author.app.id string

アプリの公開識別子。

author.app.displayName string

アプリの登録表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターの場合は省略されます。

author.serviceAccount オブジェクト

アクターのサービスアカウント版です。サービスアカウントが操作を実行した場合に設定されます。

author.serviceAccount.id string

サービスアカウントの公開識別子。

createdAt 文字列

RFC 3339形式のプルリクエスト作成タイムスタンプ。

updatedAt string

プルリクエストの最終更新の RFC 3339 タイムスタンプ。

closedAt 文字列

RFC 3339形式のクローズタイムスタンプ。クローズ済みまたはマージ済みのプルリクエストに表示されることがあります。

mergedAt string

RFC 3339 形式のマージ日時。マージ済みのプルリクエストに表示されることがあります。

mergeCommitSha string

マージによってベースブランチに書き込まれたコミットの SHA。プルリクエストがマージされると設定され、それ以前は存在しません。マージ前のプレビューは別のコミットであり、Git リファレンスを取得を使用して pull/<number>/merge リファレンスを参照してください。

additions integer

現在のプルリクエストのバージョンで追加された行。

deletions 整数

現在のプルリクエストのバージョンで削除された行。

changedFiles 整数

現在のプルリクエストバージョンで変更されたファイル数。

labels 配列

現在プルリクエストに割り当てられているラベル (名前順) 。割り当てがない場合は空です。

labels[].id 文字列

ラベルの公開識別子。

labels[].name string

リポジトリ内で一意のラベル名。書き込み用エンドポイントでは、この名前でラベルを指定します。

labels[].color string

先頭の # を含まない6桁の16進カラーコード。

labels[].description string

ラベルの説明。ラベルに説明がない場合は表示されません。

stack オブジェクト

スタックのメンバーシップ: このプルリクエストが属する依存関係にあるプルリクエストの連なりです。各プルリクエストは、その基盤となるプルリクエストの上に積み重ねられます。プルリクエストがスタックの一部でない場合は表示されません。

stack.id string

スタックのすべてのメンバーで共有される安定したスタック識別子です。他のメンバーを読み取るには、stackId としてプルリクエストを一覧表示に渡してください。

stack.parentPullRequest オブジェクト

このプルリクエストが積み重なっている親のプルリクエスト。スタックのルートでは存在しません。マージ済みの親は、子のターゲットまたは親が変更されるまで参照されたままになります。

stack.parentPullRequest.id string

親プルリクエストの Stable Origin 識別子。

stack.parentPullRequest.number string

JSON文字列としてエンコードされた、親プルリクエストのリポジトリ内番号。

stack.parentPullRequest.repository オブジェクト

親が属するリポジトリ。チェック実行の repository と同じ id、name、owner フィールドを持ちます。スタックはリポジトリをまたがないため、常にプルリクエスト自身のリポジトリです。

version object

現在の番号付きプルリクエストのバージョンと、そのヘッド/ベースのSHA。

version.number 文字列

JSON文字列としてエンコードされた、単調増加するプルリクエストのバージョン番号。

version.headSha string

このプルリクエストのバージョンで取得されたHEAD SHA。

version.baseSha string

このプルリクエストのバージョンで取得されたベースSHA。

version.createdAt 文字列

このプルリクエストバージョンの作成日時を示す RFC 3339 タイムスタンプ。

version.potentialMergeCommit オブジェクト

このバージョンに対するオリジンのテストマージ (headSha をベースブランチの先端にマージしたコミット) と、その準備の進行状況。すべてのバージョンに含まれます。このバージョンのみを表し、プルリクエストのマージ後も参照できます。mergeCommitSha とは別のコミットです。スタック内のプルリクエストでは、ベースブランチは親のブランチです。そのため、テストマージの対象は、親のブランチに重ねたこのプルリクエストの変更のみです。

version.potentialMergeCommit.state string

テストマージの準備状況。使用可能な値: unknown、prepared、merge_conflict。unknown はテストマージがまだ準備されていないことを示します。このバージョンが準備待ちであるか、準備がタイムアウトまたは失敗しています。新しいバージョンは必ず unknown から始まるため、別のバージョンのコミットを引き継ぐことはありません。prepared はテストマージが存在し、sha と baseSha がその内容を示すことを意味します。merge_conflict は、headSha をベースブランチの先端にマージする際に競合が発生し、テストマージが存在しないことを意味します。これはプルリクエストのマージ可否を取得が merge_conflict ブロッカーとして報告する状態です。プルリクエストを再オープンすると、このバージョンの準備が再度行われます。認識できない値は unknown として扱ってください。

version.potentialMergeCommit.sha string

2つの親を持つテストマージコミットの SHA。1つ目の親はこのオブジェクトの baseSha、2つ目の親はこのバージョンの headSha です。state が prepared の場合にのみ存在します。このバージョンが最新である間は、pull/{pullNumber}/merge ref がこのコミットを指します。それ以降もコミットを取得で SHA を指定して読み取れますが、Git 経由で SHA を指定してフェッチすることはできません。

version.potentialMergeCommit.baseSha string

テストマージの作成元となったベースブランチの最新コミット。state が prepared の場合にのみ存在します。version.baseSha より新しい場合がありますが、ベースブランチが進んだだけでは、Origin はこの値を更新しません。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "pr_01k2ja2000e0080000000000d4",  "number": "17",  "state": "open",  "draft": false,  "merged": false,  "title": "Add launch telemetry",  "body": "Adds structured launch telemetry to the ignition path.",  "head": {    "ref": "add-telemetry",    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"  },  "base": {    "ref": "add-telemetry-schema",    "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"  },  "author": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "additions": 128,  "deletions": 46,  "changedFiles": 5,  "labels": [    {      "id": "lbl_01k2ja2000e0080000000000m1",      "name": "bug",      "color": "d73a4a",      "description": "Something isn't working"    }  ],  "stack": {    "id": "stk_01k2ja2000e0080000000000s1",    "parentPullRequest": {      "id": "pr_01k2ja2000e0080000000000d3",      "number": "16",      "repository": {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      }    }  },  "version": {    "number": "3",    "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8",    "createdAt": "2026-08-01T09:30:00Z",    "potentialMergeCommit": {      "state": "prepared",      "sha": "c7b6a5948372615049f8e7d6c5b4a3928170605f",      "baseSha": "5e2d1c0b9a8f7e6d5c4b3a2918070605f4e3d2c1"    }  }}

プルリクエストを作成

POST/v1/origin/repos/{ownerSlug}/{repoName}/pulls

Scoperepository:pull_requests:writeAuthInstallation tokenUser access token

head から base へのプルリクエストを作成します。

オプションの parent_pull_number は、この変更を同じリポジトリ内の別のオープンまたはドラフトのプルリクエストに重ねます。

title が256文字を超えるか、body が65,536文字を超えると、InvalidArgument (HTTP 400) が返されます。どちらの制限もUnicodeコードポイント数で数えます。

base と共通の履歴を持たない head は InvalidArgument (HTTP 400) を返し、何も作成しません。後続のプッシュによってオープン中のプルリクエストの head と base が無関係になった場合、Origin はそのプルリクエストをクローズし、pull_request.closed を送信します。その後、関連するプッシュが行われても再オープンされません。

パスパラメータ

ownerSlug string 必須

所有元エンティティの一意なスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

リクエスト本文

title string 必須

プルリクエストのタイトル。最大長: 256文字。

body string

プルリクエストの本文／説明。空でも可。最大長: 65,536文字。

head string 必須

ソースブランチ名 (変更の先頭) 。呼び出し時にリポジトリ内で解決できる必要があります。

base string 必須

ターゲットブランチ名 (変更がマージされる先) 。呼び出し時にリポジトリ内に存在するブランチを指定する必要があります。コミット SHA、タグ名、または存在しないブランチを指定すると、InvalidArgument (HTTP 400) が返されます。

draft boolean

true の場合は下書きとして作成します。false または省略した場合はオープン (レビュー可能) として作成します。

parentPullRequest オブジェクト

任意のスタック親: 同じリポジトリ内の別のオープンまたはドラフトのプルリクエスト。メンバーを1つだけ設定してください。セレクターが空、メンバーが2つ以上、または clear を指定すると InvalidArgument (HTTP 400) が返されます。

parentPullRequest.number string

リポジトリ内の親プルリクエスト番号。

parentPullRequest.id string

親プルリクエストの id (id で返される値) 。

レスポンスフィールド

id string

Stable Origin のプルリクエスト識別子。

number string

リポジトリ内のプルリクエスト番号をJSON文字列としてエンコードしたもの。

state string

プルリクエストの状態。open または closed。マージされたプルリクエストは closed となり、merged が true に設定されます。

draft boolean

プルリクエストがドラフトかどうか。

merged boolean

プルリクエストがマージされているかどうか。

title string

プルリクエストのタイトル。

body string

プルリクエストの説明本文。

head オブジェクト

変更のソース側 — マージされる内容。

head.ref string

Origin に記録されている、この側が参照する ref。

head.sha string

変更の最新バージョンにおけるこの側の先端コミットSHA。

base オブジェクト

変更の対象側 — マージ先。

base.ref string

Origin に記録されている、この側が参照する ref。

base.sha string

変更の最新バージョンにおけるこの側の先端コミット SHA。

author object

プルリクエストを作成した公開アクター。

author.user オブジェクト

アクターのユーザー・バリアント。ユーザーが操作を行った場合に設定されます。

author.user.id string

ユーザーの公開識別子。

author.user.email string

ユーザーのメールアドレス。user バリアントが存在する場合は常に設定されます。

author.user.displayName string

ユーザーの表示名: アカウントの名と姓をスペースで連結したもので、製品に表示されるのと同じ名前です。アカウントに名前がない場合は省略されます。

author.user.handle string

ユーザーが申告したプロフィールのハンドル名 (@ プレフィックスを除く) 。そのプロフィールが公開されている間のみ表示され、それ以外の場合は省略されます。

author.app オブジェクト

アクターのアプリのバリアント。アプリがアクションを実行したときに設定されます。

author.app.id string

アプリの公開識別子。

author.app.displayName string

アプリに登録された表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターの場合は省略されます。

author.serviceAccount オブジェクト

アクターのサービスアカウントバリアント。サービスアカウントが操作を実行したときに設定されます。

author.serviceAccount.id string

サービスアカウントの公開識別子。

createdAt string

RFC 3339形式のプルリクエスト作成日時。

updatedAt 文字列

最新のプルリクエストの更新時刻 (RFC 3339形式) 。

closedAt 文字列

RFC 3339形式のクローズ時刻。クローズ済みまたはマージ済みのプルリクエストに表示されることがあります。

mergedAt string

RFC 3339形式のマージタイムスタンプ。マージ済みのプルリクエストに表示されることがあります。

mergeCommitSha string

マージによってベースブランチに書き込まれたコミットの SHA。プルリクエストがマージされると設定され、それ以前は存在しません。マージ前のプレビューは別のコミットであり、Git リファレンスを取得を使って pull/<number>/merge の ref から読み取ります。

additions integer

現在のプルリクエストのバージョンで追加された行。

deletions integer

現在のプルリクエストのバージョンで削除された行。

changedFiles 整数

現在のプルリクエストバージョンにおける変更ファイル数。

labels array

プルリクエストに現在割り当てられているラベル。名前順に並んでいます。割り当てがない場合は空です。

labels[].id string

ラベルの公開識別子。

labels[].name string

リポジトリ内で一意のラベル名。書き込みエンドポイントではこの名前でラベルを指定します。

labels[].color string

先頭に#のない6桁の16進数カラーコード。

labels[].description string

ラベルの説明。ラベルに説明がない場合は表示されません。

stack オブジェクト

スタックのメンバーシップ: このプルリクエストが属する依存関係の連鎖。各プルリクエストは基になっているものの上に積み重なっています。プルリクエストがスタックの一部でない場合は表示されません。

stack.id string

スタック内のすべてのメンバーで共有される安定したスタック識別子。ほかのメンバーを取得するには、stackId として Pull Requests を一覧表示に渡します。

stack.parentPullRequest オブジェクト

このプルリクエストが積み重なっている親プルリクエストです。スタックのルートには存在しません。マージされた親プルリクエストは、子プルリクエストのターゲットまたは親が変更されるまで参照されたままになります。

stack.parentPullRequest.id 文字列

親プルリクエストの Stable Origin 識別子。

stack.parentPullRequest.number string

親プルリクエストのリポジトリ内番号 (JSON文字列としてエンコード)

stack.parentPullRequest.repository オブジェクト

version オブジェクト

現在の番号付きプルリクエストのバージョンとその head/base の SHA。

version.number string

JSON文字列としてエンコードされた単調増加のプルリクエストのバージョン番号。

version.headSha string

このプルリクエストのバージョンでキャプチャされた Head SHA。

version.baseSha string

このプルリクエストのバージョンで取得されたベースSHA。

version.createdAt 文字列

このプルリクエストバージョンの作成時刻を示す RFC 3339 タイムスタンプ。

version.potentialMergeCommit オブジェクト

このバージョンのOriginによるテストマージ (headShaをベースブランチの先端にマージするコミット) と、その準備がどこまで進んだかを示します。すべてのバージョンに存在します。このバージョンのみを表し、プルリクエストのマージ後も参照できます。mergeCommitShaとは別のコミットです。スタックされたプルリクエストでは、ベースブランチは親のブランチです。そのため、テストマージの対象は、そのブランチに加えられたこのプルリクエストの変更のみです。

version.potentialMergeCommit.state string

テストマージの準備がどこまで進んだかを示します。指定できる値: unknown、prepared、merge_conflict。unknown はテストマージがまだ準備されていないことを示します。バージョンは準備待ちの状態か、準備がタイムアウトしたか失敗しています。新しいバージョンは必ず unknown から始まるため、別のバージョンのコミットを引き継ぐことはありません。prepared はテストマージが存在し、sha と baseSha がそれを表すことを示します。merge_conflict は headSha をベースブランチの先端にマージする際に競合が発生し、テストマージが存在しないことを示します。これはプルリクエストのマージ可否を取得が merge_conflict ブロッカーとして報告する状態であり、プルリクエストを再オープンすると、このバージョンの準備が再度行われます。認識できない値は unknown として扱ってください。

version.potentialMergeCommit.sha string

2つの親を持つテストマージコミットの SHA。第1の親はこのオブジェクトの baseSha、第2の親はこのバージョンの headSha です。state が prepared の場合にのみ存在します。このバージョンが最新版である間、pull/{pullNumber}/merge の ref はこのコミットを指します。その後もコミットを取得から SHA を指定して読み取れますが、Git 経由で SHA を指定してフェッチすることはできません。

version.potentialMergeCommit.baseSha string

テスト用マージの作成時に基準としたベースブランチの先端。state が prepared の場合にのみ存在します。version.baseSha より新しい場合がありますが、ベースブランチが進んだだけではオリジンはこの値を更新しません。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "title": "Add launch telemetry",  "body": "Adds structured launch telemetry to the ignition path.",  "head": "add-telemetry",  "base": "main",  "draft": false}'

レスポンスの構造:

{  "id": "pr_01k2ja2000e0080000000000d4",  "number": "17",  "state": "open",  "draft": false,  "merged": false,  "title": "Add launch telemetry",  "body": "Adds structured launch telemetry to the ignition path.",  "head": {    "ref": "add-telemetry",    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"  },  "base": {    "ref": "main",    "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"  },  "author": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "additions": 128,  "deletions": 46,  "changedFiles": 5,  "labels": [    {      "id": "lbl_01k2ja2000e0080000000000m1",      "name": "bug",      "color": "d73a4a",      "description": "Something isn't working"    }  ],  "version": {    "number": "3",    "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8",    "createdAt": "2026-08-01T09:30:00Z"  }}

プルリクエストの更新

PATCH/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}

Scoperepository:pull_requests:writeAuthInstallation tokenUser access token

プルリクエストのタイトル、本文、ベースブランチ、スタックの親、ライフサイクル状態のいずれかまたはすべてを更新します。

省略されたフィールドは変更されません。指定されたフィールドは、metadata、reopen/draft/ready-for-review、base、スタックの親、closeの順に適用されます。closeは最後に実行されるため、同じリクエスト内で対象を変更しても、オープン状態の変更を認識できます。reopenはbaseの前に実行されるため、クローズされたプルリクエストの対象を変更できます。スタックの親はbaseの後に実行されるため、明示的に指定した親は、baseの変更によって導出された親より優先されます。後のステップが失敗した場合、それ以前のステップはすでにコミットされている可能性があります。

title が256文字を超える場合、または body が65,536文字を超える場合は、InvalidArgument (HTTP 400) が返されます。どちらの上限も Unicode コードポイント数で判定されます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

リクエスト本文

title 文字列

新しいタイトル。省略されたフィールドは変更されません。最大長：256文字。

body string

新しい本文／説明。空の文字列を指定すると本文がクリアされます。最大長: 65,536文字。

state string

"open" または "closed"。"closed" はプルリクエストをクローズします。draft: true を指定しない "open" は、既存のドラフトを公開する場合も含め、レビュー可能な状態にします。クローズ中に head が移動したプルリクエストを再オープンすると、新しい version が記録され、pull_request.head_ref.pushed が送信されます。マージ済みの状態は書き込み不可です。MergePullRequest を使用してください。

draft boolean

true はプルリクエストをドラフトとしてマークし、false はレビュー可能な状態としてマークします (現在クローズされている場合は再オープンし、その際に新しい version が記録されることがあります) 。state が "closed" の場合は無視されます。

base string

新しいベースブランチ。プルリクエストの対象を変更し、新しいベースが別の変更の head (またはデフォルトブランチ) の場合は、スタックの親子関係を更新することがあります。呼び出し時点でリポジトリに存在するブランチを指定する必要があります。コミット SHA、タグ名、または存在しないブランチを指定すると、InvalidArgument (HTTP 400) が返されます。

parentPullRequest オブジェクト

スタックの親を編集します。メンバーはちょうど1つだけ指定してください。number または id を指定すると、このプルリクエストはその親にスタックされ、現在の親があれば置き換えられます。clear を指定すると親が削除されます。スタックを変更しない場合は、このフィールドを省略してください。セレクターが空の場合、clear: false を指定した場合、または複数のメンバーを指定した場合は、InvalidArgument (HTTP 400) が返されます。これは関連付けのみであり、ブランチは書き換えられません。また、base は同時に指定した場合にのみ変更されます。Origin は base の後にこの変更を適用するため、明示的に指定した親が、base の変更から導出される親より優先されます。

parentPullRequest.number string

リポジトリ内の親プルリクエスト番号。

parentPullRequest.id 文字列

id で返される親プルリクエスト ID。

parentPullRequest.clear boolean

現在のスタックの親を削除します。true のみ許可されます。

レスポンスフィールド

id string

Stable Origin のプルリクエスト識別子。

number string

JSON文字列としてエンコードされたリポジトリ内のプルリクエスト番号。

state string

プルリクエストの状態。open または closed。マージされたプルリクエストは closed になり、merged が true に設定されます。

draft boolean

プルリクエストがドラフトかどうか。

merged boolean

プルリクエストがマージされているかどうか。

title 文字列

プルリクエストのタイトル。

body string

プルリクエストの説明本文。

head object

変更元側 — マージされる内容。

head.ref string

Origin が記録している、この側が指している ref。

head.sha string

変更の最新バージョン時点でのこの側の先端コミットのSHA。

base オブジェクト

変更の対象側 — マージ先です。

base.ref string

Origin に記録されている、この側が指している ref。

base.sha string

変更の最新バージョン時点でのこの側の先端コミットのSHA。

author object

プルリクエストを作成した公開アクター。

author.user object

アクターのユーザー種別。ユーザーが操作を行ったときに設定されます。

author.user.id string

ユーザーの公開識別子。

author.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

author.user.displayName string

author.user.handle string

author.app オブジェクト

アクターのアプリのバリアント。アプリがアクションを実行したときに設定されます。

author.app.id string

アプリの公開識別子。

author.app.displayName 文字列

アプリに登録されている表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターの場合は省略されます。

author.serviceAccount オブジェクト

アクターのサービスアカウント版です。サービスアカウントが操作を実行した場合に設定されます。

author.serviceAccount.id string

サービスアカウントの公開識別子。

createdAt 文字列

RFC 3339形式のプルリクエスト作成タイムスタンプ。

updatedAt string

プルリクエストの最新更新日時を表すRFC 3339タイムスタンプ。

closedAt string

RFC 3339形式のクローズ日時。クローズ済みまたはマージ済みのプルリクエストに表示される場合があります。

mergedAt string

RFC 3339形式のマージタイムスタンプ。マージされたプルリクエストに表示される場合があります。

mergeCommitSha string

マージによってベースブランチに書き込まれたコミットのSHA。プルリクエストがマージされると設定され、それ以前は存在しません。マージ前のプレビューは別のコミットであり、pull/<number>/merge リファレンスを Git リファレンスを取得で参照してください。

additions integer

現在のプルリクエストのバージョンで追加された行。

deletions integer

現在のプルリクエストのバージョンで削除された行。

changedFiles 整数

現在のプルリクエストのバージョンで変更されたファイル数。

labels 配列

このプルリクエストに現在割り当てられているラベル。名前順にソートされています。割り当てがない場合は空です。

labels[].id string

ラベルの公開識別子。

labels[].name string

リポジトリ内で一意のラベル名。書き込み用エンドポイントでは名前でラベルを指定します。

labels[].color 文字列

先頭に # のない6桁の16進カラーコード。

labels[].description string

ラベルの説明。ラベルに説明がない場合は表示されません。

stack オブジェクト

スタックのメンバーシップ: このプルリクエストが属する依存プルリクエストの連鎖で、各プルリクエストは依存元の上にスタックされます。プルリクエストがスタックに含まれていない場合は表示されません。

stack.id 文字列

スタックの全メンバーで共有される安定したスタック識別子。他のメンバーを取得するには、これを stackId として List Pull Requests に渡します。

stack.parentPullRequest オブジェクト

このプルリクエストが積み上げられている親のプルリクエストです。スタックのルートでは表示されません。マージ済みの親は、子のターゲットまたは親が変更されるまで参照されたままになります。

stack.parentPullRequest.id 文字列

親プルリクエストの Stable Origin 識別子。

stack.parentPullRequest.number 文字列

JSON文字列としてエンコードされた、親プルリクエストのリポジトリ内番号。

stack.parentPullRequest.repository オブジェクト

親が属するリポジトリ。チェック実行の repository と同じ id、name、owner フィールドを持ちます。スタックはリポジトリをまたがないため、これは常にプルリクエスト自身のリポジトリです。

version オブジェクト

現在の番号付きプルリクエストのバージョンと、その head/base SHA。

version.number 文字列

JSON文字列としてエンコードされた単調増加するプルリクエストのバージョン番号。

version.headSha string

このプルリクエストのバージョンでキャプチャされたHead SHA。

version.baseSha string

このプルリクエストのバージョンでキャプチャされたベース SHA。

version.createdAt 文字列

このプルリクエストバージョンが作成された日時の RFC 3339 タイムスタンプ。

version.potentialMergeCommit オブジェクト

このバージョンに対するOriginのテストマージ (headSha をベースブランチの先端にマージしたコミット) と、その準備がどこまで進んだかを示します。すべてのバージョンに含まれます。このバージョンのみを表し、プルリクエストのマージ後も参照できます。mergeCommitSha とは別のコミットです。スタックされたプルリクエストでは、ベースブランチは親のブランチです。そのため、テストマージの対象は、親のブランチに対するこのプルリクエストの変更のみです。

version.potentialMergeCommit.state 文字列

テストマージの準備状況。指定できる値: unknown、prepared、merge_conflict。unknown はテストマージが準備されていないことを示します。バージョンの準備待ちであるか、準備がタイムアウトまたは失敗しています。新しいバージョンは必ず unknown から始まるため、別のバージョンのコミットを引き継ぐことはありません。prepared はテストマージが存在し、sha と baseSha がその内容を示すことを意味します。merge_conflict は headSha をベースブランチの先端にマージした際に競合が発生し、テストマージが存在しないことを示します。これはプルリクエストのマージ可能性を取得が merge_conflict ブロッカーとして報告する状態です。プルリクエストを再オープンすると、そのバージョンが再び準備されます。認識できない値は unknown として扱ってください。

version.potentialMergeCommit.sha 文字列

2つの親を持つテストマージコミットのSHA。第1の親はこのオブジェクトの baseSha、第2の親はこのバージョンの headSha です。state が prepared の場合にのみ存在します。このバージョンが最新である間、pull/{pullNumber}/merge ref はこのコミットを指します。その後もコミットを取得でSHAを指定して参照できますが、Git経由でSHAを指定してフェッチすることはできません。

version.potentialMergeCommit.baseSha 文字列

テストマージの作成時に基準としたベースブランチの先端。state が prepared の場合にのみ表示されます。version.baseSha より新しい場合がありますが、ベースブランチが進んだだけではOriginはこの値を更新しません。

curl --request PATCH \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "title": "Add launch telemetry",  "body": "Adds structured launch telemetry to the ignition path.",  "state": "open",  "draft": false,  "base": "main"}'

レスポンスの構造:

{  "id": "pr_01k2ja2000e0080000000000d4",  "number": "17",  "state": "open",  "draft": false,  "merged": false,  "title": "Add launch telemetry",  "body": "Adds structured launch telemetry to the ignition path.",  "head": {    "ref": "add-telemetry",    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"  },  "base": {    "ref": "main",    "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"  },  "author": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "additions": 128,  "deletions": 46,  "changedFiles": 5,  "labels": [    {      "id": "lbl_01k2ja2000e0080000000000m1",      "name": "bug",      "color": "d73a4a",      "description": "Something isn't working"    }  ],  "version": {    "number": "3",    "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8",    "createdAt": "2026-08-01T09:30:00Z"  }}

プルリクエストコメントの一覧取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/comments

Scoperepository:pull_requests:reviews:readAuthInstallation tokenUser access token

プルリクエスト上のすべてのコメントを時系列順に一覧表示します。必要に応じて、作成時刻の範囲を指定して絞り込めます。各コメントには、スレッド全体の情報 (ID、差分アンカー、解決状態) が含まれます。追加のリクエストを行わずに、フラットなレスポンスを thread.id ごとにグループ化できます。

ページトークンには発行時のフィルターが埋め込まれているため、異なるフィルターで再送されたトークンは拒否されます。フィルターを変更した場合は、ページネーションを最初からやり直してください。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

リポジトリ名。所有者エンティティ内で一意です。

pullNumber string 必須

クエリパラメータ

pageSize 整数

返すコメントの最大数。デフォルトは30、最大は100です。

pageToken string

前のレスポンスの nextPageToken からの不透明なカーソル。最初のページでは省略してください。後続のリクエストで pageSize を指定すると、そのページに適用されます。省略した場合は、前のページサイズが維持されます。

since string

コメントの作成時刻に対する省略可能な下限 (指定時刻を含む) です。2026-08-01T00:00:00Z のような RFC 3339 タイムスタンプで指定します。その時刻以降に作成されたコメントのみを返します。形式が不正なタイムスタンプの場合は InvalidArgument (HTTP 400) を返します。

until string

コメント作成時刻の上限 (省略可能、指定した時刻を含む) 。since と同じ RFC 3339 形式で指定します。その時刻以前に作成されたコメントのみを返します。タイムスタンプの形式が不正な場合は InvalidArgument (HTTP 400) を返します。

threadIds 配列

コメント一覧を指定したスレッド内に限定するための省略可能なスレッド ID です。省略すると、プルリクエストのすべてのコメントが返されます。重複は無視されるため、上限の20件は重複を除いた ID に適用されます。リストが長すぎる場合、または ID が空の場合は、InvalidArgument (HTTP 400) が返されます。

レスポンスフィールド

comments 配列

一般コメントとインラインコメントを時系列順のフラットな一覧として表示し、thread.idごとにグループ化します。

comments[].id string

安定したプルリクエストのコメント識別子。

comments[].thread object

このコメントが属するスレッド。diffアンカーと解決状態を含みます。

comments[].thread.id string

スレッドの安定した識別子。この値で同じディスカッション内のコメントをグループ化します。

comments[].thread.version object

スレッドが作成されたプルリクエストのバージョン (head と base の SHA を含む) 。アンカーはこのバージョンに固定され、プルリクエストに新しいバージョンが追加されても移動しません。

comments[].thread.version.number string

JSON文字列としてエンコードされた単調増加するプルリクエストのバージョン番号。

comments[].thread.version.headSha string

このプルリクエストのこのバージョンで取得された HEAD SHA。

comments[].thread.version.baseSha string

このプルリクエストのバージョンで取得されたベース SHA。

comments[].thread.path string

スレッドの差分アンカーのファイルパス。一般ディスカッションのスレッドでは空です。

comments[].thread.side string

アンカーの差分の側。許容値: left、right。general-discussion スレッドでは未設定です。

comments[].thread.startLine 整数

ファイルの side バージョンでアンカーされた範囲の先頭行。ファイルレベルおよび一般ディスカッションのスレッドの場合は 0。

comments[].thread.endLine 整数

アンカー範囲に含まれる最終行。アンカーが単一行であるか行範囲がない場合は 0。

comments[].thread.resolvedAt string

スレッドが解決された時刻のRFC 3339タイムスタンプ。スレッドが未解決の間は未設定です。

comments[].thread.createdAt string

RFC 3339形式のスレッド作成タイムスタンプ。

comments[].thread.updatedAt string

スレッドの最終更新時刻を示すRFC 3339タイムスタンプ。

comments[].body string

コメントの本文。

comments[].author object

コメントを作成した公開アクター。

comments[].author.user object

アクターのユーザーバリアント。ユーザーがアクションを実行したときに設定されます。

comments[].author.user.id string

ユーザーの公開識別子。

comments[].author.user.email string

ユーザーのメールアドレス。ユーザーバリアントが存在する場合は常に設定されます。

comments[].author.user.displayName string

comments[].author.user.handle string

ユーザーが申告したプロフィールのハンドル (先頭の @ は含みません) 。プロフィールが公開されている間のみ表示され、それ以外の場合は省略されます。

comments[].author.app object

アクターのアプリ版。アプリが操作を実行した場合に設定されます。

comments[].author.app.id string

アプリの公開識別子。

comments[].author.app.displayName string

アプリの登録済み表示名。アプリを解決できない場合およびCherri Codeのファーストパーティ管理アクターの場合は省略されます。

comments[].author.serviceAccount object

アクターのサービスアカウント版。サービスアカウントが操作を実行したときに設定されます。

comments[].author.serviceAccount.id string

サービスアカウントの公開識別子。

comments[].createdAt string

コメント作成時のRFC 3339形式のタイムスタンプ。

comments[].updatedAt string

コメントの最終編集時刻を示すRFC 3339タイムスタンプ。

pullRequest オブジェクト

コメントページとともに含まれるコンテナ PullRequestReference。

pullRequest.id string

安定したプルリクエスト識別子。

pullRequest.number string

JSON文字列としてエンコードされたリポジトリローカルのプルリクエスト番号。

pullRequest.repository オブジェクト

プルリクエストのリポジトリコンテナ参照。

pullRequest.repository.id 文字列

コンテナ参照内のリポジトリ識別子。

pullRequest.repository.name string

コンテナ参照内のリポジトリ名。

pullRequest.repository.owner オブジェクト

リポジトリのオーナー参照。

pullRequest.repository.owner.slug string

リポジトリの所有者を識別するために所有者IDと併用される、URL 表示用のオーナースラッグ。

pullRequest.repository.owner.id string

Origin のオーナー識別子。

pullRequest.repository.owner.type string

オーナー名前空間のタイプ。出力専用。許容値: team、user。不明な場合は省略されます。

nextPageToken string

次のページ用の不透明なカーソル。コメントがこれ以上ない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/comments' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "comments": [    {      "id": "cmt_01k2ja2000e0080000000000e5",      "thread": {        "id": "cth_01k2ja2000e0080000000000s6",        "version": {          "number": "3",          "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",          "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"        },        "path": "src/telemetry/retry.ts",        "side": "right",        "startLine": 42,        "endLine": 45,        "createdAt": "2026-08-01T09:30:00Z",        "updatedAt": "2026-08-02T14:45:00Z"      },      "body": "Should the retry budget be configurable?",      "author": {        "user": {          "id": "user_01k2ja2000e0080000000000c3",          "email": "[email protected]"        }      },      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z"    }  ],  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    }  }}

プルリクエストコメントを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls/comments/{commentId}

Scoperepository:pull_requests:reviews:readAuthInstallation tokenUser access token

安定した Origin ID によって指定されたプルリクエストコメントを1件返します。認可されたリポジトリの外にあるコメント、または呼び出し元に表示されない保留中のレビューコメントの場合は、404 を返します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナー (所有者) エンティティ内で一意のリポジトリ名。

commentId string 必須

レスポンスフィールド

id string

安定したプルリクエストのコメント識別子。

thread object

このコメントが属するスレッド (差分アンカーと解決状態を含む) 。

thread.id string

スレッドの安定した識別子。この値で1つのディスカッション内のコメントをグループ化します。

thread.version object

thread.version.number string

JSON 文字列としてエンコードされた単調増加するプルリクエストのバージョン番号。

thread.version.headSha string

このプルリクエストのバージョンで取得された Head SHA。

thread.version.baseSha string

このプルリクエストのこのバージョンで取得されたベース SHA。

thread.path string

スレッドの差分アンカーのファイルパス。一般的なディスカッション用スレッドでは空です。

thread.side string

アンカーの差分側。許容値: left、right。一般ディスカッションのスレッドでは未設定にします。

thread.startLine integer

ファイルの side バージョンにおけるアンカー範囲の開始行。ファイル単位のスレッドおよび一般ディスカッションのスレッドでは 0 です。

thread.endLine integer

アンカー範囲に含まれる最後の行。アンカーが単一行であるか行範囲がない場合は 0。

thread.resolvedAt string

スレッドが解決された時点の RFC 3339 タイムスタンプ。スレッドがオープンな間は未設定です。

thread.createdAt string

RFC 3339によるスレッド作成時刻。

thread.updatedAt string

スレッドの最終更新時刻の RFC 3339 タイムスタンプ。

body string

コメント本文。

author object

コメントを作成した公開アクター。

author.user object

アクターのユーザー固有のバリアント。ユーザーがアクションを実行したときに設定されます。

author.user.id string

ユーザーの公開識別子。

author.user.email string

ユーザーのメールアドレス。ユーザーバリアントが存在する場合は常に設定されます。

author.user.displayName string

author.user.handle string

ユーザーが主張するプロフィールのハンドル。@プレフィックスは含みません。プロフィールが公開されている場合にのみ表示され、それ以外の場合は省略されます。

author.app object

アクターのアプリ版。アプリがアクションを実行した場合に設定されます。

author.app.id string

アプリの公開識別子。

author.app.displayName string

アプリに登録された表示名。アプリが解決できない場合、またはCherri Codeのファーストパーティ管理アクターの場合は省略されます。

author.serviceAccount object

アクターのサービスアカウント版。サービスアカウントが操作を実行した場合に設定されます。

author.serviceAccount.id string

サービスアカウントの公開識別子。

createdAt string

コメント作成時の RFC 3339 タイムスタンプ。

updatedAt string

コメントの最終編集時の RFC 3339 タイムスタンプ。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/comments/COMMENT_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "cmt_01k2ja2000e0080000000000e5",  "thread": {    "id": "cth_01k2ja2000e0080000000000s6",    "version": {      "number": "3",      "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"    },    "path": "src/telemetry/retry.ts",    "side": "right",    "startLine": 42,    "endLine": 45,    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z"  },  "body": "Should the retry budget be configurable?",  "author": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z"}

プルリクエストコメントの削除

DELETE/v1/origin/repos/{ownerSlug}/{repoName}/pulls/comments/{commentId}

Scoperepository:pull_requests:reviews:writeAuthInstallation tokenUser access token

安定した Origin ID を指定してプルリクエストコメントを削除します。レスポンス本文は空です。

コメントの作成者は常に削除できます。それ以外の呼び出し元は、repository:contents:write で付与されるリポジトリへの書き込み権限を持っている必要があり、持っていない場合は PermissionDenied (HTTP 403) を受け取ります。スレッドの最後のコメントを削除すると、スレッドも削除されます。スレッドの開始コメントを含むその他のコメントを削除した場合、スレッドと残りのコメントはそのまま残ります。スレッドが解決済みかどうかは削除の条件ではありません。コメントへのリアクションと編集履歴もコメントとともに削除されます。

不明な ID、すでに削除されたコメント、別のリポジトリ内のコメントはいずれも 404 を返します。不正な形式の ID は InvalidArgument (HTTP 400) を返します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意の slug。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

commentId string 必須

レスポンスフィールド

成功したリクエストではレスポンス本文は返されません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/comments/COMMENT_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンス:

204 No Content

プルリクエストコメントを作成

POST/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/comments

Scoperepository:pull_requests:reviews:writeAuthInstallation tokenUser access token

Originのプルリクエストにコメントを作成します。コメントの対象は次の4つのうちちょうど1つです。threadId を指定すると、一般ディスカッションまたはインラインの既存スレッドに返信します。inline を指定すると、プルリクエストのバージョンの差分内の行範囲に紐づく新しいスレッドを開きます。file を指定すると、その差分内のファイル全体に対する新しいスレッドを開きます。いずれも指定しない場合は、新しい一般ディスカッションスレッドを開きます。本文が65,536文字を超える場合は、InvalidArgument (HTTP 400) エラーとして拒否されます。

inlineアンカーはそのバージョンの差分を参照する必要があります。pathはその差分の一部でなければならず、sideには当該箇所に内容が存在している必要があります。そのため、追加されたファイルに対してleftを指定したり、削除されたファイルに対してrightを指定したりすることはInvalidArgument (HTTP 400) として拒否されます。変更されたファイルの任意の行をアンカーにでき、範囲は差分のハンクに限定されません。範囲はアンカーした側のファイルに収まっている必要があります。leftはベースコミット時点、rightはヘッド時点のファイルとして読み取られ、最終行を超える範囲はInvalidArgument (HTTP 400) として拒否されます。アンカーが無効な場合でも、Originが一般的なディスカッションのコメントにフォールバックすることはありません。

fileアンカーはパスのみを保持します。Originはファイルの変更種別からサイドを導出し、削除されたファイルの場合はベース版を、そうでない場合はヘッド版をthread.sideに設定します。削除の場合は削除されたパスを送信し、それ以外の変更の場合はヘッドのパスを送信してください。差分の外にあるパスや、名前変更されたファイルの名前変更前のソースパスはInvalidArgument (HTTP 400) として拒否されます。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

所有エンティティ内で一意のリポジトリ名。

pullNumber 文字列必須

リクエスト本文

body 文字列必須

コメント本文。最大長: 65,536文字 (Unicodeコードポイント換算)。

threadId 文字列

返信先の既存スレッドID。省略すると新しいスレッドを開きます。versionNumberと併用できません。

inline オブジェクト

新しいインラインスレッド用の差分アンカー。threadId と併用できません。

inline.path 文字列必須

プルリクエストのバージョンの差分内のファイルパス。

inline.side 文字列必須

アンカーの差分側。許可される値: ファイルのベース版はleft、ヘッド版はrightです。

inline.startLine 整数必須

side バージョンのファイルにおけるアンカー範囲の先頭行 (1始まり) 。範囲はそのファイルの末尾を超えてはなりません。

inline.endLine 整数

アンカー範囲の最終行 (この行を含む) 。startLine 以上である必要があります。アンカーが1行のみの場合は省略してください。

file オブジェクト

プルリクエスト版の差分におけるファイル全体に対する、新しいファイルレベルのスレッド用アンカー。threadIdまたはinlineとは併用できません。

file.path 文字列必須

プルリクエスト版の差分内のファイルパス: 削除の場合は削除されたパス、そうでなければ head のパス。

versionNumber 文字列

新しいスレッドを作成する対象のプルリクエストのバージョン番号。0または未設定の場合は呼び出し時点の最新バージョンを意味します。新しいスレッドに対してのみ有効です。

レスポンスフィールド

id 文字列

安定したプルリクエストコメント識別子。

thread オブジェクト

このコメントが属するスレッド。返信にはスレッドIDのみが含まれ、新しい一般ディスカッションスレッドにはIDとタイムスタンプが含まれます。新しいインラインスレッドには完全なアンカーが含まれます。スレッドの完全な状態については、プルリクエストコメントを取得またはプルリクエストコメントの一覧を参照してください。

thread.id 文字列

スレッドの恒久的な識別子。この値で1つのディスカッション内のコメントをグループ化します。

thread.version オブジェクト

スレッドが作成されたプルリクエストのバージョン (head と base の SHA を含む)。アンカーはこのバージョンに固定され、プルリクエストに新しいバージョンが追加されても移動しません。

thread.version.number 文字列

JSON文字列としてエンコードされた単調増加するプルリクエストのバージョン番号。

thread.version.headSha 文字列

このプルリクエストのバージョンで取得されたHead SHA。

thread.version.baseSha 文字列

このプルリクエストのバージョンで取得されたベースSHA。

thread.path 文字列

スレッドの差分アンカーのファイルパス。一般ディスカッションのスレッドでは空です。

thread.side 文字列

アンカーの差分側。許可される値: left、right。一般ディスカッションスレッドでは未設定です。

thread.startLine 整数

ファイルのsideバージョンでアンカーされた範囲の先頭行。ファイルレベルおよび一般ディスカッションのスレッドでは0。

thread.endLine 整数

アンカー範囲の最終行 (含む) 。アンカーが単一行の場合、または行範囲がない場合は 0。

thread.resolvedAt 文字列

スレッドが解決された時点の RFC 3339 タイムスタンプ。スレッドが開いている間は未設定です。

thread.createdAt 文字列

RFC 3339 のスレッド作成タイムスタンプ。

thread.updatedAt 文字列

最新のスレッド更新の RFC 3339 タイムスタンプ。

body 文字列

コメント本文。

author オブジェクト

コメントを作成した公開アクター。

author.user オブジェクト

アクターのユーザー版。ユーザーが操作を行ったときに設定されます。

author.user.id 文字列

ユーザーの公開識別子。

author.user.email 文字列

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

author.user.displayName 文字列

author.user.handle 文字列

ユーザーが申告したプロフィールハンドル (@ 接頭辞なし) 。そのプロフィールが一般公開されている場合にのみ表示され、それ以外の場合は省略されます。

author.app オブジェクト

アクターのアプリバリアント。アプリが操作を実行した場合に設定されます。

author.app.id 文字列

アプリの公開識別子。

author.app.displayName 文字列

アプリの登録済み表示名。アプリを解決できない場合やCherri Codeのファーストパーティ管理アクター上では省略されます。

author.serviceAccount オブジェクト

アクターのサービスアカウント版。サービスアカウントが操作を実行したときに設定されます。

author.serviceAccount.id 文字列

サービスアカウントの公開識別子。

createdAt 文字列

コメント作成時のRFC 3339タイムスタンプ。

updatedAt 文字列

最新のコメント編集の RFC 3339 タイムスタンプ。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/comments' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "body": "Should the retry budget be configurable?"}'

レスポンスの構造:

{  "id": "cmt_01k2ja2000e0080000000000e5",  "thread": {    "id": "cth_01k2ja2000e0080000000000s6",    "version": {      "number": "3",      "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"    },    "path": "src/telemetry/retry.ts",    "side": "right",    "startLine": 42,    "endLine": 45,    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z"  },  "body": "Should the retry budget be configurable?",  "author": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z"}

プルリクエストコメントを更新

PATCH/v1/origin/repos/{ownerSlug}/{repoName}/pulls/comments/{commentId}

Scoperepository:pull_requests:reviews:writeAuthInstallation tokenUser access token

永続的なOrigin IDを指定して、プルリクエストコメントを更新します。

コメント本文を置き換えます。対象のコメントは、パスで指定したリポジトリに属し、呼び出し元から閲覧可能で、かつ呼び出し元が作成したものである必要があります。別のリポジトリに属するコメントや、非表示のレビュー保留中コメントに対しては404が返されます。閲覧可能でも別のアクターが所有するコメントに対しては403が返されます。本文が65,536文字を超える場合は、InvalidArgument (HTTP 400) で拒否されます。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

所有者エンティティ内で一意のリポジトリ名。

commentId 文字列必須

リクエスト本文

body 文字列必須

置き換え後のコメント本文。最大長: 65,536文字 (Unicodeコードポイント換算) 。

レスポンスフィールド

id 文字列

安定したプルリクエストのコメント識別子。

thread オブジェクト

このコメントが属するスレッド。差分アンカーと解決状態を含みます。

thread.id 文字列

スレッドの安定した識別子。この値によりコメントを1つのディスカッションにまとめます。

thread.version オブジェクト

thread.version.number 文字列

JSON文字列としてエンコードされた単調増加するプルリクエストのバージョン番号。

thread.version.headSha 文字列

このプルリクエストのバージョンで取得されたHead SHA。

thread.version.baseSha 文字列

このプルリクエストのバージョンで取得されたベース SHA。

thread.path 文字列

スレッドの diff アンカーのファイルパス。一般ディスカッション用スレッドの場合は空です。

thread.side 文字列

アンカーの差分側。許容される値: left, right。general-discussion のスレッドでは未設定になります。

thread.startLine 整数

ファイルのsideバージョンでアンカーされた範囲の先頭行。ファイルレベルおよび一般ディスカッションのスレッドでは0。

thread.endLine 整数

アンカー範囲の最終行 (この行を含む) 。アンカーが単一行の場合、または行範囲がない場合は0。

thread.resolvedAt 文字列

スレッドが解決された日時のRFC 3339タイムスタンプ。スレッドが開いている間は未設定です。

thread.createdAt 文字列

RFC 3339 スレッド作成タイムスタンプ。

thread.updatedAt 文字列

最新のスレッド更新のRFC 3339タイムスタンプ。

body 文字列

コメント本文。

author オブジェクト

コメントを作成した公開アクター。

author.user オブジェクト

アクターのユーザー版。ユーザーがアクションを実行したときに設定されます。

author.user.id 文字列

ユーザーの公開識別子。

author.user.email 文字列

ユーザーのメールアドレス。ユーザーバリアントが存在する場合は常に設定されます。

author.user.displayName 文字列

ユーザーの表示名：アカウントの名と姓を半角スペースで結合したもので、製品が表示する名前と同じです。アカウントに名前がない場合は省略されます。

author.user.handle 文字列

ユーザーが申告したプロフィールのハンドル (@ プレフィックスなし) 。そのプロフィールが公開されている場合にのみ表示され、それ以外の場合は省略されます。

author.app オブジェクト

アプリがアクションを実行した場合に設定される、アクターのアプリバリアント。

author.app.id 文字列

アプリの公開識別子。

author.app.displayName 文字列

アプリに登録された表示名。アプリが解決できない場合や、Cherri Code のファーストパーティ管理アクターでは省略されます。

author.serviceAccount オブジェクト

アクターがサービスアカウントの場合のバリアントです。サービスアカウントが操作を実行した場合に設定されます。

author.serviceAccount.id 文字列

サービスアカウントの公開識別子。

createdAt 文字列

コメント作成時のRFC 3339タイムスタンプ。

updatedAt 文字列

最新のコメント編集のRFC 3339タイムスタンプ。

curl --request PATCH \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/comments/COMMENT_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "body": "Should the retry budget be configurable?"}'

レスポンスの構造:

{  "id": "cmt_01k2ja2000e0080000000000e5",  "thread": {    "id": "cth_01k2ja2000e0080000000000s6",    "version": {      "number": "3",      "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"    },    "path": "src/telemetry/retry.ts",    "side": "right",    "startLine": 42,    "endLine": 45,    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z"  },  "body": "Should the retry budget be configurable?",  "author": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z"}

プルリクエストのスレッドを更新

PATCH/v1/origin/repos/{ownerSlug}/{repoName}/pulls/threads/{threadId}

Scoperepository:pull_requests:reviews:writeAuthInstallation tokenUser access token

プルリクエストコメントのスレッドを解決または再オープンし、そのスレッドの更新後の状態を返します。すでに解決済みのスレッドを解決した場合や、すでにオープンなスレッドを再オープンした場合は、何も行われません。

スレッドはパスで指定したリポジトリに属している必要があります。別のリポジトリに保存されているスレッドの場合は 404 が返されます。解決済みのスレッドへプルリクエストコメントの作成で返信することは可能で、返信してもスレッドが再オープンされることはありません。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意なスラッグ。

repoName string 必須

所有者エンティティに固有のリポジトリ名。

threadId string 必須

安定した Origin のスレッド ID。

リクエストボディ

resolved boolean 必須

対象の解決状態。true はスレッドを解決し、false は再度開きます。

レスポンスフィールド

id string

スレッドの安定した ID。この値でコメントを 1 つのディスカッションにまとめます。

version object

このスレッドが作成された時点のプルリクエストのバージョン (head と base の SHA を含む) 。アンカーはこのバージョンに固定され、プルリクエストに新しいバージョンが追加されても移動しません。

version.number string

JSON 文字列としてエンコードされた単調増加のプルリクエストのバージョン番号。

version.headSha string

このプルリクエストのバージョンで取得されたHEAD SHA。

version.baseSha string

このプルリクエストのバージョンで取得されたベース SHA。

path string

スレッドの差分アンカーのファイルパス。一般ディスカッションのスレッドでは空です。

side string

アンカーの差分側。指定可能な値: left、right。一般的な議論のスレッドでは未設定です。

startLine 整数

ファイルの side バージョンにおけるアンカー範囲の先頭行。ファイルレベルおよび一般的なディスカッションのスレッドでは 0 です。

endLine integer

アンカー範囲の最終行 (包含) 。アンカーが単一行の場合、または行範囲がない場合は 0。

resolvedAt string

スレッドが解決された日時のRFC 3339形式タイムスタンプ。スレッドがオープンの間は未設定です。

createdAt string

RFC 3339 形式のスレッド作成タイムスタンプ。

updatedAt string

スレッドの最終更新を示す RFC 3339 形式のタイムスタンプ。

curl --request PATCH \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/threads/THREAD_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "resolved": true}'

レスポンスの構造:

{  "id": "cth_01k2ja2000e0080000000000s6",  "version": {    "number": "3",    "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"  },  "path": "src/telemetry/retry.ts",  "side": "right",  "startLine": 42,  "endLine": 45,  "resolvedAt": "2026-08-03T10:00:00Z",  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-03T10:00:00Z"}

プルリクエストのコミット一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/commits

Scoperepository:pull_requests:readAuthInstallation tokenUser access token

プルリクエスト内のコミットを一覧表示します。

プルリクエストのコミットをスパースな Commit オブジェクト (stats は含まれません) として返します。結果のデフォルトは 30 件で上限は 100 件、全体で表示されるコミットは最大 250 件です。ページトークンはプルリクエストのバージョンとコミットカーソルを固定します。現在の head または base と一致しなくなったトークンは 400 を返します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

クエリパラメータ

pageSize integer

返されるコミットの最大数。未設定または0の場合のデフォルトは30です。100を超える値は100に制限されます。

pageToken string

前回のレスポンスのnext_page_tokenから取得する不透明なカーソル。最初のページでは空です。トークンはリポジトリ、プルリクエストのバージョン、およびコミットオフセットに紐づいています。後続のリクエストで指定したpageSizeはそのページに適用されます。前回のページサイズを維持する場合は省略してください。

レスポンスフィールド

commits 配列

統計情報のないスパースコミット。全体で表示されるコミットは最大250件です。

commits[].sha string

コミットの完全な SHA。

commits[].commit オブジェクト

トップレベルのリポジトリ関係とは別にネストされた Git オブジェクトのメタデータ。

commits[].commit.author object

コミットに記録された Git の作成者識別情報であり、Origin のユーザーオブジェクトではありません。

commits[].commit.author.name string

Git 作成者の ID に記録された名前。

commits[].commit.author.email string

Git の作成者 ID に記録されているメールアドレス。

commits[].commit.author.date string

Git 作成者 ID に記録された RFC 3339 形式の日付。

commits[].commit.committer オブジェクト

コミットに記録された Git コミッターの識別情報であり、Origin のユーザーオブジェクトではありません。

commits[].commit.committer.name string

Gitの識別情報に記録された名前。

commits[].commit.committer.email string

GitのIDに登録されているメールアドレス。

commits[].commit.committer.date string

git署名の元のタイムゾーンオフセットを保持するISO-8601タイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

commits[].commit.message string

コミットメッセージ。

commits[].commit.tree オブジェクト

コミットが参照するツリー。

commits[].commit.tree.sha string

コミットが参照するツリーの SHA。

commits[].parents array

親コミットへの参照。それぞれ SHA を含みます。

commits[].parents[].sha string

親コミットのSHA。

nextPageToken string

トークンはプルリクエストのバージョンとコミットカーソルを固定します。トークンが現在の head または base に対して古くなっている場合は 400 を返します。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/commits' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "commits": [    {      "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "commit": {        "author": {          "name": "Jane Doe",          "email": "[email protected]",          "date": "2026-08-01T09:30:00Z"        },        "committer": {          "name": "Jane Doe",          "email": "[email protected]",          "date": "2026-08-01T09:30:00Z"        },        "message": "Add launch telemetry",        "tree": {          "sha": "a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8"        }      },      "parents": [        {          "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"        }      ],      "stats": {        "additions": 128,        "deletions": 46,        "total": 174      }    }  ]}

プルリクエストの変更ファイル一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/files

Scoperepository:pull_requests:readAuthInstallation tokenUser access token

プルリクエストで変更されたファイルを一覧で取得します。

ファイル名、ステータス、行数、パッチ、および (必要に応じて) 以前のファイル名を返します。結果はデフォルトで30ファイルで、最大100ファイルに制限されます。ページトークンはプルリクエストのバージョンとファイルカーソルを固定します。現在の head または base と一致しないトークンは 400 を返します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

クエリパラメータ

pageSize integer

返却する変更ファイルの最大数。未設定または0の場合のデフォルトは30です。100を超える値は100に制限されます。

pageToken string

前のレスポンスのnext_page_tokenに由来する不透明なカーソル。最初のページでは空です。このトークンはリポジトリ、プルリクエストのバージョン、および変更ファイルカーソルに紐づきます。後続のリクエストで指定した pageSize はそのページに適用されます。省略すると前回のページサイズが維持されます。

レスポンスフィールド

files 配列

現在のプルリクエストのバージョンにおける変更ファイルの記録。

files[].filename string

変更されたプルリクエストファイルのパス。

files[].status string

変更ステータス: 追加、削除、変更、名前変更、またはコピー。

files[].additions integer

ファイルの追加行数。

files[].deletions integer

ファイルの削除行数。

files[].changes integer

ファイルの変更行数の合計。

files[].patch string

ファイルの統合パッチ。

files[].previousFilename string

ファイルがリネームまたはコピーされたときの以前のパス。

nextPageToken string

トークンはプルリクエストのバージョンとファイルカーソルを固定します。トークンが現在の head または base に対して古い場合は 400 を返します。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/files' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造：

{  "files": [    {      "filename": "src/telemetry.ts",      "status": "modified",      "additions": 6,      "deletions": 3,      "changes": 9,      "patch": "@@ -12,6 +12,9 @@\n import { ignite } from \"./ignition\";\n+import { emitLaunchTelemetry } from \"./telemetry\";\n"    }  ]}

プルリクエストのラベル一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/labels

Scoperepository:pull_requests:readAuthInstallation tokenUser access token

プルリクエストに付与されたすべてのラベルを名前順に一覧表示します。

レスポンスにはページ単位ではなく、付与されたラベルの完全な一覧が含まれるため、このエンドポイントにページネーションパラメータはありません。プルリクエストに付与できるラベルは最大100件です。存在しないプルリクエストの場合は 404 が返されます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のslug。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

レスポンスフィールド

labels array

現在プルリクエストに付与されているすべてのラベル。名前順です。

labels[].id string

ラベルの公開識別子。

labels[].name string

リポジトリ内で一意のラベル名。書き込みエンドポイントでは、名前でラベルを指定します。

labels[].color string

先頭の # を含まない6文字の16進カラーコード。

labels[].description string

ラベルの説明。説明がないラベルでは存在しません。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/labels' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "labels": [    {      "id": "lbl_01k2ja2000e0080000000000m1",      "name": "bug",      "color": "d73a4a",      "description": "Something isn't working"    }  ]}

プルリクエストのラベルを設定

PUT/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/labels

Scoperepository:pull_requests:writeAuthInstallation tokenUser access token

プルリクエストに割り当てられているすべてのラベルを、指定したラベルに置き換えます。

空のリストを指定すると、割り当てられているすべてのラベルが削除されます。ラベルはあらかじめリポジトリ内に存在している必要があります。不明なラベル名またはプルリクエストを指定した場合は 404 が返されます。プルリクエストに付与できるラベルは最大100件であるため、100件を超えて指定した場合は FailedPrecondition (HTTP 400) が返されます。レスポンスには、置き換え後に割り当てられたラベルが名前順で返されます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のslug。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

リクエスト本文

labels array

割り当てるラベル名。最大100件。空のリストを指定すると、割り当てられているすべてのラベルが削除されます。重複した名前は無視されます。

レスポンスフィールド

labels array

置き換え後に割り当てられたラベル。名前順で返されます。各エントリには id、name、color、description が含まれます。

curl --request PUT \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/labels' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "labels": [    "bug"  ]}'

レスポンスの構造:

{  "labels": [    {      "id": "lbl_01k2ja2000e0080000000000m1",      "name": "bug",      "color": "d73a4a",      "description": "Something isn't working"    }  ]}

プルリクエストにラベルを追加

POST/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/labels

Scoperepository:pull_requests:writeAuthInstallation tokenUser access token

既存のリポジトリラベルをプルリクエストに追加します。

すでにプルリクエストに付与されているラベルはそのまま維持されます。ラベルはあらかじめリポジトリに存在している必要があります。存在しないラベル名またはプルリクエストを指定すると、404 が返されます。リクエストには1～100個のラベルを指定する必要があり、プルリクエストに付与できるラベルの合計数は最大100個です。その上限を超えるリクエストでは、FailedPrecondition (HTTP 400) が返されます。レスポンスにはプルリクエストのすべてのラベルではなく、指定したラベルのみが含まれます。すべてのラベルを取得するには、プルリクエストのラベル一覧を参照してください。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のslug。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

リクエスト本文

labels array 必須

追加するラベル名。最大100個。重複した名前は無視されます。

レスポンスフィールド

labels array

リクエストで指定したラベル。各エントリには id、name、color、description が含まれます。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/labels' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "labels": [    "bug"  ]}'

レスポンスの構造:

{  "labels": [    {      "id": "lbl_01k2ja2000e0080000000000m1",      "name": "bug",      "color": "d73a4a",      "description": "Something isn't working"    }  ]}

プルリクエストのすべてのラベルを削除

DELETE/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/labels

Scoperepository:pull_requests:writeAuthInstallation tokenUser access token

プルリクエストからすべてのラベルを削除します。

プルリクエストにラベルがない場合も、リクエストは成功します。存在しないプルリクエストの場合は 404 が返されます。レスポンス本文は空です。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意の slug。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

レスポンスフィールド

成功時、レスポンス本文は返されません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/labels' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンス:

204 No Content

プルリクエストのラベルを削除

DELETE/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/labels/{labelName}

Scoperepository:pull_requests:writeAuthInstallation tokenUser access token

プルリクエストからラベルを1つ削除します。

プルリクエストに割り当てられていないラベルや存在しないプルリクエストの場合は、404 が返されます。レスポンスには、プルリクエストに残っているラベルが名前順で含まれます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のslug。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

labelName string 必須

削除するラベルの名前。

レスポンスフィールド

labels array

プルリクエストに残っているラベル。名前順に並び、各エントリには id、name、color、description が含まれます。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/labels/LABEL_NAME' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "labels": [    {      "id": "lbl_01k2ja2000e0080000000000m1",      "name": "bug",      "color": "d73a4a",      "description": "Something isn't working"    }  ]}

プルリクエストのマージ

POST/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/merge

Scoperepository:contents:writeAuthInstallation tokenUser access token

プルリクエストをベースブランチにマージします。

スタック型のプルリクエストでは、このプル番号で終わるルートからターゲットまでのプレフィックス全体をマージします (このプルリクエストだけではありません) 。ネイティブの Origin リポジトリでのみサポートされ、ミラーリポジトリは拒否されます。

マージされるのは、プルリクエストの最新の version の head コミットです。Origin がまだ新しいバージョンとして記録していないプッシュが反映された場合など、ヘッドブランチがそのコミットより先に進んでいる場合は、stale な expectedHeadSha を指定したときと同じく Aborted (HTTP 409 Conflict) が返され、何もマージされません。プルリクエストを取得の version.headSha に新しい head が反映されてから再試行してください。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

マージするプル番号。このプルがスタックされている場合、スタックのルートからこの番号までのすべてのプルがマージされます。

リクエスト本文

expectedHeadSha string

アプリが認識していない head を誤ってマージするのを防ぎます: プルリクエストの現在の head として期待される完全なコミット SHA (16 進数 40 文字または 64 文字)。head が移動している場合、マージは ABORTED (HTTP 409 Conflict) で拒否され、何もマージされません。完全なコミット SHA でない値は InvalidArgument (HTTP 400) で拒否されます。現在の head をそのままマージする場合は指定を省略してください。プルリクエストがすでにマージされている場合は評価されず、冪等な成功が返されます。

mergeMethod string

プルリクエストのマージ方法。指定できる値は、マージコミットを作成する merge と、単一のスカッシュコミットを作成する squash です。リポジトリで許可されていない方法を指定すると FailedPrecondition (HTTP 400) で拒否され、それ以外の値を指定すると InvalidArgument (HTTP 400) で拒否されます。省略するとリポジトリの既定値が使用されます。リポジトリでマージコミットが許可されている場合はマージコミット、それ以外の場合はスカッシュが既定値になります。また、ベースブランチで線形履歴が必須の場合はスカッシュになります。

レスポンスフィールド

mergeCommitSha string

マージによってベースブランチに書き込まれたコミットの SHA。マージ前のプレビューは別のコミットで、Get Git Ref を使って pull/<number>/merge ref 経由で取得します。

mergedPullNumbers 配列

スタックのルートからターゲットまでの間でマージされたプルリクエスト番号のJSON文字列。

pullRequest オブジェクト

マージ後のターゲットPullRequest。例は省略されていますが、宣言されたレスポンスタイプは完全なリソースです。

pullRequest.id string

Stable Origin プルリクエスト識別子。

pullRequest.number 文字列

JSON文字列としてエンコードされたリポジトリローカルのプルリクエスト番号。

pullRequest.state string

プルリクエストの状態：open または closed。マージされたプルリクエストは closed で、merged が true に設定されます。

pullRequest.draft boolean

プルリクエストがドラフトかどうか。

pullRequest.merged boolean

プルリクエストがマージされたかどうか。

pullRequest.title 文字列

プルリクエストのタイトル。

pullRequest.body 文字列

プルリクエストの説明本文。

pullRequest.head object

変更のソース側 — マージされる内容。

pullRequest.head.ref string

Originが記録する、この側が指しているref。

pullRequest.head.sha string

変更の最新バージョンにおけるこの側の先端コミット SHA。

pullRequest.base オブジェクト

変更のターゲット側 — マージ先。

pullRequest.base.ref string

Origin の記録上、この側が指している ref。

pullRequest.base.sha string

変更の最新バージョンにおけるこの側の先端コミット SHA。

pullRequest.author オブジェクト

プルリクエストを作成した公開アクター。

pullRequest.author.user オブジェクト

ユーザーがアクションを実行したときに設定される、アクターのユーザー版。

pullRequest.author.user.id 文字列

ユーザーの公開識別子。

pullRequest.author.user.email string

ユーザーのメールアドレス。ユーザーバリアントが存在する場合は常に設定されます。

pullRequest.author.user.displayName string

pullRequest.author.user.handle string

ユーザーが申告したプロフィールのハンドル。@ プレフィックスは含みません。プロフィールが公開されている間のみ存在し、それ以外の場合は省略されます。

pullRequest.author.app オブジェクト

アクターのアプリ版。アプリがアクションを実行した場合に設定されます。

pullRequest.author.app.id string

アプリの公開識別子。

pullRequest.author.app.displayName string

アプリに登録されている表示名。アプリを解決できない場合、およびCherri Codeのファーストパーティ管理アクターの場合は省略されます。

pullRequest.author.serviceAccount オブジェクト

アクターのサービスアカウント版です。サービスアカウントが操作を実行した場合に設定されます。

pullRequest.author.serviceAccount.id string

サービスアカウントの公開識別子。

pullRequest.createdAt string

RFC 3339形式のプルリクエスト作成タイムスタンプ。

pullRequest.updatedAt string

最新のプルリクエスト更新のRFC 3339タイムスタンプ。

pullRequest.closedAt string

RFC 3339形式のクローズタイムスタンプ。クローズ済みまたはマージ済みのプルリクエストに表示されることがあります。

pullRequest.mergedAt 文字列

RFC 3339形式のマージタイムスタンプ。マージ済みのプルリクエストに表示されることがあります。

pullRequest.mergeCommitSha string

マージによってベースブランチに書き込まれたコミットの SHA。プルリクエストがマージされると設定され、それ以前は存在しません。マージ前のプレビューは別のコミットで、Get Git Ref を使って pull/<number>/merge ref 経由で取得します。

pullRequest.additions 整数

現在のプルリクエストのバージョンで追加された行。

pullRequest.deletions 整数

現在のプルリクエストのバージョンで削除された行。

pullRequest.changedFiles 整数

現在のプルリクエストのバージョンで変更されたファイル数。

pullRequest.labels 配列

現在プルリクエストに割り当てられているラベル。名前順に並べられます。割り当てがない場合は空です。

pullRequest.labels[].id string

ラベルの公開識別子。

pullRequest.labels[].name string

リポジトリ内で一意のラベル名。書き込み用エンドポイントではこの名前でラベルを指定します。

pullRequest.labels[].color 文字列

先頭の # を除く6文字の16進数カラーコード。

pullRequest.labels[].description 文字列

ラベルの説明。説明がない場合は含まれません。

pullRequest.stack オブジェクト

スタックへの所属: このプルリクエストが属する、相互に依存するプルリクエストの連鎖です。各プルリクエストは、その基盤となるプルリクエストの上に積み重ねられています。プルリクエストがスタックの一部でない場合は表示されません。

pullRequest.stack.id string

スタックのすべてのメンバーと共有される安定したスタック識別子。ほかのメンバーを読み取るには、stackId として List Pull Requests に渡してください。

pullRequest.stack.parentPullRequest オブジェクト

このプルリクエストが基盤としているプルリクエストです。スタックのルートでは表示されません。マージ済みの親プルリクエストは、子プルリクエストのターゲットまたは親が変更されるまで参照され続けます。

pullRequest.stack.parentPullRequest.id string

親プルリクエストのStable Origin識別子。

pullRequest.stack.parentPullRequest.number 文字列

親プルリクエストのリポジトリ内での番号 (JSON文字列としてエンコード) 。

pullRequest.stack.parentPullRequest.repository オブジェクト

pullRequest.version オブジェクト

現在の番号付きプルリクエストのバージョンとそのヘッド/ベースのSHA。

pullRequest.version.number 文字列

JSON文字列としてエンコードされた単調増加のプルリクエストのバージョン番号。

pullRequest.version.headSha string

このプルリクエストのバージョンで取得されたヘッド SHA。

pullRequest.version.baseSha string

このプルリクエストのバージョンで取得されたベースSHA。

pullRequest.version.createdAt 文字列

このプルリクエストバージョンの作成日時を表す RFC 3339 タイムスタンプ。

pullRequest.version.potentialMergeCommit オブジェクト

このバージョンのOriginのテストマージ (headShaをベースブランチの先端にマージするコミット) と、その準備がどこまで進んだかを示します。すべてのバージョンに存在します。このバージョンのみを表し、プルリクエストのマージ後も参照できます。mergeCommitShaとは別のコミットです。スタックされたプルリクエストでは、ベースブランチは親のブランチとなるため、テストマージの対象は、そのブランチに対するこのプルリクエストの変更のみです。

pullRequest.version.potentialMergeCommit.state string

テストマージの準備状況。指定できる値: unknown、prepared、merge_conflict。unknown はテストマージがまだ準備されていない状態です。準備待ち、または準備がタイムアウトもしくは失敗したことを示します。新しいバージョンは必ず unknown から始まるため、別のバージョンのコミットを引き継ぐことはありません。prepared はテストマージが存在し、sha と baseSha がその内容を示す状態です。merge_conflict は headSha をベースブランチの先端にマージする際に競合が発生し、テストマージが存在しない状態です。Get Pull Request Mergeability では merge_conflict ブロッカーとして報告され、プルリクエストを再オープンすると、このバージョンの準備が再度行われます。認識できない値は unknown として扱ってください。

pullRequest.version.potentialMergeCommit.sha string

2つの親を持つテストマージコミットのSHA。第1の親はこのオブジェクトの baseSha、第2の親はこのバージョンの headSha です。state が prepared の場合にのみ存在します。このバージョンが最新の間は、pull/{pullNumber}/merge リファレンスがこのコミットを指します。その後も Get Commit でSHAを指定して取得できますが、Git経由ではSHAを指定してフェッチできません。

pullRequest.version.potentialMergeCommit.baseSha string

テスト用マージの作成時に基点となったベースブランチの先端。state が prepared の場合にのみ存在します。pullRequest.version.baseSha より新しい場合がありますが、ベースブランチが進んだだけではOriginはこの値を更新しません。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/merge' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "expectedHeadSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "mergeMethod": "squash"}'

レスポンスの構造:

{  "mergeCommitSha": "5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9a8b7c6d",  "mergedPullNumbers": [    "17"  ],  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "state": "closed",    "draft": false,    "merged": true,    "title": "Add launch telemetry",    "body": "Adds structured launch telemetry to the ignition path.",    "head": {      "ref": "add-telemetry",      "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"    },    "base": {      "ref": "main",      "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"    },    "author": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    },    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z",    "closedAt": "2026-08-03T10:15:00Z",    "mergedAt": "2026-08-03T10:15:00Z",    "mergeCommitSha": "5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9a8b7c6d",    "additions": 128,    "deletions": 46,    "changedFiles": 5,    "labels": [      {        "id": "lbl_01k2ja2000e0080000000000m1",        "name": "bug",        "color": "d73a4a",        "description": "Something isn't working"      }    ],    "version": {      "number": "3",      "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8",      "createdAt": "2026-08-01T09:30:00Z"    }  }}

プルリクエストのマージ可否を取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/mergeability

Scoperepository:pull_requests:readAuthInstallation tokenUser access token

PreviewThis endpoint is in preview and may change before it is generally available.

そのプルリクエストをマージできるかどうかを返し、できない場合はマージを妨げている条件を返します。判定は Merge Pull Request が適用する条件と同じ条件で評価されるため、mergeable という判定は、同じ head のマージが成功すると見込まれることを意味します。スタックされたプルリクエストの場合、判定はスタックのルートからこのプルリクエストまでのすべてのプルリクエストを対象とし、各ブロッカーにはそれが属するプルリクエストが示されます。

マージ済みの祖先を含めて合計200件を超えるプルリクエストからなるスタックの場合は FailedPrecondition (HTTP 400) が返されます。

この操作はプレビュー段階であり、コントラクトが確定するまでは構造が変わる可能性があります。レスポンスのデコードでは未知のフィールドや未知の enum 値を許容し、認識できない verdict は blocked として扱い、blockers[].kind を認識できない場合は blockers[].message を表示してください。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意の slug。

repoName 文字列必須

リポジトリ名。オーナーエンティティ内で一意です。

pullNumber 文字列必須

リポジトリ内で一意のプルリクエスト番号。

クエリパラメータ

expectedHeadSha 文字列

任意のガード。プルリクエストの現在の head であることが期待される完全な commit SHA (16進数で40文字または64文字)。これが設定されており、評価された head と異なる場合、リクエストは結果を返す代わりに Aborted (HTTP 409 Conflict) を返します。完全な commit SHA でない値を指定した場合は InvalidArgument (HTTP 400) を返します。

レスポンスフィールド

pullRequest オブジェクト

判定の対象となるプルリクエスト。

pullRequest.id 文字列

変更されないプルリクエスト識別子。

pullRequest.number 文字列

リポジトリ内で一意のプルリクエスト番号。JSON 文字列としてエンコードされます。

pullRequest.repository オブジェクト

プルリクエストのリポジトリコンテナリファレンス。

pullRequest.repository.id 文字列

コンテナリファレンス内のリポジトリ識別子。

pullRequest.repository.name 文字列

コンテナリファレンス内のリポジトリ名。

pullRequest.repository.owner オブジェクト

リポジトリの所有者リファレンス。

pullRequest.repository.owner.slug 文字列

リポジトリの所有者を識別するために所有者IDと組み合わせて使用する、URL向けの所有者slugです。

pullRequest.repository.owner.id 文字列

オリジンの所有者識別子。

pullRequest.repository.owner.type 文字列

オーナーの namespace の種類。出力専用。指定可能な値: team、user。不明な場合は省略されます。

verdict 文字列

evaluatedPullRequests 内のすべてのプルリクエストに対する総合的な結果です。指定可能な値は mergeable (pullRequest をマージすれば、そのすべてが取り込まれることを意味します) と blocked です。認識できない値は blocked として扱ってください。

blockers 配列

マージを妨げている要因のすべて。まず所属するプルリクエスト順 (stack の root が先) 、次に種類順で並びます。verdict が mergeable の場合は空です。ブロッカーはプルリクエストごと・種類ごとに最大1件です。ただし required_checks は state ごとに1件、rule_failure と ruleset_error は異なる message ごとに1件になります。

blockers[].pullRequest オブジェクト

このブロッカーが属する evaluatedPullRequests 内のプルリクエスト。pullRequest と同じフィールドを持ちます。

blockers[].kind 文字列

ブロッカーのカテゴリ。指定できる値: draft、closed、merged、merge_conflict、required_checks、required_approvals、codeowner_approval、behind_base、needs_restack、restack_pending、conflict_check_pending、invalid_stack、ruleset_error、rule_failure。種類は今後も追加されます。お使いのクライアントより後に追加された種類のブロッカーは、kind が未設定の状態でデコードされますが、引き続きブロック中として扱われます。

blockers[].message 文字列

ブロッカーの内容とその解除方法を人間が読める形式で示した説明。空になることはないため、kind が認識されない場合に表示する内容として使用します。

blockers[].requiredChecks オブジェクト

required_checks ブロッカーに設定されます。

blockers[].requiredChecks.state 文字列

このブロッカー内のすべてのチェックで共有される状態。指定可能な値: missing、pending、failing、action_required。

blockers[].requiredChecks.checks 配列

その状態にある必須チェック。

blockers[].requiredChecks.checks[].name 文字列

リポジトリルールで必要となる名前。

blockers[].requiredChecks.checks[].owner オブジェクト

チェックを報告すると想定されるプリンシパル。チェック実行の actor と同じ actor バリアントを持ちます。

blockers[].requiredChecks.checks[].checkRun オブジェクト

この要件に一致する headSha 上のチェック実行への参照。報告がない場合は省略され、その状態は missing です。含まれるのは id、name、checkSuite.id のみです。これは、この操作が repository:pull_requests:read のみで読み取れるのに対し、実行のステータス、結論、出力、詳細 URL には repository:checks:read が必要なためです。これらは Get Check Run で取得してください。

blockers[].requiredApprovals オブジェクト

required_approvals ブロッカーに設定されます。

blockers[].requiredApprovals.requiredCount integer

リポジトリルールが要求する承認済みの確認。

blockers[].requiredApprovals.approvedCount 整数

現時点で要件のカウント対象となっている承認レビュー。

blockers[].codeownerApproval オブジェクト

codeowner_approval ブロッカーに設定されます。

blockers[].codeownerApproval.requirements 配列

承認がまだ必要な所有者セット。

blockers[].codeownerApproval.requirements[].owners 配列

コード所有者。いずれか 1 人が承認すれば要件を満たします。

blockers[].codeownerApproval.requirements[].paths 配列

この所有者セットが対象とする変更済みパス。

blockers[].mergeConflict オブジェクト

merge_conflict ブロッカーに設定されます。

blockers[].mergeConflict.conflictedPaths 配列

base ブランチと競合するパス。最大 100 件まで表示されます。

blockers[].mergeConflict.truncated boolean

リストに含まれていない競合パスがさらに存在するかどうか。

blockers[].mergeConflict.inheritedFromDownstack boolean

コンフリクトが、スタック内でこのプルリクエストより下位にあるプルリクエストに起因するかどうか。その場合、このプルリクエスト自体がコンフリクトしているのではなく、下位のプルリクエストの解決を待っている状態です。

blockers[].stackShape オブジェクト

invalid_stack ブロッカーで設定されます。

blockers[].stackShape.reason 文字列

stack を評価できない理由。指定可能な値: partially_merged、cycle、missing_parent、cross_repository_parent、base_branch_missing。

blockers[].stackShape.relatedPullRequests 配列

理由に記載がある場合、関連するその他のプルリクエスト。いずれも pullRequest と同じフィールドを持ちます。

evaluatedPullRequests 配列

pullRequest のマージによって land するプルリクエストの一覧です。stack の root から順に並び、最後が pullRequest になります。すでにマージ済みの祖先は history 扱いとなり、一覧には含まれません。stack されていないプルリクエストの場合、要素はちょうど 1 つです。各要素は pullRequest と同じフィールドを持ちます。

headSha 文字列

評価対象となった pullRequest の head commit。

baseRef 文字列

評価対象のプルリクエストがマージされるブランチ。スタックされている場合は、このプルリクエスト自身の base ではなく、スタックルートの base になります。

baseSha 文字列

evaluatedAt 時点における baseRef の tip commit です。その後 baseRef に push があると verdict が変わることがあります。無効な stack の場合など、base branch を特定できなかった場合は空になります。

evaluatedAt 文字列

この結果が評価された日時を示す RFC 3339 形式のタイムスタンプ。これ以降の変更は反映されません。反映するには再度クエリしてください。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/mergeability' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

{  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "repository": {      "id": "repo_01k2ja2000e0080000000000a1",      "name": "launch-control",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000b2"      }    }  },  "verdict": "blocked",  "blockers": [    {      "pullRequest": {        "id": "pr_01k2ja2000e0080000000000d4",        "number": "17",        "repository": {          "id": "repo_01k2ja2000e0080000000000a1",          "name": "launch-control",          "owner": {            "slug": "acme",            "id": "ns_01k2ja2000e0080000000000b2"          }        }      },      "kind": "required_approvals",      "message": "Approving review count is 0; 1 required. Request reviews and wait for the required approvals.",      "requiredApprovals": {        "requiredCount": 1,        "approvedCount": 0      }    },    {      "pullRequest": {        "id": "pr_01k2ja2000e0080000000000d4",        "number": "17",        "repository": {          "id": "repo_01k2ja2000e0080000000000a1",          "name": "launch-control",          "owner": {            "slug": "acme",            "id": "ns_01k2ja2000e0080000000000b2"          }        }      },      "kind": "required_checks",      "message": "Required status checks are pending. Wait for checks to finish or fix the failing checks.",      "requiredChecks": {        "state": "pending",        "checks": [          {            "name": "ci / build",            "owner": {              "app": {                "id": "app_01k2ja2000e0080000000000e5",                "displayName": "Launch CI"              }            },            "checkRun": {              "id": "cr_01k2ja2000e0080000000000f6",              "name": "ci / build",              "checkSuite": {                "id": "crg_01k2ja2000e0080000000000f7"              }            }          }        ]      }    }  ],  "evaluatedPullRequests": [    {      "id": "pr_01k2ja2000e0080000000000d4",      "number": "17",      "repository": {        "id": "repo_01k2ja2000e0080000000000a1",        "name": "launch-control",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000b2"        }      }    }  ],  "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "baseRef": "main",  "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8",  "evaluatedAt": "2026-08-02T14:45:00Z"}

プルリクエストの確認依頼先の一覧取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/requested_reviewers

Scoperepository:pull_requests:reviews:readAuthInstallation tokenUser access token

プルリクエストで現在確認が依頼されているユーザーとグループを一覧表示します。

個別の依頼は該当ユーザーが確認を送信すると解除され、グループへの依頼はグループの現在のメンバーのいずれかが送信すると解除されます。未送信の下書き確認では依頼は保留のままとなり、送信後に再度確認を依頼すると、そのレビュアーがこの一覧に戻ります。読み取り可能な公開識別子を持たないグループは除外されます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のslug。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

リポジトリローカルのプルリクエスト番号。

レスポンスフィールド

users array

確認が依頼されているユーザー。保留中のものがない場合は空です。

users[].id string

エンコードされたユーザー識別子 (user_…)。organization API が使用する形式と同じです。

users[].email string

ユーザーのメールアドレス。アカウントに設定がない場合は空です。

users[].displayName string

users[].handle string

ユーザーが取得したプロフィールのハンドル (@ プレフィックスなし)。そのプロフィールが公開されている場合にのみ含まれ、それ以外は省略されます。

groups array

確認が依頼されているグループ。保留中のものがない場合は空です。

groups[].id string

グループの公開識別子 (grp_…)。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/requested_reviewers' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "users": [    {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  ],  "groups": [    {      "id": "grp_01k2ja2000e0080000000000n2"    }  ]}

Request Pull Request Reviewers

POST/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/requested_reviewers

Scoperepository:pull_requests:reviews:writeAuthInstallation tokenUser access token

指定したユーザーとグループにプルリクエストのレビューを依頼し、この呼び出しで依頼したレビュー担当者を返します。

識別子はリポジトリのレビュアー候補と、public id、ユーザーのメールアドレス、またはグループのスラグで照合されます。表示名では解決されません。不明または曖昧な識別子の場合は、その識別子を示す InvalidArgument (HTTP 400) が返されます。また、users と groups の合計で少なくとも1つの空でないエントリが必要です。

すでに依頼済みのレビュー担当者を再度依頼すると依頼のタイムスタンプが更新されるため、レビューを提出済みの担当者が再び保留中として表示されます。リポジトリの候補でないレビュー担当者を指定した場合は PermissionDenied (HTTP 403) が返されます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意な slug。

repoName string 必須

リポジトリ名。オーナーエンティティ内で一意です。

pullNumber string 必須

リポジトリ内で一意なプルリクエスト番号。

リクエストボディ

users array

依頼するユーザー識別子。各エントリは、パブリックな user_… ID またはメールアドレスによってリポジトリ内のユーザー候補と一意に一致する必要があります。

groups array

リクエストするグループの識別子。各エントリは、公開の grp_… ID、修飾済みグループスラッグ、またはグループスラッグによって、リポジトリ内のグループ候補と一意に一致している必要があります。

レスポンスフィールド

users array

この呼び出しで依頼したユーザー。

users[].id string

エンコードされたユーザー識別子 (user_…) 。Organization API で使用されるものと同じ形式です。

users[].email string

ユーザーのメールアドレス。アカウントに設定がない場合は空になります。

users[].displayName string

ユーザーの表示名: アカウントの姓と名を半角スペースで結合したもので、製品に表示される名前と同じです。アカウントに名前がない場合は省略されます。

users[].handle string

ユーザーが主張するプロフィールのハンドル。@ プレフィックスは含みません。そのプロフィールが公開されている場合にのみ存在し、それ以外の場合は省略されます。

groups array

この呼び出しで要求されたグループ。

groups[].id string

グループの public 識別子 (grp_…) 。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/requested_reviewers' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "users": [    "user_01k2ja2000e0080000000000c3"  ],  "groups": [    "grp_01k2ja2000e0080000000000n2"  ]}'

レスポンスの構造:

{  "users": [    {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  ],  "groups": [    {      "id": "grp_01k2ja2000e0080000000000n2"    }  ]}

プルリクエストの確認依頼先の削除

DELETE/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/requested_reviewers

Scoperepository:pull_requests:reviews:writeAuthInstallation tokenUser access token

プルリクエストに対する、指定したユーザーおよびグループへの確認依頼を削除します。レスポンス本文は空です。

識別子は、公開ID、ユーザーのメールアドレス、またはグループのslugによって、リポジトリの確認担当候補と照合されます。表示名では解決されません。不明または曖昧な識別子の場合は、その識別子を示す InvalidArgument (HTTP 400) が返されます。また、users と groups を合わせて少なくとも1つは空でないエントリが必要です。

現在確認依頼されていないユーザーやグループを削除しても、何も起こりません。すでに確認担当候補ではない識別子でも、安定した公開ID (user_… または grp_…) であれば受け付けられるため、リポジトリを離れた確認担当者も解除できます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のslug。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

リポジトリローカルのプルリクエスト番号。

リクエスト本文

users array

削除するユーザー識別子。各エントリは、公開 user_… ID またはメールアドレスによって、リポジトリのユーザー候補と一意に一致する必要があります。

groups array

削除するグループ識別子。各エントリは、公開 grp_… ID、修飾されたグループslug、またはグループslugによって、リポジトリのグループ候補と一意に一致する必要があります。

レスポンスフィールド

リクエストが成功した場合、レスポンス本文は返されません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/requested_reviewers' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "users": [    "user_01k2ja2000e0080000000000c3"  ],  "groups": [    "grp_01k2ja2000e0080000000000n2"  ]}'

レスポンス:

204 No Content

プルリクエストレビューを一覧表示

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/reviews

Scoperepository:pull_requests:reviews:readAuthInstallation tokenUser access token

プルリクエストに提出されたレビューをsubmitted_atの昇順で一覧表示します。保留中のレビューは含まれません。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

クエリパラメータ

pageSize 整数

返すレビューの最大数。デフォルトは30、最大は100。

pageToken string

前のレスポンスのnextPageTokenからの不透明なカーソル。最初のページでは省略してください。後続のリクエストでpageSizeを指定すると、そのページに適用されます。省略した場合は前のページサイズが維持されます。

レスポンスフィールド

reviews 配列

送信済みレビューは submittedAt の昇順で並べられ、未送信のドラフトレビューは除外されます。

reviews[].id string

安定したレビュー識別子。

reviews[].author オブジェクト

レビューを作成した公開アクター。

reviews[].author.user オブジェクト

アクターのユーザー別バリアント。ユーザーが操作を行ったときに設定されます。

reviews[].author.user.id string

ユーザーの公開識別子。

reviews[].author.user.email string

ユーザーのメールアドレス。userバリアントが存在する場合は常に設定されます。

reviews[].author.user.displayName string

ユーザーの表示名: アカウントの名と姓をスペースで結合した、製品に表示される名前。アカウントに名前がない場合は省略されます。

reviews[].author.user.handle string

ユーザーが申告したプロフィールハンドル (@プレフィックスなし) 。そのプロフィールが公開されている間のみ表示され、公開されていない場合は省略されます。

reviews[].author.app オブジェクト

アクターのアプリ版。アプリがアクションを実行した場合に設定されます。

reviews[].author.app.id string

アプリの公開識別子。

reviews[].author.app.displayName string

アプリの登録済み表示名。アプリを解決できない場合、またはCherri Codeのファーストパーティ管理アクターの場合は省略されます。

reviews[].author.serviceAccount オブジェクト

アクターのサービスアカウント版。サービスアカウントが操作を行ったときに設定されます。

reviews[].author.serviceAccount.id string

サービスアカウントの公開識別子。

reviews[].verdict string

レビュー結果: 承認、変更要求、またはコメント。

reviews[].body string

レビュー要約のテキスト。

reviews[].submittedAt string

RFC 3339形式の送信タイムスタンプ。未提出のドラフトレビューでは存在しません。

reviews[].pullRequestVersion オブジェクト

レビューの対象となるプルリクエストのバージョン。

reviews[].pullRequestVersion.number string

JSON文字列としてエンコードされた単調増加のプルリクエストのバージョン番号。

reviews[].pullRequestVersion.headSha string

このプルリクエストのバージョンで取得されたHead SHA。

reviews[].pullRequestVersion.baseSha string

このプルリクエストバージョンで取得されたベースSHA。

reviews[].dismissal オブジェクト

レビューが却下された後に表示されます。却下されたレビューは一覧に引き続き表示されます。

reviews[].dismissal.dismissedBy object

公開されたときにレビューを却下したパブリックアクター。

reviews[].dismissal.dismissedBy.user object

アクターのユーザー別バリアント。ユーザーが操作を行ったときに設定されます。

reviews[].dismissal.dismissedBy.user.id string

ユーザーの公開識別子。

reviews[].dismissal.dismissedBy.user.email string

ユーザーのメールアドレス。userバリアントが存在する場合は常に設定されます。

reviews[].dismissal.dismissedBy.user.displayName string

ユーザーの表示名: アカウントの名と姓をスペースで結合した、製品に表示される名前。アカウントに名前がない場合は省略されます。

reviews[].dismissal.dismissedBy.user.handle string

reviews[].dismissal.dismissedBy.app object

アクターのアプリ版。アプリがアクションを実行した場合に設定されます。

reviews[].dismissal.dismissedBy.app.id string

アプリの公開識別子。

reviews[].dismissal.dismissedBy.app.displayName string

アプリの登録済み表示名。アプリを解決できない場合、またはCherri Codeのファーストパーティ管理アクターの場合は省略されます。

reviews[].dismissal.dismissedBy.serviceAccount オブジェクト

アクターのサービスアカウント版。サービスアカウントが操作を行ったときに設定されます。

reviews[].dismissal.dismissedBy.serviceAccount.id string

サービスアカウントの公開識別子。

reviews[].dismissal.dismissedAt 文字列

RFC 3339形式の却下タイムスタンプ。

reviews[].dismissal.message string

却下理由。自動的に置き換えられた場合はサーバー生成のメッセージが使用されます。

pullRequest オブジェクト

レビュー画面と併せて含まれる PullRequestReference コンテナ。

pullRequest.id string

安定したプルリクエスト識別子。

pullRequest.number 文字列

JSON文字列としてエンコードされたリポジトリ内のプルリクエスト番号。

pullRequest.repository object

プルリクエストのリポジトリコンテナ参照。

pullRequest.repository.id 文字列

コンテナ参照内のリポジトリ識別子。

pullRequest.repository.name string

コンテナ参照内のリポジトリ名。

pullRequest.repository.owner オブジェクト

リポジトリのオーナー参照。

pullRequest.repository.owner.slug 文字列

リポジトリの所有者を識別するために、所有者IDとともに使用されるURL用のオーナースラッグ。

pullRequest.repository.owner.id string

オリジン所有者の識別子。

pullRequest.repository.owner.type string

所有者の名前空間のタイプ。出力専用。許可されている値: team, user。不明な場合は省略されます。

nextPageToken 文字列

次のページ用の不透明なカーソル。レビューがこれ以上ない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/reviews' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "reviews": [    {      "id": "rev_01k2ja2000e0080000000000f6",      "author": {        "user": {          "id": "user_01k2ja2000e0080000000000c3",          "email": "[email protected]"        }      },      "verdict": "approve",      "body": "Approving. The telemetry schema matches the spec.",      "submittedAt": "2026-08-02T15:00:00Z",      "pullRequestVersion": {        "number": "3",        "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",        "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"      }    }  ],  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    }  }}

プルリクエストレビューを作成

POST/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/reviews

Scoperepository:pull_requests:reviews:writeAuthInstallation tokenUser access token

プルリクエストのレビューを作成して送信します。コメントを含めて単一のアトミックなリクエストとしてまとめて送信することもできます。各コメントが指定するターゲットはプルリクエストコメントを作成と同じで、行範囲にはcomments[].inline、ファイル全体にはcomments[].file、返信にはcomments[].threadId、一般的なディスカッションにはいずれも指定しません。

レビューは直ちに送信されます。新しい approve または request_changes のレビューは同じプルリクエストに対する呼び出し元の以前のライブな決定レビューを上書きし、そのレビューは取り消されます。プルリクエストの作成者は自分のプルリクエストを approve できません。呼び出し元がプルリクエストに未送信の下書きレビューを持っている間は FAILED_PRECONDITION で失敗します。

comments が設定されている場合、何かが書き込まれる前に、Create Pull Request Comment と同じ diff 内チェックを使って、すべてのアンカーがレビュー対象バージョンの diff に対して検証されます。1 件のコメントでも失敗すると、リクエスト全体が InvalidArgument (HTTP 400) で失敗し、何も公開されません。コメントはレビューとともに原子的に表示されます。レビューが送信されるまではコメントやイベントは観測されず、送信されると各コメントがレビューのイベントと並んでそれぞれ pull_request.comment.created webhook を発行します。

この操作には冪等性キーが含まれていないため、原因が不明な通信障害後に再試行すると2件目のレビューが作成される可能性があります。再試行する前に、プルリクエストのレビューを一覧表示を呼び出してください。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

リクエスト本文

verdict string 必須

レビューの判定。許容される値: PULL_REQUEST_REVIEW_VERDICT_UNSPECIFIED、approve、request_changes、comment。

body string

自由記述のレビュー要約。空でもかまいません。

versionNumber 文字列

レビュー対象のプルリクエストのバージョン番号 (PullRequestVersion.number を参照) 。省略すると、呼び出し時点での最新バージョンがレビューされます。コメントはこの同じバージョンに紐付けられます。

comments 配列

レビューと同時に一括で公開されるコメント。リクエストごとに最大50件。

comments[].body string 必須

コメント本文。空白以外の文字を少なくとも1文字含める必要があります。

comments[].inline オブジェクト

確認対象バージョンの差分上に新しいインラインスレッドを作成するための差分アンカー。形式および検証はプルリクエストコメントを作成の inline と同じです。comments[].threadId と併用することはできません。

comments[].inline.path string 必須

レビュー対象バージョンの差分内のファイルパス。

comments[].inline.side string 必須

アンカーの差分側。許容値: ファイルのベース版は left、ヘッド版は right。

comments[].inline.startLine 整数必須

ファイルの side バージョンにおけるアンカー範囲の先頭行 (1始まり) 。範囲はファイルの末尾を超えてはなりません。

comments[].inline.endLine 整数

アンカー範囲に含まれる最終行。startLine 以上である必要があります。単一行のアンカーの場合は省略してください。

comments[].threadId string

返信先となるこのプルリクエスト上の既存スレッドID。返信はレビューが公開されるまで非表示になります。comments[].inline、comments[].file、およびこのフィールドを省略すると、新しい一般ディスカッションスレッドが開始されます。

comments[].file オブジェクト

レビュー対象バージョンの差分内のファイル全体に対する新しいファイルレベルのスレッドのアンカー。形式、side の導出、および検証はプルリクエストコメントを作成の file と同じです。comments[].inline や comments[].threadId と併用できません。

comments[].file.path string 必須

レビュー対象バージョンの差分内のファイルパス: 削除の場合は削除されたパス、それ以外の場合はヘッドのパス。

レスポンスフィールド

id string

安定したレビュー識別子。

author オブジェクト

レビューを作成した公開アクター。

author.user オブジェクト

アクターのユーザー版。ユーザーが操作を行った場合に設定されます。

author.user.id string

ユーザーの公開識別子。

author.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

author.user.displayName string

ユーザーの表示名: アカウントの名と姓をスペースでつないだ、製品に表示される名前です。アカウントに名前がない場合は省略されます。

author.user.handle string

author.app オブジェクト

アクターのアプリのバリアント。アプリがアクションを実行したときに設定されます。

author.app.id 文字列

アプリの公開識別子。

author.app.displayName 文字列

アプリの登録済み表示名。アプリを解決できない場合、およびCherri Codeのファーストパーティ管理アクターの場合は省略されます。

author.serviceAccount オブジェクト

アクターのサービスアカウント版。サービスアカウントが操作を実行した場合に設定されます。

author.serviceAccount.id string

サービスアカウントの公開識別子。

verdict string

レビューの判定：承認、変更を要求、またはコメント。

body string

レビューの要約。

submittedAt 文字列

RFC 3339 形式の送信タイムスタンプ。未送信の下書きレビューの場合は存在しません。

pullRequestVersion オブジェクト

レビューが適用されるプルリクエストのバージョン。

pullRequestVersion.number string

JSON文字列としてエンコードされた単調増加するプルリクエストのバージョン番号。

pullRequestVersion.headSha string

このプルリクエストのこのバージョンで取得された Head SHA。

pullRequestVersion.baseSha string

このプルリクエストのバージョンでキャプチャされたベース SHA。

dismissal オブジェクト

レビューが却下された後に表示されます。却下されたレビューは一覧に引き続き表示されます。

dismissal.dismissedBy オブジェクト

公開時にレビューを却下した公開アクター。

dismissal.dismissedBy.user オブジェクト

ユーザーが操作を行った場合に設定される、アクターのユーザー版。

dismissal.dismissedBy.user.id string

ユーザーの公開識別子。

dismissal.dismissedBy.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

dismissal.dismissedBy.user.displayName string

ユーザーの表示名: アカウントの名と姓をスペースでつないだ、製品に表示される名前です。アカウントに名前がない場合は省略されます。

dismissal.dismissedBy.user.handle string

ユーザーが自己申告したプロフィールのハンドル。@ プレフィックスは含みません。プロフィールが公開されている場合にのみ存在し、それ以外では省略されます。

dismissal.dismissedBy.app オブジェクト

アクターのアプリのバリアント。アプリがアクションを実行したときに設定されます。

dismissal.dismissedBy.app.id 文字列

アプリの公開識別子。

dismissal.dismissedBy.app.displayName string

アプリの登録済み表示名。アプリを解決できない場合、およびCherri Codeのファーストパーティ管理アクターの場合は省略されます。

dismissal.dismissedBy.serviceAccount オブジェクト

アクターのサービスアカウント版です。サービスアカウントが操作を実行した場合に設定されます。

dismissal.dismissedBy.serviceAccount.id string

サービスアカウントの公開識別子。

dismissal.dismissedAt string

RFC 3339の破棄タイムスタンプ。

dismissal.message 文字列

却下理由。自動的な置き換えには、サーバーで生成されたメッセージが使用されます。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/reviews' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "verdict": "approve",  "body": "Approving. The telemetry schema matches the spec.",  "versionNumber": "3"}'

レスポンスの構造:

{  "id": "rev_01k2ja2000e0080000000000f6",  "author": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "verdict": "approve",  "body": "Approving. The telemetry schema matches the spec.",  "submittedAt": "2026-08-02T15:00:00Z",  "pullRequestVersion": {    "number": "3",    "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"  }}

プルリクエストレビューを更新

PATCH/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/reviews/{reviewId}

Scoperepository:pull_requests:reviews:writeAuthInstallation tokenUser access token

レビューの本文を更新します。更新できるのはレビューの作成者のみで、その他の呼び出し元には PERMISSION_DENIED が返されます。指定されたプルリクエストに属さないレビューの場合は NOT_FOUND が返されます。

未送信の下書きレビューも更新できます。下書きのレスポンスには submitted_at がありません。

パスパラメータ

ownerSlug string 必須

所有するエンティティの一意のスラッグ。

repoName string 必須

所有者エンティティに固有のリポジトリ名。

pullNumber string 必須

reviewId string 必須

リクエスト本文

body string 必須

レビュー要約の置換テキスト。既存の本文全体を置き換えます。空白以外の文字を少なくとも1文字含める必要があります。含まれない場合はINVALID_ARGUMENTになります。

レスポンスフィールド

id string

安定したレビュー識別子。

author オブジェクト

レビューを作成した公開アクター。

author.user オブジェクト

アクターのユーザー版。ユーザーが操作を行ったときに設定されます。

author.user.id string

ユーザーの公開識別子。

author.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

author.user.displayName string

author.user.handle string

ユーザーが申告したプロフィールハンドル (@ プレフィックスなし) 。そのプロフィールが公開されている間のみ表示され、それ以外では省略されます。

author.app オブジェクト

アクターのアプリバリアント。アプリがアクションを実行した際に設定されます。

author.app.id string

アプリの公開識別子。

author.app.displayName string

アプリに登録された表示名。アプリを特定できない場合や、Cherri Code のファーストパーティ管理アクターでは省略されます。

author.serviceAccount オブジェクト

アクターのサービスアカウントのバリアント。サービスアカウントが操作を実行したときに設定されます。

author.serviceAccount.id string

サービスアカウントの公開識別子。

verdict string

レビューの判定：approve、request_changes、または comment。

body string

レビューの要約テキスト。

submittedAt string

RFC 3339形式の送信タイムスタンプ。未送信のドラフトレビューでは存在しません。

pullRequestVersion オブジェクト

レビューが適用されるプルリクエストのバージョン。

pullRequestVersion.number string

JSON文字列としてエンコードされた単調増加するプルリクエストのバージョン番号。

pullRequestVersion.headSha string

このプルリクエストのバージョンで取得された Head SHA。

pullRequestVersion.baseSha string

このプルリクエストのバージョンで取得されたベース SHA。

dismissal オブジェクト

レビューが却下された後に表示されます。却下されたレビューは一覧に引き続き表示されます。

dismissal.dismissedBy オブジェクト

発覚した際にレビューを退けた公人。

dismissal.dismissedBy.user オブジェクト

アクターのユーザー版。ユーザーが操作を行ったときに設定されます。

dismissal.dismissedBy.user.id string

ユーザーの公開識別子。

dismissal.dismissedBy.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

dismissal.dismissedBy.user.displayName string

dismissal.dismissedBy.user.handle string

ユーザーが取得したプロフィールのハンドル (@ プレフィックスなし) 。そのプロフィールが公開されている場合にのみ表示され、公開されていない場合は省略されます。

dismissal.dismissedBy.app オブジェクト

アクターのアプリバリアント。アプリがアクションを実行した際に設定されます。

dismissal.dismissedBy.app.id string

アプリの公開識別子。

dismissal.dismissedBy.app.displayName string

アプリに登録された表示名。アプリを特定できない場合や、Cherri Code のファーストパーティ管理アクターでは省略されます。

dismissal.dismissedBy.serviceAccount オブジェクト

アクターのサービスアカウントのバリアント。サービスアカウントが操作を実行したときに設定されます。

dismissal.dismissedBy.serviceAccount.id string

サービスアカウントの公開識別子。

dismissal.dismissedAt 文字列

RFC 3339 形式の却下タイムスタンプ。

dismissal.message string

却下理由。自動的に置き換えられる場合はサーバー生成のメッセージが使用されます。

curl --request PATCH \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/reviews/REVIEW_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "body": "Approving. The telemetry schema matches the spec."}'

レスポンスの構造:

{  "id": "rev_01k2ja2000e0080000000000f6",  "author": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "verdict": "approve",  "body": "Approving. The telemetry schema matches the spec.",  "submittedAt": "2026-08-02T15:00:00Z",  "pullRequestVersion": {    "number": "3",    "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"  }}

プルリクエストのレビューを却下

PUT/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/reviews/{reviewId}/dismissals

Scoperepository:pull_requests:reviews:writeAuthInstallation tokenUser access token

送信済みのレビューを却下し、その判定がプルリクエストのレビュー状態に反映されないようにします。レビュー自体は保持され、dismissal が設定された状態で ListPullRequestReviews に引き続き表示されます。

却下するために、プルリクエストレビューの作成者である必要はありません。リポジトリのプルリクエストレビューに対する書き込み権限があれば十分です。

却下できるのは approve と request_changes のレビューのみで、しかも一度だけです。comment レビュー、未送信のドラフトレビュー、または既に却下されたレビューは FAILED_PRECONDITION を返し、呼び出しを繰り返しても最初の却下のままになります。指定されたプルリクエストに属さないレビューは NOT_FOUND を返します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

reviewId string 必須

ListPullRequestReviews が返す安定した Origin レビュー識別子。

リクエスト本文

message string 必須

却下時に記録する理由。空白以外の文字を含める必要があります。含まれない場合はINVALID_ARGUMENTになります。

レスポンスフィールド

id string

安定したレビュー識別子。

author オブジェクト

レビューを書いた公開アクター。

author.user オブジェクト

ユーザーがアクションを実行した場合に設定される、アクターのユーザー変種。

author.user.id string

ユーザーの公開識別子。

author.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

author.user.displayName string

author.user.handle string

author.app オブジェクト

アクターのアプリのバリアント。アプリがアクションを実行したときに設定されます。

author.app.id string

アプリの公開識別子。

author.app.displayName string

アプリに登録されている表示名。アプリを解決できない場合およびCherri Codeのファーストパーティ管理アクターでは省略されます。

author.serviceAccount オブジェクト

アクターのサービスアカウントのバリアント。サービスアカウントが操作を実行した場合に設定されます。

author.serviceAccount.id string

サービスアカウントの公開識別子。

verdict string

確認結果：承認 (approve)、変更を要求 (request_changes)、またはコメント (comment)。

body string

レビューの要約。

submittedAt 文字列

RFC 3339形式の送信タイムスタンプ。未送信のドラフトレビューの場合は存在しません。

pullRequestVersion オブジェクト

レビューが適用されるプルリクエストのバージョン。

pullRequestVersion.number string

JSON文字列としてエンコードされた単調増加するプルリクエストのバージョン番号。

pullRequestVersion.headSha 文字列

このプルリクエストのバージョンで取得されたヘッドSHA。

pullRequestVersion.baseSha string

このプルリクエストのバージョンで取得されたベースSHA。

dismissal object

レビューが却下された後に表示されます。却下されたレビューは一覧に引き続き表示されます。

dismissal.dismissedBy オブジェクト

公開される場合にレビューを却下した公開アクター。

dismissal.dismissedBy.user オブジェクト

ユーザーがアクションを実行した場合に設定される、アクターのユーザー変種。

dismissal.dismissedBy.user.id string

ユーザーの公開識別子。

dismissal.dismissedBy.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

dismissal.dismissedBy.user.displayName string

dismissal.dismissedBy.user.handle string

dismissal.dismissedBy.app オブジェクト

アクターのアプリのバリアント。アプリがアクションを実行したときに設定されます。

dismissal.dismissedBy.app.id string

アプリの公開識別子。

dismissal.dismissedBy.app.displayName string

アプリに登録されている表示名。アプリを解決できない場合およびCherri Codeのファーストパーティ管理アクターでは省略されます。

dismissal.dismissedBy.serviceAccount オブジェクト

アクターのサービスアカウントのバリアント。サービスアカウントが操作を実行した場合に設定されます。

dismissal.dismissedBy.serviceAccount.id string

サービスアカウントの公開識別子。

dismissal.dismissedAt 文字列

RFC 3339 形式の却下タイムスタンプ。

dismissal.message 文字列

却下理由。自動的に置き換えられる場合はサーバー生成のメッセージが使用されます。

curl --request PUT \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/reviews/REVIEW_ID/dismissals' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "message": "Superseded by a newer review."}'

レスポンスの構造:

{  "id": "rev_01k2ja2000e0080000000000f6",  "author": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "verdict": "approve",  "body": "Approving. The telemetry schema matches the spec.",  "submittedAt": "2026-08-02T15:00:00Z",  "pullRequestVersion": {    "number": "3",    "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"  },  "dismissal": {    "dismissedBy": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    },    "dismissedAt": "2026-08-02T15:00:00Z",    "message": "Superseded by a newer review."  }}

ルールセット

ルールセットの一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/rulesets

Scoperepository:rulesets:readAuthInstallation tokenUser access token

リポジトリに設定されているすべてのルールセットを一覧表示します。

リポジトリごとのルールセットは設定が制限されているため、完全なセットは1つのレスポンスで返され、このエンドポイントはページネーションを行いません。repository は1回だけ上位に移動され、レスポンス内のすべてのルールセットで共有されるリポジトリを表します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

レスポンスフィールド

rulesets array

リポジトリに設定されているルールセット。

rulesets[].id string

Stable Origin ルールセット ID。

rulesets[].name string

ルールセット名。

rulesets[].description 文字列

ルールセットの説明。

rulesets[].enforcement string

Origin がルールセットを適用する方法。指定可能な値: active、evaluate、disabled。

rulesets[].kind string

ルールセットが保護する操作。指定できる値：merge_branch、push_branch、push_tag、push_repository。

rulesets[].includedRefNames 配列

このルールセットに含める ref 名のパターン。glob とトークン ~ALL、~DEFAULT_BRANCH をサポートします。

rulesets[].excludedRefNames 配列

このルールセットが除外するリファレンス名のパターン。rulesets[].includedRefNames と同じパターン言語です。

rulesets[].rules 配列

このルールセット内の保護ルール。

rulesets[].rules[].id string

このルールの安定したオリジン ID。

rulesets[].rules[].ruleType 文字列

ルールの種類。例：pull_request、require_status_checks、require_branch_up_to_date、deletion、non_fast_forward。

rulesets[].rules[].parameters オブジェクト

タイプ固有のパラメータをJSONオブジェクトとして指定します。構造はrulesets[].rules[].ruleTypeによって異なります。

rulesets[].bypassActors 配列

このルールセットをバイパスできる主体。保存された識別情報を読み取れないバイパス実行者はレスポンスから省かれます。

rulesets[].bypassActors[].id string

このバイパスアクターの安定したオリジンID。

rulesets[].bypassActors[].bypassMode string

バイパスを適用するタイミング。指定できる値: always、pull_request_only。

rulesets[].bypassActors[].user オブジェクト

ユーザープリンシパル。user、team、app、originRole のうち正確に1つが存在します。

rulesets[].bypassActors[].user.id string

10進数の文字列としてエンコードされたカーソルの数値ユーザーID。

rulesets[].bypassActors[].team オブジェクト

チーム代表。

rulesets[].bypassActors[].team.organizationPublicId string

不変の組織公開 ID。

rulesets[].bypassActors[].team.groupPublicId string

変更不可能なグループ公開ID。

rulesets[].bypassActors[].app オブジェクト

アプリケーションのプリンシパル。

rulesets[].bypassActors[].app.id string

app_で始まるApp ID。

rulesets[].bypassActors[].originRole オブジェクト

Origin ロールを持つプリンシパル。

rulesets[].bypassActors[].originRole.role string

使用できる値: namespace_admin、repository_admin、repository_write。

repository オブジェクト

このレスポンス内のすべてのルールセットで共有されるリポジトリ。

repository.id string

コンテナ参照内のリポジトリ識別子。

repository.name string

コンテナ参照内のリポジトリ名。

repository.owner オブジェクト

リポジトリの所有者参照。

repository.owner.slug string

オーナーIDと組み合わせてリポジトリの所有者を識別する、URL 表示用のオーナースラグ。

repository.owner.id string

Origin の所有者識別子。

repository.owner.type 文字列

所有者の名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/rulesets' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "rulesets": [    {      "id": "rs_01k2ja2000e0080000000000t7",      "name": "require-review",      "description": "Require an approving review before merging to main.",      "enforcement": "active",      "kind": "merge_branch",      "includedRefNames": [        "refs/heads/main"      ],      "rules": [        {          "id": "rsr_01k2ja2000e0080000000000v8",          "ruleType": "pull_request",          "parameters": {            "requiredApprovingReviewCount": 1          }        }      ],      "bypassActors": [        {          "id": "rsba_01k2ja2000e0080000000000w9",          "bypassMode": "always",          "user": {            "id": "act_01k2ja2000e0080000000000x0"          }        }      ]    }  ],  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  }}

ルールセットを作成

POST/v1/origin/repos/{ownerSlug}/{repoName}/rulesets

Scoperepository:rulesets:writeAuthInstallation tokenUser access token

リポジトリのルールセットを作成します。

レスポンスには、保存されたルールセットと、Origin が各ルールおよびバイパスアクターに割り当てた ID が含まれます。name が空の場合は、InvalidArgument (HTTP 400) で拒否されます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

リクエスト本文

name string 必須

ルールセット名。

description 文字列

ルールセットの説明。

enforcement string 必須

Origin によるルールセットの適用方法。指定可能な値: active、evaluate、disabled。

kind string 必須

ルールセットが保護する操作。指定可能な値: merge_branch、push_branch、push_tag、push_repository。

includedRefNames 配列

このルールセットに含めるリファレンス名のパターン。glob とトークン ~ALL および ~DEFAULT_BRANCH をサポートします。64 件を超えるエントリは InvalidArgument (HTTP 400) によって拒否されます。

excludedRefNames 配列

このルールセットが除外する参照名のパターン。パターン言語と上限 (64件) は includedRefNames と同じです。

rules array

保存する保護ルール。各エントリには ruleType と省略可能な parameters が含まれ、Origin が各ルールの id を割り当てます。エントリ数が20を超える場合は InvalidArgument (HTTP 400) で拒否されます。

bypassActors 配列

ストアに保存するバイパス対象のプリンシパル。各エントリには bypassMode と user、team、app、または originRole のいずれか1つだけが含まれます。Origin は各アクターの id を割り当てます。エントリが15件を超えると InvalidArgument (HTTP 400) で拒否されます。

レスポンスフィールド

id string

Stable Origin ルールセット ID。

name string

ルールセット名。

description 文字列

ルールセットの説明。

enforcement 文字列

Origin によるルールセットの適用方法。指定可能な値: active、evaluate、disabled。

kind string

ルールセットが保護する操作。指定可能な値: merge_branch、push_branch、push_tag、push_repository。

includedRefNames 配列

このルールセットが対象とする ref 名のパターン。glob と ~ALL、~DEFAULT_BRANCH トークンをサポートします。

excludedRefNames 配列

このルールセットが除外する参照名のパターン。includedRefNamesと同じパターン言語です。

rules 配列

このルールセットの保護ルール。

rules[].id string

このルールの安定オリジンID。

rules[].ruleType string

ルールタイプ。例: pull_request、require_status_checks、require_branch_up_to_date、deletion、non_fast_forward。

rules[].parameters オブジェクト

タイプ固有のパラメータをJSONオブジェクトとして指定します。形式はrules[].ruleTypeに依存します。

bypassActors 配列

このルールセットをバイパスできるプリンシパル。保存された識別情報を読み取れないバイパス対象はレスポンスから省かれます。

bypassActors[].id string

このバイパスアクターの安定したオリジンID。

bypassActors[].bypassMode string

バイパスが適用される場合。指定可能な値: always、pull_request_only。

bypassActors[].user オブジェクト

ユーザープリンシパル。user、team、app、またはoriginRoleのうち正確に1つが存在します。

bypassActors[].user.id string

10進数文字列としてエンコードされた Cherri Code の数値ユーザー ID。

bypassActors[].team オブジェクト

チーム代表。

bypassActors[].team.organizationPublicId string

不変の組織公開ID。

bypassActors[].team.groupPublicId string

不変のグループ公開ID。

bypassActors[].app オブジェクト

アプリのプリンシパル。

bypassActors[].app.id string

アプリ ID。app_ のプレフィックスが付きます。

bypassActors[].originRole オブジェクト

Originロールを持つプリンシパル。

bypassActors[].originRole.role string

指定可能な値: namespace_admin、repository_admin、repository_write。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/rulesets' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "name": "require-review",  "description": "Require an approving review before merging to main.",  "enforcement": "active",  "kind": "merge_branch",  "includedRefNames": [    "refs/heads/main"  ],  "rules": [    {      "ruleType": "pull_request",      "parameters": {        "requiredApprovingReviewCount": 1      }    }  ],  "bypassActors": [    {      "bypassMode": "always",      "user": {        "id": "act_01k2ja2000e0080000000000x0"      }    }  ]}'

レスポンスの構造:

{  "id": "rs_01k2ja2000e0080000000000t7",  "name": "require-review",  "description": "Require an approving review before merging to main.",  "enforcement": "active",  "kind": "merge_branch",  "includedRefNames": [    "refs/heads/main"  ],  "rules": [    {      "id": "rsr_01k2ja2000e0080000000000v8",      "ruleType": "pull_request",      "parameters": {        "requiredApprovingReviewCount": 1      }    }  ],  "bypassActors": [    {      "id": "rsba_01k2ja2000e0080000000000w9",      "bypassMode": "always",      "user": {        "id": "act_01k2ja2000e0080000000000x0"      }    }  ]}

ルールセットを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/rulesets/{rulesetId}

Scoperepository:rulesets:readAuthInstallation tokenUser access token

安定したOrigin IDによって単一のリポジトリルールセットを返します。

不明なリポジトリと不明なルールセットはどちらも 404 を返しますが、メッセージで区別できます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

rulesetId string 必須

Stable Origin のルールセット ID。

レスポンスフィールド

id string

Stable Origin のルールセット ID。

name string

ルールセット名。

description string

ルールセットの説明。

enforcement string

Origin によるルールセットの適用方法。指定可能な値: active、evaluate、disabled。

kind string

ルールセットが保護する操作。指定可能な値:merge_branch、push_branch、push_tag、push_repository。

includedRefNames 配列

このルールセットに含める参照名のパターン。グロブとトークン ~ALL、~DEFAULT_BRANCH をサポートします。

excludedRefNames 配列

このルールセットが除外する ref 名のパターン。includedRefNames と同じパターン言語です。

rules 配列

このルールセット内の保護ルール。

rules[].id string

このルールの Stable Origin ID。

rules[].ruleType 文字列

ルールの種類。例: pull_request、require_status_checks、require_branch_up_to_date、deletion、non_fast_forward。

rules[].parameters オブジェクト

型固有のパラメータをJSONオブジェクトとして指定します。形式はrules[].ruleTypeによって異なります。

bypassActors 配列

このルールセットをバイパスできる主体。保存された識別情報を読み取れないバイパス実行者は応答から省略されます。

bypassActors[].id string

このバイパスアクターの安定したオリジンID。

bypassActors[].bypassMode string

バイパスが適用される場合。指定可能な値: always、pull_request_only。

bypassActors[].user オブジェクト

ユーザープリンシパル。user、team、app、または originRole のうち正確に1つが存在します。

bypassActors[].user.id 文字列

10進数の文字列としてエンコードされた数値のカーソルユーザーID。

bypassActors[].team オブジェクト

チーム代表。

bypassActors[].team.organizationPublicId 文字列

変更不可の組織公開IDです。

bypassActors[].team.groupPublicId string

不変のグループ公開 ID。

bypassActors[].app オブジェクト

アプリケーションのプリンシパル。

bypassActors[].app.id string

app_ プレフィックス付きの App ID。

bypassActors[].originRole オブジェクト

Origin ロールを持つプリンシパル。

bypassActors[].originRole.role string

指定可能な値: namespace_admin、repository_admin、repository_write。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/rulesets/RULESET_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "rs_01k2ja2000e0080000000000t7",  "name": "require-review",  "description": "Require an approving review before merging to main.",  "enforcement": "active",  "kind": "merge_branch",  "includedRefNames": [    "refs/heads/main"  ],  "rules": [    {      "id": "rsr_01k2ja2000e0080000000000v8",      "ruleType": "pull_request",      "parameters": {        "requiredApprovingReviewCount": 1      }    }  ],  "bypassActors": [    {      "id": "rsba_01k2ja2000e0080000000000w9",      "bypassMode": "always",      "user": {        "id": "act_01k2ja2000e0080000000000x0"      }    }  ]}

ルールセットの更新

PUT/v1/origin/repos/{ownerSlug}/{repoName}/rulesets/{rulesetId}

Scoperepository:rulesets:writeAuthInstallation tokenUser access token

既存のリポジトリルールセットを更新します。

このリクエストはルールセット設定全体を置き換えます。rules と bypassActors はマージではなく完全に置き換えられ、Origin は保存されたエントリに新しい ID を割り当てます。そのため、保持したいルールとバイパスアクターはすべて送信してください。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名です。

rulesetId string 必須

Stable Origin のルールセットID。

リクエスト本文

name string 必須

ルールセット名。

description 文字列

ルールセットの説明。

enforcement string 必須

Origin によるルールセットの適用方法。指定可能な値: active、evaluate、disabled。

kind string 必須

ルールセットが保護する操作。許容される値: merge_branch, push_branch, push_tag, push_repository。

includedRefNames 配列

このルールセットに含まれるリファレンス名のパターン。glob とトークン ~ALL、~DEFAULT_BRANCH をサポートします。64 件を超えるエントリは InvalidArgument (HTTP 400) で拒否されます。

excludedRefNames 配列

このルールセットが除外するリファレンス名のパターン。includedRefNames と同じパターン言語を使用し、上限は64件です。

rules array

保存する保護ルール。各エントリは ruleType と省略可能な parameters を持ちます。各ルールの id は Origin が割り当てます。エントリが20件を超えると InvalidArgument (HTTP 400) で拒否されます。

bypassActors 配列

ストアへのバイパスプリンシパル。各エントリは bypassMode と user、team、app、または originRole のいずれか1つを持ちます。Origin は各アクターの id を割り当てます。エントリが15件を超えると InvalidArgument (HTTP 400) で拒否されます。

レスポンスフィールド

id string

Stable Origin のルールセット ID。

name string

ルールセット名。

description 文字列

ルールセットの説明。

enforcement 文字列

Origin によるルールセットの適用方法。指定可能な値: active、evaluate、disabled。

kind string

ルールセットが保護する操作。許容される値: merge_branch, push_branch, push_tag, push_repository。

includedRefNames 配列

このルールセットに含まれる ref 名のパターン。glob とトークン ~ALL、~DEFAULT_BRANCH をサポートします。

excludedRefNames 配列

このルールセットで除外する ref 名のパターン。includedRefNames と同じパターン言語です。

rules array

このルールセットの保護ルール。

rules[].id string

このルールの安定したオリジン ID。

rules[].ruleType string

ルールの種類。例: pull_request、require_status_checks、require_branch_up_to_date、deletion、non_fast_forward。

rules[].parameters オブジェクト

タイプ別のパラメータを JSON オブジェクトとして指定します。構造は rules[].ruleType によって異なります。

bypassActors 配列

このルールセットを回避できる主体。保存された識別情報を読み取れないバイパス対象はレスポンスから除外されます。

bypassActors[].id string

このバイパスアクターの安定したオリジンID。

bypassActors[].bypassMode string

バイパスが適用されるタイミング。指定可能な値: always、pull_request_only。

bypassActors[].user オブジェクト

ユーザープリンシパル。user、team、app、originRole のうち、存在するのは 1 つだけです。

bypassActors[].user.id string

10進数の文字列としてエンコードされた数値のCherri CodeユーザーID。

bypassActors[].team オブジェクト

チーム代表。

bypassActors[].team.organizationPublicId string

変更不可能な組織の公開ID。

bypassActors[].team.groupPublicId string

変更不可能なグループの公開ID。

bypassActors[].app オブジェクト

アプリケーションプリンシパル。

bypassActors[].app.id string

アプリ ID。app_ のプレフィックスが付きます。

bypassActors[].originRole オブジェクト

Origin ロールを持つプリンシパル。

bypassActors[].originRole.role 文字列

指定可能な値: namespace_admin、repository_admin、repository_write。

curl --request PUT \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/rulesets/RULESET_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "name": "require-review",  "description": "Require an approving review before merging to main.",  "enforcement": "active",  "kind": "merge_branch",  "includedRefNames": [    "refs/heads/main"  ],  "rules": [    {      "ruleType": "pull_request",      "parameters": {        "requiredApprovingReviewCount": 1      }    }  ],  "bypassActors": [    {      "bypassMode": "always",      "user": {        "id": "act_01k2ja2000e0080000000000x0"      }    }  ]}'

レスポンスの構造:

{  "id": "rs_01k2ja2000e0080000000000t7",  "name": "require-review",  "description": "Require an approving review before merging to main.",  "enforcement": "active",  "kind": "merge_branch",  "includedRefNames": [    "refs/heads/main"  ],  "rules": [    {      "id": "rsr_01k2ja2000e0080000000000v8",      "ruleType": "pull_request",      "parameters": {        "requiredApprovingReviewCount": 1      }    }  ],  "bypassActors": [    {      "id": "rsba_01k2ja2000e0080000000000w9",      "bypassMode": "always",      "user": {        "id": "act_01k2ja2000e0080000000000x0"      }    }  ]}

ルールセットを削除

DELETE/v1/origin/repos/{ownerSlug}/{repoName}/rulesets/{rulesetId}

Scoperepository:rulesets:writeAuthInstallation tokenUser access token

安定したオリジン ID を指定してリポジトリルールセットを削除します。レスポンス本文は空です。

存在しないリポジトリと存在しないルールセットはいずれも 404 を返しますが、メッセージで区別されます。別のリポジトリに保存されているルールセットは、存在しないルールセットとして扱われます。空の rulesetId を指定すると InvalidArgument (HTTP 400) が返されます。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意の slug。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

rulesetId 文字列必須

安定したオリジンルールセット ID。

レスポンスフィールド

成功したリクエストでは、レスポンス本文は返されません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/rulesets/RULESET_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンス:

204 No Content

SSH 認証局

SSH 認証局とは、所有者が信頼する公開鍵です。この認証局が署名したユーザー証明書によって、所有者のリポジトリに対する SSH 経由の git 操作が認証されます。そのため、所有チームのメンバーは SSH キーを登録しなくても SSH 経由で git を使用できます。これらのエンドポイントでは、所有者が信頼する認証局の一覧取得、追加、削除に加え、所有者が証明書を必須とするかどうかを設定できます。認証局はチーム所有の所有者に属します。追加時の重複チェックはオリジン全体ではなく所有者単位で行われるため、複数の所有者が同じ認証局を信頼できます。

一覧取得では、インストールトークンとユーザートークンを使用できます。認証局の追加・削除と必須要件の設定には、namespace:settings:write を持つ Cherri Code ユーザーの認証情報が必要です。アプリトークンとインストールトークンは使用できません。

SSH 認証局の一覧を取得

GET/v1/origin/owners/{ownerSlug}/ssh-certificate-authorities

Scopenamespace:settings:readAuthInstallation tokenUser access token

SSH 経由の git 操作で所有者が信頼している SSH 認証局を新しい順に一覧表示し、所有者が証明書を必須としているかどうかもあわせて返します。レスポンスはページネーション非対応で、すべての認証局が一度に返されます。

パスパラメータ

ownerSlug string 必須

認証局の一覧を取得する所有者の slug。

レスポンスフィールド

certificateAuthorities array

所有者が信頼するすべての認証局 (新しい順) 。

certificateAuthorities[].id string

認証局の識別子。SSH 認証局を削除で certificateAuthorityId として指定します。

certificateAuthorities[].name string

認証局の追加時に付けたラベル。

certificateAuthorities[].keyType string

認証局の公開鍵の OpenSSH キータイプ (例: ssh-ed25519) 。

certificateAuthorities[].fingerprint string

公開鍵の SHA-256 フィンガープリント。ssh-keygen -l が出力するのと同じ SHA256:<base64> 形式です。

certificateAuthorities[].publicKey string

認証局の公開鍵。コメントを含まない <key_type> <base64> 形式です。

certificateAuthorities[].createdAt string

認証局が追加された日時 (RFC 3339 形式のタイムスタンプ) 。

requireCertificates boolean

所有者が SSH 証明書を必須としているかどうか。詳しくは SSH 証明書の要件を設定を参照してください。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/owners/OWNER_SLUG/ssh-certificate-authorities' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造：

{  "certificateAuthorities": [    {      "id": "nsca_01k2ja2000e0080000000000s5",      "name": "Acme production CA",      "keyType": "ssh-ed25519",      "fingerprint": "SHA256:D5vlIclvaSZlwq4gmckavfLE7n7F542Eyhk/PvXkRq0",      "publicKey": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIPwoQNzBuiWhDF4EKwRyt8h48XRY7Bc4yWbQ9s3Tnj7Q",      "createdAt": "2026-08-02T14:45:00Z"    }  ],  "requireCertificates": true}

SSH 認証局を追加する

POST/v1/origin/owners/{ownerSlug}/ssh-certificate-authorities

Scopenamespace:settings:writeAuthUser access token

所有者が信頼する SSH 認証局を追加し、追加した認証局を返します。追加後、所有者であるチームのメンバーは、SSH キーを登録しなくても、この認証局が署名したユーザー証明書を使って、所有者のリポジトリに SSH 経由で git アクセスできます。

publicKey には、認証局自身の公開鍵を OpenSSH の authorized_keys 形式の 1 行で指定します。証明書、サポートされていないキータイプ、または 2048 ビット未満の RSA キーを指定すると InvalidArgument (HTTP 400) が返されます。所有者がすでに登録しているキーを指定すると AlreadyExists (HTTP 409 Conflict) が返されます。この重複チェックは所有者単位で行われるため、複数の所有者が同じ認証局を信頼できます。認証局を追加できるのはチーム所有の所有者のみです。それ以外の所有者では FailedPrecondition (HTTP 400) が返されます。

呼び出し元は、namespace:settings:write を持つ Cherri Code ユーザーの認証情報である必要があります。アプリトークンおよびインストールトークンは使用できません。

パスパラメータ

ownerSlug string 必須

所有者の slug。

リクエスト本文

publicKey string 必須

OpenSSH の authorized_keys 形式の 1 行 (<key_type> <base64> [comment]) で表した認証局の公開鍵。使用できるキータイプは ssh-ed25519、ecdsa-sha2-nistp256、ecdsa-sha2-nistp384、ecdsa-sha2-nistp521、およびモジュラスが 2048 ビット以上の ssh-rsa です。証明書は使用できません。

name string 必須

認証局のラベル (最大 255 文字) 。

レスポンスフィールド

id string

認証局の識別子。SSH 認証局を削除するで certificateAuthorityId として指定します。

name string

認証局の追加時に指定したラベル。

keyType string

認証局の公開鍵の OpenSSH キータイプ (例: ssh-ed25519) 。

fingerprint string

公開鍵の SHA-256 フィンガープリント。ssh-keygen -l が出力するのと同じ SHA256:<base64> 形式です。

publicKey string

認証局の公開鍵。コメントを含まない <key_type> <base64> 形式です。

createdAt string

認証局が追加された日時 (RFC 3339 形式のタイムスタンプ) 。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/owners/OWNER_SLUG/ssh-certificate-authorities' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "publicKey": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIPwoQNzBuiWhDF4EKwRyt8h48XRY7Bc4yWbQ9s3Tnj7Q acme-ssh-ca",  "name": "Acme production CA"}'

レスポンスの構造:

{  "id": "nsca_01k2ja2000e0080000000000s5",  "name": "Acme production CA",  "keyType": "ssh-ed25519",  "fingerprint": "SHA256:D5vlIclvaSZlwq4gmckavfLE7n7F542Eyhk/PvXkRq0",  "publicKey": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIPwoQNzBuiWhDF4EKwRyt8h48XRY7Bc4yWbQ9s3Tnj7Q",  "createdAt": "2026-08-02T14:45:00Z"}

SSH 認証局を削除

DELETE/v1/origin/owners/{ownerSlug}/ssh-certificate-authorities/{certificateAuthorityId}

Scopenamespace:settings:writeAuthUser access token

所有者から SSH 認証局を削除します。この認証局が署名した証明書はすべて無効になります。所有者が証明書を必須にしている場合、最後の認証局は削除できず、リクエストは FailedPrecondition (HTTP 400) を返します。レスポンス本文は空です。

呼び出し元は、namespace:settings:write を持つ Cherri Code ユーザーの認証情報である必要があります。App トークンとインストールトークンは使用できません。

パスパラメータ

ownerSlug 文字列必須

所有者の slug。

certificateAuthorityId 文字列必須

削除する認証局の id。

レスポンスフィールド

リクエストが成功した場合、レスポンス本文は返されません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/owners/OWNER_SLUG/ssh-certificate-authorities/CERTIFICATE_AUTHORITY_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンス:

204 No Content

SSH 証明書の必須設定を指定

POST/v1/origin/owners/{ownerSlug}/ssh-certificate-authorities:setRequirement

Scopenamespace:settings:writeAuthUser access token

所有者に SSH 証明書を必須とするかどうかを設定し、所有者の設定を返します。必須に設定されている間、所有者のリポジトリへの SSH 経由の git アクセスでは、所有者の認証局が発行した証明書のみが受け付けられます。ユーザーが登録した SSH キーは拒否され、HTTPS 経由のユーザー API キーも拒否されます。証明書を必須にするには、認証局が 1 つ以上登録されている必要があります。登録されていない場合、リクエストは FailedPrecondition (HTTP 400) を返します。現在と同じ値を設定した場合は、何も変更されずに成功します。

呼び出し元は、namespace:settings:write を持つ Cherri Code ユーザーの認証情報である必要があります。アプリトークンおよびインストールトークンは受け付けられません。

パスパラメータ

ownerSlug 文字列必須

所有者の slug。

リクエスト本文

requireCertificates boolean 必須

true の場合、所有者のリポジトリで SSH 証明書を必須にします。false の場合、必須設定を解除します。

レスポンスフィールド

requireCertificates boolean

所有者が SSH 経由の git アクセスに SSH 証明書を必須としているかどうか。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/owners/OWNER_SLUG/ssh-certificate-authorities:setRequirement' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "requireCertificates": true}'

レスポンスの構造:

{  "requireCertificates": true}

Webhooks

Origin は、署名付き HTTP POST リクエストを、アプリに登録された HTTPS Webhook URL に content-type: application/json として送信します。

配信は少なくとも 1 回行われます。webhook-id を使用して再試行を重複排除し、リクエストを永続的に受け付け、速やかに 2xx を返し、イベントは非同期で処理してください。

Origin は受信側のレスポンスヘッダーを 10 秒間待機します。この制限時間には DNS 解決、接続、TLS ハンドシェイク、レスポンスまでの時間が含まれ、すべての試行に適用されます。この制限を超えた試行はトランスポートエラーとして記録され、再試行のスケジュールに従って再試行されます。失敗が繰り返されると、配信が自動的に無効化されることがあります。

実際のイベントが到達する前に受信側が動作することを確認するには、Ping Webhook を呼び出してください。

Origin はミラーリポジトリのイベントを配信し、インストールイベントのペイロードでは、それらのリポジトリが選択されたリポジトリ配列に一覧表示されます。配信によってインストールが呼び出せる範囲が広がることはありません。ミラーリポジトリを参照してください。

ヘッダー

ヘッダー	説明
`content-type`	`application/json`
`user-agent`	`Cherri Code-Origin-Webhook/1.0`
`webhook-id`	配信ごとに一定のIDおよび冪等性キー。
`webhook-timestamp`	署名に含まれるUnixタイムスタンプ。
`webhook-signature`	`v1ed,BASE64_SIGNATURE`
`webhook-event-type`	ルーティング用のイベントスラッグ。
`webhook-event-id`	署名付き本文に含まれる元のOriginイベントID。
`webhook-app-id`	ターゲットアプリID。
`webhook-installation-id`	ターゲットインストールID。

ルーティングヘッダーは補助的な情報です。署名検証後は、本文を正とします。

署名の検証

解析前の生のリクエスト本文を使用します。次のように構築します。

lowercaseHex(SHA-256("<webhook-id>.<webhook-timestamp>.<raw-request-body>"))

その16進数ダイジェストのUTF-8バイトに対するEd25519署名を、有効なオリジン JWKSキーで確認します。現在時刻から5分を超えてずれたタイムスタンプは拒否します。

Standard Webhooks のライブラリではオリジンの配信を確認できません。ヘッダー名は Standard Webhooks に準拠していますが、オリジンは署名対象のコンテンツそのものではなく SHA-256 ダイジェストに署名し、Standard Webhooks の仕様では定義されていない v1ed バージョンタグを使用します。次の例のように、上記の手順で確認してください。

import {  createHash,  createPublicKey,  verify,  type JsonWebKeyInput,} from "node:crypto";export async function verifyOriginWebhook(  body: Buffer,  headers: Record<string, string | undefined>): Promise<boolean> {  const id = headers["webhook-id"];  const timestamp = Number(headers["webhook-timestamp"]);  const signature = headers["webhook-signature"]    ?.split(/\s+/)    .find((value) => value.startsWith("v1ed,"));  const now = Math.floor(Date.now() / 1000);  if (    !id ||    !signature ||    !Number.isInteger(timestamp) ||    Math.abs(now - timestamp) > 300  ) {    return false;  }  const digest = createHash("sha256")    .update(`${id}.${timestamp}.`)    .update(body)    .digest("hex");  // 本番環境ではこのレスポンスをキャッシュしてください。  const { keys } = await fetch(    "https://api.cursor.com/v1/origin/keys"  ).then((response) => response.json()) as {    keys: JsonWebKeyInput[];  };  return keys.some((jwk) => {    try {      return verify(        null,        Buffer.from(digest),        createPublicKey({ key: jwk, format: "jwk" }),        Buffer.from(signature.slice(5), "base64")      );    } catch {      return false;    }  });}

配信エンベロープ

各リクエストでは、イベントペイロードが配信、アプリ、インストール ID の情報とともにラップされます。

{  "deliveryId": "whd_01...",  "appId": "app_01...",  "installationId": "i_01...",  "event": {    "id": "evt_01...",    "type": "pull_request.comment.created",    "eventTime": "2026-07-01T10:03:00Z",    "payload": {}  }}

deliveryId は再試行しても変わりません。event.id は基となるドメインイベントを識別します。

Retries

オリジンは、トランスポートエラー、429、5xx レスポンスに対して、合計最大 7 回まで再試行します。その他の 4xx レスポンスは再試行されません。

最初の試行は元の送信です。6 回の再試行は、順に 5 秒、30 秒、1 分、2 分、4 分、8 分待機します。

すべての試行に失敗した受信側では、約 16 分間に 7 回の POST を受け取ることになります。webhook-id はすべての試行で同じ値のままです。これを使って重複排除してください。

自動無効化

所有者は、アプリの設定からアプリの Webhook 配信を一時停止できます。また、受信側が 72 時間のウィンドウ内で少なくとも 20 回の配信ラウンドに失敗し、そのウィンドウ内で成功した配信が 1 件もなく、かつ失敗が複数のインストーラー名前空間にまたがる場合、オリジンは自動的に無効化します。

配信は所有者が再開するまで停止します。Batch Redeliver Webhook Deliveries は FailedPrecondition (HTTP 400) を返し、何もキューに追加しません。API には一時停止状態を示すフィールドがないため、この FailedPrecondition をその判断材料として扱ってください。

Update App でアプリの webhookUrl を消去する操作は、これとは別のアクションです。保留中の配信は取り消され、再度 URL を設定しても復元されません。

復旧

アプリ JWT を使用して GET /app/webhook/deliveries をクエリします。配信ステータス、イベントタイプ、インストール、時間範囲、ページトークンでフィルタリングできます。delivered=false を指定すると、受信側が 2xx で一度も確認応答していないすべての配信を取得できます。配信は 7 日間一覧表示できるため、その期間内に復旧してください。

POST /app/webhook/deliveries:batchRedeliver を使用すると、最大 100 件の配信 ID の再配信をキューに登録できます。この操作では ID の重複を排除し、各配信の結果を返します。一時停止中または自動的に無効化されたアプリでは、この呼び出しは FailedPrecondition (HTTP 400) で拒否され、何もキューに登録されません。

Webhooks リファレンス

オリジンが配信するすべてのイベントと、各イベントのペイロードをフィールドごとに解説します。サブスクリプションの仕組み、ヘッダー、署名の検証、エンベロープ、再試行のスケジュール、自動無効化については、Webhooks を参照してください。

イベント

イベント	配信されるタイミング
`repository.created`	リポジトリが作成されたとき。
`repository.deleted`	リポジトリが削除されたとき。
`repository.pushed`	プッシュにより1つ以上のリファレンスが変更されたとき。
`repository.metadata.updated`	リポジトリのデフォルトブランチが変更されたとき。
`pull_request.created`	プルリクエストが作成されたとき。
`pull_request.head_ref.pushed`	プルリクエストのヘッドが進んだとき。
`pull_request.base_ref.updated`	ベースリファレンスまたは解決済みのベースコミットが変更されたとき。
`pull_request.metadata.updated`	タイトルまたは説明が変更されたとき。
`pull_request.closed`	プルリクエストがマージされずにクローズされたとき。プッシュによりヘッドとベースに共通の履歴がなくなり、オリジンがクローズした場合を含みます。
`pull_request.merged`	プルリクエストがマージされたとき。
`pull_request.reopened`	クローズされたプルリクエストが再オープンされたとき。
`pull_request.published`	下書きのプルリクエストがオープンになったとき。
`pull_request.label.added`	プルリクエストにラベルが付与されたとき。
`pull_request.label.removed`	プルリクエストからラベルが解除されたとき。ラベル定義が削除された場合を含みます。
`pull_request.comment.created`	表示可能なプルリクエストコメントが作成されたとき。
`pull_request.comment.reaction.added`	プルリクエストコメントにリアクションが付けられたとき。リアクションを行ったユーザーがすでに付けているリアクションを再度付けると、このイベントが再度配信されます。
`pull_request.comment.reaction.removed`	プルリクエストコメントからリアクションが削除されたとき。リアクションを行ったユーザーが付けていないリアクションを削除しても、何も配信されません。
`pull_request.review.submitted`	任意の判定で確認が送信されたとき。
`pull_request.review.dismissed`	送信済み確認が明示的に、または後続のレビューにより無効化されたとき。
`pull_request.reviewer.added`	レビュアーがリクエストされたとき。
`pull_request.reviewer.removed`	レビュアーが削除されたとき。
`pull_request.reviewer.rerequested`	レビュアーが再度リクエストされたとき。
`repository.check_run.created`	チェック実行が作成されたとき。
`repository.check_run.completed`	チェック実行が完了したとき。
`repository.check_run.rerequested`	完了したチェック実行が再リクエストされたとき。その実行を所有するアプリにのみ配信されます。
`installation.created`	アプリがインストールされたとき。
`installation.updated`	スコープ、リポジトリの選択、またはオーナーの namespace スラッグが変更されたとき。
`installation.suspended`	インストールが一時停止されたとき。
`installation.unsuspended`	一時停止されたインストールが復元されたとき。
`installation.deleted`	アプリがアンインストールされたとき。

各イベントのペイロードの構造は、イベントペイロードでフィールドごとに記載されています。

5つのinstallation.*イベントは、リポジトリのサブスクリプションではなく、アプリ自体に送信されます。オリジンは常にこれらを送信するため、アプリの選択可能なイベントリストには表示されません。この表のその他すべてのイベントは、リポジトリスコープのサブスクリプションです。

新しく作成したアプリは、リポジトリスコープのイベントを1つも購読していません。必要なイベントをアプリの設定で選択するか、Create AppまたはUpdate Appのeventsフィールドで設定してください。オリジンがイベントを配信するのは、そのイベントを購読し、Webhook URLが設定されていて、インストールの対象に該当リポジトリが含まれ、かつイベントに必要なスコープを持つアプリに限られます。条件を満たさない場合、配信もエラーも発生しません。何も送信されず、List Webhook Deliveriesにも何も表示されません。

オリジンはGitHubからミラーリングしているリポジトリに対してrepository.pushedを配信しません。これらのプッシュはGitHubが管理し、GitHub自身がプッシュのWebhookを送信するため、オリジンからも配信すると重複してしまいます。ネイティブのオリジンリポジトリおよびアウトバウンドミラーへのプッシュは通常どおり配信され、ミラーの状態が他のイベントに影響することはありません。repository.deletedはGitHubからミラーリングされたリポジトリに対しても配信されます。同期を停止するとCherri Code側のリポジトリのみが削除され、GitHubからは何も送信されません。

イベントペイロード

各イベントのエンベロープは、payload にそのイベントのペイロードオブジェクトを格納します。同じ形状を持つイベントは同一のペイロードファミリーに属します。以下の各ファミリーでは、それを配信するイベント、フィールド、および OpenAPI 仕様から生成したサンプルペイロードを記載しています。仕様では、各ペイロードスキーマの x-origin-webhook-events 拡張に、そのペイロードを配信するイベントが列挙されています。

リポジトリ作成完了

EVENTrepository.created

ペイロードのフィールド

repository object

作成されたリポジトリ。

repository.id string

repository.name string 必須

repo 名。owner 内で一意である必要があります。create 時は必須です。

repository.fullName string

"{owner.login}/{name}"。自動生成されます。

repository.owner object

所有エンティティ。作成時に parent から決定され、直接設定することはできません。

repository.owner.slug string

オーナーの一意な、URL に使用できる名前。

repository.owner.id string

オーナー namespace の一意な ID。

repository.owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

repository.defaultBranch string

デフォルトブランチ名。レスポンスでは常に設定されます。作成時にこのフィールドを省略するか空にした場合は、デフォルトで "main" になります。

repository.createdAt string

RFC 3339 形式のタイムスタンプ。

repository.updatedAt string

RFC 3339 形式のタイムスタンプ。

repository.pushedAt string

いずれかのブランチへの最新プッシュのタイムスタンプ。最初のプッシュが行われるまでは含まれません。RFC 3339 形式のタイムスタンプ。

repository.cloneUrl string

リポジトリをクローンするための HTTPS URL。

repository.mirror object

ミラーのメタデータ。ネイティブリポジトリの場合、およびミラーの初回同期が完了するまでは含まれません。

repository.mirror.source string

github のいずれか。

repository.mirror.sourceId string

ソースが付与する不透明なリポジトリ識別子。

repository.mirror.status string

移行中、カットオーバー完了までの実効的な方向。inbound、outbound のいずれか。

repository.visibility string

リポジトリの可視性。internal または private。internal、private のいずれか。

repository.allowMergeCommit boolean

プルリクエストをマージコミットとして取り込めるかどうか。

repository.allowSquashMerge boolean

プルリクエストを squash merge でマージできるかどうか。

repository.deleteBranchOnMerge boolean

マージ時にヘッドブランチを自動的に削除するかどうか。

event.payload の例:

{  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "fullName": "acme/rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    },    "defaultBranch": "main",    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-01T09:30:00Z",    "cloneUrl": "https://origin.cursor.com/git/acme/rocket.git"  }}

リポジトリ削除

EVENTrepository.deleted

ペイロードのフィールド

repository object

削除されたリポジトリ。参照用のみです。削除後は、API 経由でこのリポジトリを解決できなくなります。

repository.id string

repository.name string

repository.owner object

リポジトリの所有者。

repository.owner.slug string

所有者の一意で URL に適した名前。

repository.owner.id string

所有者の namespace の一意な ID。

repository.owner.type string

team または user。output-only で、不明な場合は未設定です。team、user のいずれか。

deletedAt string

リポジトリが削除された日時。RFC 3339 形式の timestamp。

event.payload のサンプル:

{  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  },  "deletedAt": "2026-08-03T08:15:00Z"}

リポジトリへのプッシュ

EVENTrepository.pushed

1 回のアトミックなプッシュで、複数のリファレンスが更新される場合があります。commits 配列はありません。各リファレンスの更新には、ベストエフォートの tip メタデータのみが含まれます。

ペイロードのフィールド

repository object

プッシュ先のリポジトリ。

repository.id string

repository.name string

repository.owner object

repo の owner。

repository.owner.slug string

オーナーの一意な、URL に使用できる名前。

repository.owner.id string

所有者の名前空間の一意な ID。

repository.owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

refUpdates 配列

このプッシュに含まれるリファレンス (最大100件) 。

refUpdates[].ref string

プッシュされた完全な git ref。例: refs/heads/main、refs/tags/v3.14.1。

refUpdates[].before string

プッシュ前の ref 上の最新コミットの SHA。ref が作成された直後の場合はすべてゼロ (0000000000000000000000000000000000000000) になります。

refUpdates[].after string

プッシュ後の ref における最新コミットの SHA。ref が削除された場合はすべてゼロ (0000000000000000000000000000000000000000) になります。

refUpdates[].created boolean

このプッシュで ref が作成されたかどうか。

refUpdates[].deleted boolean

このプッシュで ref が削除されたかどうか。

refUpdates[].forced boolean

このプッシュによって履歴が書き換えられたかどうかを示します。既存の ref に対する non-fast-forward 更新 (新しい tip が古い tip の子孫ではない更新) を指します。ref の作成、削除、fast-forward 更新、および Origin が force-push の状態を追跡する前に観測されたプッシュの場合は false です。

refUpdates[].headCommit object

peel 後の新しい tip が指すコミットのベストエフォートなメタデータ。削除、コミット以外のリファレンス、過去のプッシュ、抽出失敗の場合は未設定です。

refUpdates[].headCommit.sha string

refUpdates[].headCommit.author オブジェクト

コミットの作成者またはコミッターのGit IDとタイムスタンプです。これはコミットオブジェクトに記録されたIDであり、紐付けられたユーザーアカウントではありません。

refUpdates[].headCommit.author.name string

refUpdates[].headCommit.author.email string

refUpdates[].headCommit.author.date string

git署名の元のタイムゾーンオフセットを保持するISO-8601形式のタイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

refUpdates[].headCommit.committer object

commit の author または committer の Git ID とタイムスタンプ。これは commit オブジェクトに記録された ID であり、連携されたユーザーアカウントではありません。

refUpdates[].headCommit.committer.name string

refUpdates[].headCommit.committer.email string

refUpdates[].headCommit.committer.date string

git signature の元のタイムゾーンオフセットを保持する ISO-8601 形式のタイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

refUpdates[].headCommit.message string

pushedAt string

Origin がプッシュを検知した時刻。RFC 3339 形式のタイムスタンプ。

pusher オブジェクト

Origin によって検証された、プッシュを実行した principal。Origin 自身がプッシュを実行した場合 (プルリクエストのマージ時にベースリファレンスを進めるマージプッシュなど) は含まれません。

pusher.user オブジェクト

pusher.user.id string

pusher.user.email string 必須

pusher.user.displayName string

人間が読める形式の表示名です。アカウントの名と姓をそれぞれトリミングしてスペースで連結したもので、製品の UI に表示される名前と完全に一致します。アカウントに名前がない場合は省略され、メールアドレスや ID、その他のフィールドから生成されることはありません。アクターを特定できなかった Webhook ペイロードでは、表示名が含まれない場合もあります。

pusher.user.handle string

ユーザーが取得済みのプロフィールハンドル (cursor.com /@handle のIDにあたるもの) 。@ プレフィックスは含まれません。ユーザーのプロフィールが公開されている間のみ含まれ、ハンドルを取得していないユーザーや非公開プロフィールの場合は省略されます。

pusher.user.performedVia オブジェクト

この actor フィールドが表すアクションを、アプリがインストールユーザートークンを使用してこのユーザーの代理で実行した場合に設定されます。たとえばコメントの author では、コメントを作成したアプリを示し、後からコメントを編集または削除したアクターは示しません。ユーザーが直接操作した場合は含まれず、委任データを取得できない場合も含まれないことがあります。

pusher.user.performedVia.app object

ユーザーに代わって操作を行ったアプリ。

pusher.user.performedVia.app.id string

pusher.user.performedVia.app.displayName string

アプリの登録済み表示名。存在する場合、空になることはありません。アプリを解決できなかったペイロードや、Cherri Codeのファーストパーティ・ファサードアクターでは省略されます。

pusher.app object

pusher.app.id string

pusher.app.displayName string

アプリの登録済み表示名。存在する場合、空になることはありません。アプリを解決できなかったペイロードや、ファーストパーティの Cherri Code ファサードアクターでは省略されます。

pusher.serviceAccount オブジェクト

pusher.serviceAccount.id string

refUpdatesCount integer

アトミックなプッシュに含まれる ref の更新数。プロデューサーがリストを制限した場合、ref_updates はこれより短くなることがあります。

event.payload の例:

{  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  },  "refUpdates": [    {      "ref": "refs/heads/add-telemetry",      "before": "5c8d7e6f5a4b3c2d1e0f9a8b7c6d5e4f3a2b1c0d",      "after": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "created": false,      "deleted": false,      "forced": false,      "headCommit": {        "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",        "author": {          "name": "Jane Doe",          "email": "[email protected]",          "date": "2026-08-01T09:30:00Z"        },        "committer": {          "name": "Jane Doe",          "email": "[email protected]",          "date": "2026-08-01T09:30:00Z"        },        "message": "Add launch telemetry"      }    }  ],  "pushedAt": "2026-08-02T14:45:00Z",  "pusher": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "refUpdatesCount": 1}

リポジトリのメタデータが更新されました

EVENTrepository.metadata.updated

リポジトリの完全なスナップショットを含みますが、デルタと更新を行ったアクターは含まれません。変更内容を確認するには、連続するスナップショットを比較するか、リポジトリを再取得してください。

ペイロードのフィールド

repository object

更新後のリポジトリ全体のスナップショット。

repository.id string

repository.name string 必須

リポジトリ名。owner 内で一意である必要があります。create 時は必須です。

repository.fullName string

"{owner.login}/{name}"。自動生成されます。

repository.owner object

所有エンティティ。作成時に parent から決定されるため、直接設定することはできません。

repository.owner.slug string

owner の一意な URL セーフな名前。

repository.owner.id string

オーナー namespace の一意な ID。

repository.owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

repository.defaultBranch string

デフォルトブランチ名。レスポンスでは常に設定されます。作成時にこのフィールドを省略または空にした場合は、デフォルトで "main" になります。

repository.createdAt string

RFC 3339 形式の timestamp。

repository.updatedAt string

RFC 3339 形式の timestamp。

repository.pushedAt string

いずれかのブランチへの最新プッシュのタイムスタンプ。最初のプッシュが行われるまでは含まれません。RFC 3339 形式のタイムスタンプ。

repository.cloneUrl string

リポジトリをクローンするための HTTPS URL。

repository.mirror object

ミラーのメタデータ。ネイティブリポジトリの場合、およびミラーの初回同期が完了する前は存在しません。

repository.mirror.source string

github のいずれか。

repository.mirror.sourceId string

ソースによって付与される、不透明なリポジトリ識別子。

repository.mirror.status string

移行中、カットオーバーが完了するまでの実効的な方向。inbound、outbound のいずれか。

repository.visibility string

リポジトリの可視性。internal または private。internal、private のいずれか。

repository.allowMergeCommit boolean

プルリクエストをマージコミットとして取り込めるかどうか。

repository.allowSquashMerge boolean

プルリクエストを squash merge でマージできるかどうか。

repository.deleteBranchOnMerge boolean

マージ時にヘッドブランチを自動的に削除するかどうか。

event.payload のサンプル:

{  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "fullName": "acme/rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    },    "defaultBranch": "release",    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-03T08:15:00Z",    "cloneUrl": "https://origin.cursor.com/git/acme/rocket.git",    "pushedAt": "2026-08-02T14:45:00Z"  }}

プルリクエストイベント

EVENTpull_request.createdpull_request.publishedpull_request.reopenedpull_request.closedpull_request.mergedpull_request.metadata.updatedpull_request.head_ref.pushedpull_request.base_ref.updatedpull_request.stack_parent.updated

プルリクエストのライフサイクルの変更です。ライフサイクルのアクションはエンベロープの event.type で、別個の action フィールドはありません。

ペイロードのフィールド

pullRequest オブジェクト

プルリクエストのスナップショット。付与されたラベルは含まれないため、GetPullRequest で取得してください。

pullRequest.id string

Stable Origin のプルリクエスト識別子。

pullRequest.number string

リポジトリ内でのプルリクエスト番号。

pullRequest.state string

"open"または"closed"。ドラフトは"open"で、マージ済みおよびクローズ済みのプルリクエストはいずれも"closed"です。

pullRequest.draft boolean

プルリクエストがまだドラフトかどうか。

pullRequest.merged boolean

プルリクエストがマージされているかどうか。

pullRequest.title string

プルリクエストのタイトル。

pullRequest.body string

プルリクエストの説明。

pullRequest.head object

プルリクエストのソース側 — マージされる内容です。

pullRequest.head.ref string

この側が参照している ref (Origin の記録上) 。

pullRequest.head.sha string

変更の最新バージョンにおけるこの側の先端コミットの SHA。base の場合はバージョンの base_sha であり、ブランチの現在の先端より遅れていることがあります (PullRequestVersion を参照) 。

pullRequest.base object

プルリクエストのターゲット側 — マージ先のブランチです。

pullRequest.base.ref string

Originの記録上、この側が参照しているref。

pullRequest.base.sha string

pullRequest.author object

プルリクエストを作成したプリンシパル。

pullRequest.author.user オブジェクト

pullRequest.author.user.id string

pullRequest.author.user.email string 必須

pullRequest.author.user.displayName string

人間が読める表示名: アカウントの名と姓をそれぞれ前後の空白を取り除き、スペースでつないだもの — 製品の UI に表示される名前と完全に同じです。アカウントに名前がない場合は省略され、メールアドレスや ID、その他のフィールドから生成されることはありません。アクターを特定できなかった webhook ペイロードでは、この項目がない場合もあります。

pullRequest.author.user.handle string

ユーザーが取得済みのプロフィールハンドル (cursor.com /@handle の背後にある識別子) 。@ プレフィックスは含みません。ユーザーのプロフィールが公開されている場合にのみ表示され、ハンドルを取得していないユーザーや非公開プロフィールの場合は省略されます。

pullRequest.author.user.performedVia オブジェクト

このアクターフィールドが表すアクションを、アプリがインストールユーザートークンを使用してこのユーザーの代理で実行した場合に設定されます。たとえばコメントの作成者の場合、後からコメントを編集または削除したアクターではなく、コメントを作成したアプリを示します。ユーザーが直接操作した場合は含まれず、委任データを取得できない場合も含まれないことがあります。

pullRequest.author.user.performedVia.app オブジェクト

ユーザーの代理で操作を行ったアプリ。

pullRequest.author.user.performedVia.app.id 文字列

pullRequest.author.user.performedVia.app.displayName string

アプリの登録済み表示名。存在する場合は空ではありません。アプリを解決できなかったペイロード、およびファーストパーティの Cherri Code ファサードアクターでは省略されます。

pullRequest.author.app オブジェクト

pullRequest.author.app.id string

pullRequest.author.app.displayName string

pullRequest.author.serviceAccount object

pullRequest.author.serviceAccount.id string

pullRequest.createdAt string

プルリクエストが作成された時点。RFC 3339形式のタイムスタンプ。

pullRequest.updatedAt string

プルリクエストが最後に更新された日時。RFC 3339 形式のタイムスタンプ。

pullRequest.closedAt string

プルリクエストがクローズまたはマージされた日時。オープン中は未設定。RFC 3339 形式のタイムスタンプ。

pullRequest.mergedAt string

プルリクエストがマージされた日時。マージされていない場合は未設定。RFC 3339 形式のタイムスタンプ。

pullRequest.mergeCommitSha string

マージによってベースブランチに書き込まれたコミットの SHA。マージ後に設定され、それ以前は未設定です。マージ前のプレビューは pull/\<number>/merge ref (GetGitRef を参照) で、別のコミットです。

pullRequest.additions integer

プルリクエストの最新バージョンで追加された行。

pullRequest.deletions integer

プルリクエストの最新バージョンで削除された行。

pullRequest.changedFiles integer

プルリクエストの最新バージョンで変更されたファイル。

pullRequest.stack オブジェクト

スタックのメンバーシップ。プルリクエストがスタックの一部でない場合は未設定。

pullRequest.stack.id 文字列

スタックの安定した識別子。stack_id として ListPullRequests に渡すと、そのスタックのメンバーを一覧表示できます。

pullRequest.stack.parentPullRequest オブジェクト

このプルリクエストのベースとなるプルリクエストです。スタックのルートでは未設定にします。マージ済みの親プルリクエストは、子のベースまたは親が変更されるまで参照されたままになります。

pullRequest.stack.parentPullRequest.id 文字列

不変のオリジン変更 ID。

pullRequest.stack.parentPullRequest.number 文字列

pullRequest.stack.parentPullRequest.repository オブジェクト

このプルリクエストのリポジトリへの参照。

pullRequest.stack.parentPullRequest.repository.id 文字列

pullRequest.stack.parentPullRequest.repository.name string

pullRequest.stack.parentPullRequest.repository.owner オブジェクト

リポジトリの所有者。

pullRequest.stack.parentPullRequest.repository.owner.slug string

所有者の URL フレンドリーな一意の名前。

pullRequest.stack.parentPullRequest.repository.owner.id string

オーナーの namespace の一意な ID。

pullRequest.stack.parentPullRequest.repository.owner.type 文字列

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

pullRequest.version object

プルリクエストの最新バージョン。

pullRequest.version.number string

変更内の単調増加するバージョン番号 (1始まり) 。

pullRequest.version.headSha string

このバージョンのヘッドコミットのSHA。

pullRequest.version.baseSha string

このバージョンの差分の基準となるベースコミットの SHA。バージョンが記録された時点で解決されたベースブランチの先端を指します。次に head がプッシュされるか、ターゲットが変更されるまで、ブランチの現在の先端より古い状態になることがあります。

pullRequest.version.createdAt string

このバージョンが作成された日時。RFC 3339 形式のタイムスタンプ。

pullRequest.version.potentialMergeCommit オブジェクト

Origin によるこのバージョンのテストマージと、その準備の進行状況 (state)。このバージョン用に計算されます。コミットの第2の親は head_sha、第1の親はテストマージの base_sha です。これは準備時点のベースブランチの先端で、このバージョンの base_sha より新しい場合があります。pull/\<number>/merge ref が指すのは最新バージョンのコミットのみです。古いコミットは API (GetCommit) で SHA を指定して引き続き参照できますが、git 経由では SHA を指定してフェッチできません。マージ後にのみ設定される PullRequest.merge_commit_sha とは異なります。PullRequest.version と PullRequestWebhook.version に設定されます。

pullRequest.version.potentialMergeCommit.state string

このバージョンの準備がどこまで進んだかを示します。新しいバージョンは、その準備が反映されるまで unknown で始まります。認識できない値は unknown として扱う必要があります。unknown、prepared、merge_conflict のいずれかです。

pullRequest.version.potentialMergeCommit.sha 文字列

state が prepared の場合にのみ設定されます。親を 2 つ持つテストマージコミットで、2 番目の親はバージョンの head_sha、1 番目の親は base_sha です。このバージョンが最新である間は pull/\<number>/merge の先端を指し、その後も SHA で参照できます。

pullRequest.version.potentialMergeCommit.baseSha 文字列

state が prepared の場合にのみ設定されます。準備時点のベースブランチの先端を指し、バージョンの base_sha より新しい場合があります。ベースブランチが進んだだけでは更新されず、再オープン時に準備し直されます。

repository オブジェクト

プルリクエストが属するリポジトリ。

repository.id string

repository.name string

repository.owner object

リポジトリの所有者。

repository.owner.slug string

所有者の URL フレンドリーな一意の名前。

repository.owner.id string

オーナーの namespace の一意な ID。

repository.owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

event.payload のサンプル:

{  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "state": "open",    "draft": false,    "merged": false,    "title": "Add launch telemetry",    "body": "Adds structured launch telemetry to the ignition path.",    "head": {      "ref": "add-telemetry",      "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"    },    "base": {      "ref": "add-telemetry-schema",      "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"    },    "author": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    },    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z",    "additions": 128,    "deletions": 46,    "changedFiles": 5,    "stack": {      "id": "stk_01k2ja2000e0080000000000s1",      "parentPullRequest": {        "id": "pr_01k2ja2000e0080000000000d3",        "number": "16",        "repository": {          "id": "repo_01k2ja2000e0080000000000q4",          "name": "rocket",          "owner": {            "slug": "acme",            "id": "ns_01k2ja2000e0080000000000p3",            "type": "team"          }        }      }    },    "version": {      "number": "3",      "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8",      "createdAt": "2026-08-01T09:30:00Z"    }  },  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  }}

プルリクエストのラベルイベント

EVENTpull_request.label.addedpull_request.label.removed

プルリクエストに付与されたラベルの変更です。現在のラベルは ListPullRequestLabels で取得できます。

ペイロードのフィールド

pullRequest オブジェクト

付与されたラベルが変更されたプルリクエスト。

pullRequest.id 文字列

不変のオリジン変更ID。

pullRequest.number 文字列

pullRequest.repository オブジェクト

このプルリクエストのリポジトリ参照先。

pullRequest.repository.id 文字列

pullRequest.repository.name 文字列

pullRequest.repository.owner オブジェクト

リポジトリの所有者。

pullRequest.repository.owner.slug 文字列

所有者を識別する、URL向けの一意な名前。

pullRequest.repository.owner.id 文字列

オーナーの namespace の一意な ID。

pullRequest.repository.owner.type 文字列

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

label オブジェクト

イベントの対象となるラベル。

label.id 文字列

label.name 文字列

label.color string

先頭の # を除く6文字の16進数カラーコード。

label.description 文字列

actor オブジェクト

ラベルを付与または削除したプリンシパル (判明している場合) 。

actor.user オブジェクト

actor.user.id 文字列

actor.user.email 文字列必須

actor.user.displayName 文字列

人が読める表示名：アカウントの名と姓をそれぞれトリミングし、スペースで連結したものです。製品のUIに表示される名前とまったく同じです。アカウントに名前がない場合は省略され、メールアドレスやID、その他のフィールドから生成されることはありません。アクターを特定できなかったWebhookペイロードでは、存在しない場合もあります。

actor.user.handle 文字列

ユーザーが取得済みのプロファイルハンドル (cursor.com /@handle に対応するID) 。@ プレフィックスは含まれません。ユーザーのプロファイルが公開されている間のみ含まれ、ハンドルを取得していないユーザーや非公開プロファイルの場合は省略されます。

actor.user.performedVia オブジェクト

この actor フィールドが示す操作について、アプリがインストールユーザートークンを使ってこのユーザーに代わって操作した場合に設定されます。たとえば、コメントの作成者に設定されている場合は、後からそのコメントを編集または削除したアクターではなく、コメントを作成したアプリを示します。ユーザーが直接操作した場合は設定されず、委任データを利用できない場合も設定されないことがあります。

actor.user.performedVia.app オブジェクト

ユーザーに代わって操作を行ったアプリ。

actor.user.performedVia.app.id 文字列

actor.user.performedVia.app.displayName 文字列

アプリに登録された表示名。存在する場合、空になることはありません。アプリを解決できなかったペイロードや、Cherri Code 自身が提供するファサードアクターでは省略されます。

actor.app オブジェクト

actor.app.id 文字列

actor.app.displayName 文字列

アプリに登録された表示名。存在する場合は空になりません。アプリを特定できなかったペイロード、およびCherri Codeのファーストパーティ製ファサードアクターでは省略されます。

actor.serviceAccount オブジェクト

actor.serviceAccount.id 文字列

event.payload のサンプル:

{  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    }  },  "label": {    "id": "lbl_01k2ja2000e0080000000000m1",    "name": "bug",    "color": "d73a4a",    "description": "Something isn't working"  },  "actor": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  }}

プルリクエストコメント

EVENTpull_request.comment.created

プルリクエストに作成されたコメント。レビューとともに提出されたコメントは、レビューの提出時に、コメントごとに1つのイベントとして配信されます。

ペイロードのフィールド

pullRequest オブジェクト

コメントが投稿されたプルリクエスト。

pullRequest.id string

変更不可の Origin の変更 ID。

pullRequest.number string

pullRequest.repository object

このプルリクエストのリポジトリ参照先。

pullRequest.repository.id string

pullRequest.repository.name string

pullRequest.repository.owner object

リポジトリの所有者。

pullRequest.repository.owner.slug string

所有者の URL に適した一意の名前。

pullRequest.repository.owner.id string

オーナー名前空間の一意の ID。

pullRequest.repository.owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

comment object

作成されたコメント。スレッドを開始したコメントには、そのスレッドの差分アンカーがインラインで含まれます。返信には comment.thread.id のみが含まれます。スレッドの解決状態はこのイベントに含まれないため、GetPullRequestComment で取得してください。

comment.id string

comment.thread オブジェクト

このコメントが属するスレッド。diffアンカーと解決状態を含みます。

comment.thread.id string

comment.thread.version object

スレッドが紐づけられたプルリクエストのバージョン。head と base の SHA を含みます (PullRequestReview.pull_request_version を参照) 。

comment.thread.version.number string

プルリクエスト内で単調増加するバージョン番号 (1始まり) 。

comment.thread.version.headSha string

このバージョンのHEADコミットのSHA。

comment.thread.version.baseSha string

このバージョンの差分比較に使用するベースコミットのSHA。

comment.thread.path string

スレッドの差分アンカーのファイルパス。一般的なディスカッションのスレッドでは空です。

comment.thread.side string

アンカーの差分側。全般的な議論スレッドでは未設定。left、right のいずれか。

comment.thread.startLine integer

ファイルの side バージョンにおけるアンカー範囲の最初の行。ファイル全体および一般的なディスカッションのスレッドでは 0。

comment.thread.endLine integer

アンカー範囲に含まれる最終行。アンカーが単一行の場合、または行範囲がない場合は 0。

comment.thread.resolvedAt string

スレッドが解決された日時。スレッドがオープンの間は未設定です。RFC 3339 形式のタイムスタンプ。

comment.thread.createdAt string

RFC 3339 形式のタイムスタンプ。

comment.thread.updatedAt string

RFC 3339 形式のタイムスタンプ。

comment.body string

comment.author オブジェクト

外部から確認できるアクションを実行したユーザー、アプリ、またはサービスアカウント。

comment.author.user オブジェクト

comment.author.user.id string

comment.author.user.email string 必須

comment.author.user.displayName string

人間が読める表示名：アカウントの名と姓をそれぞれ前後の空白を取り除いてから、スペースで連結したものです。製品 UI に表示される名前とまったく同じです。アカウントに名前がない場合は省略され、メールアドレス、ID、その他のフィールドから補って生成されることはありません。アクターを特定できなかった場合、Webhook ペイロードにも含まれないことがあります。

comment.author.user.handle string

ユーザーが取得済みのプロフィールハンドル (cursor.com /@handle の本人を示すもの) 。@プレフィックスは含みません。ユーザーのプロフィールが公開されている間のみ表示され、ハンドルを取得していないユーザーや非公開プロフィールの場合は省略されます。

comment.author.user.performedVia オブジェクト

このアクターフィールドが示すアクションについて、アプリがインストールユーザートークンを使ってこのユーザーに代わって操作した場合に設定されます。たとえば、コメントの作成者では、後からコメントを編集または削除したアクターではなく、コメントを作成したアプリを示します。ユーザーが直接操作した場合は設定されません。また、委任データを取得できない場合も設定されないことがあります。

comment.author.user.performedVia.app オブジェクト

ユーザーに代わって操作を行ったアプリ。

comment.author.user.performedVia.app.id string

comment.author.user.performedVia.app.displayName string

アプリの登録済み表示名。存在する場合は決して空ではありません。アプリを解決できなかったペイロードおよびファーストパーティの Cherri Code ファサードアクターでは省略されます。

comment.author.app オブジェクト

comment.author.app.id string

comment.author.app.displayName string

comment.author.serviceAccount オブジェクト

comment.author.serviceAccount.id string

comment.createdAt string

RFC 3339 形式のタイムスタンプ。

comment.updatedAt string

RFC 3339 形式のタイムスタンプ。

event.payload の例:

{  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    }  },  "comment": {    "id": "cmt_01k2ja2000e0080000000000e5",    "thread": {      "id": "cth_01k2ja2000e0080000000000s6",      "version": {        "number": "3",        "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",        "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"      },      "path": "src/telemetry/retry.ts",      "side": "right",      "startLine": 42,      "endLine": 45,      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z"    },    "body": "Should the retry budget be configurable?",    "author": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    },    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z"  }}

プルリクエストコメントのリアクションイベント

EVENTpull_request.comment.reaction.addedpull_request.comment.reaction.removed

プルリクエストのコメントにリアクションが追加または削除されたことを示すイベントです。エンベロープの event.type にアクションが記録されます。追加イベントは少なくとも1回配信されます。リアクターがすでにそのコメントに付けているリアクションを再度付けると、同じ (comment, reactor, content) に対して pull_request.comment.reaction.added が再度配信されます。リアクターが付けていないリアクションを削除しても、何も配信されません。

ペイロードのフィールド

pullRequest オブジェクト

コメントが投稿されたプルリクエスト。

pullRequest.id string

不変の Origin 変更 ID。

pullRequest.number string

pullRequest.repository object

このプルリクエストのリポジトリ参照。

pullRequest.repository.id string

pullRequest.repository.name string

pullRequest.repository.owner object

リポジトリの所有者。

pullRequest.repository.owner.slug string

所有者のURLに適した一意の名前。

pullRequest.repository.owner.id string

所有者の名前空間の一意な ID。

pullRequest.repository.owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

comment object

リアクションが付いたコメント。

comment.id string

comment.thread オブジェクト

このコメントが属するスレッドです。

comment.thread.id string

reaction オブジェクト

追加または削除されたリアクション。

reaction.content 文字列

コメントに付けられたリアクション。指定可能な値は固定されており、認識されない値は受信側で表示できないリアクションとして扱われます。thumbs_up、thumbs_down、laugh、hooray、confused、heart、rocket、eyes のいずれか。

reaction.reactor オブジェクト

リアクションを付けたプリンシパル。リアクションを削除できるのは付けた本人のみのため、追加イベントと削除イベントのどちらでも、これが実行元のプリンシパルになります。

reaction.reactor.user オブジェクト

reaction.reactor.user.id 文字列

reaction.reactor.user.email string 必須

reaction.reactor.user.displayName string

人が読める表示名：アカウントの名と姓それぞれの前後の空白を除去し、スペースで連結したものです。製品 UI に表示される名前と完全に同じです。アカウントに名前がない場合は省略され、メールアドレス、ID、その他のフィールドから生成されることはありません。アクターを特定できなかった webhook ペイロードでは、表示名がない場合もあります。

reaction.reactor.user.handle string

ユーザーが登録しているプロフィールハンドル (cursor.com /@handle の背後にある識別情報)。@ プレフィックスは含みません。ユーザーのプロフィールが公開されている間のみ表示され、ハンドルを登録していないユーザーや非公開プロフィールの場合は省略されます。

reaction.reactor.user.performedVia オブジェクト

この actor フィールドが示すアクションで、アプリがインストールユーザートークンを使用してこのユーザーに代わって操作した場合に設定されます。たとえば、コメントの author に設定されている場合、後からそのコメントを編集または削除した actor ではなく、コメントを作成したアプリを示します。ユーザーが直接操作した場合は設定されず、委任データを利用できない場合も設定されないことがあります。

reaction.reactor.user.performedVia.app オブジェクト

ユーザーに代わって操作したアプリ。

reaction.reactor.user.performedVia.app.id 文字列

reaction.reactor.user.performedVia.app.displayName 文字列

reaction.reactor.app オブジェクト

reaction.reactor.app.id string

reaction.reactor.app.displayName string

reaction.reactor.serviceAccount オブジェクト

reaction.reactor.serviceAccount.id string

event.payload の例:

{  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    }  },  "comment": {    "id": "cmt_01k2ja2000e0080000000000e5",    "thread": {      "id": "cth_01k2ja2000e0080000000000s6"    }  },  "reaction": {    "content": "thumbs_up",    "reactor": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    }  }}

プルリクエストレビューイベント

EVENTpull_request.review.submittedpull_request.review.dismissed

ペイロードのフィールド

pullRequest オブジェクト

レビューが提出されたプルリクエスト。

pullRequest.id string

不変のオリジン変更 ID。

pullRequest.number string

pullRequest.repository object

このプルリクエストに関連するリポジトリ。

pullRequest.repository.id string

pullRequest.repository.name string

pullRequest.repository.owner object

リポジトリの所有者。

pullRequest.repository.owner.slug string

オーナーを識別する、URLで使用できる一意の名前。

pullRequest.repository.owner.id string

所有者ネームスペースの一意な ID。

pullRequest.repository.owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

review オブジェクト

送信されたか却下されたレビュー。却下された場合、review.dismissal が設定されます。

review.id string

Stable Origin のレビュー識別子。

review.author object

レビューを作成したプリンシパル。

review.author.user object

review.author.user.id string

review.author.user.email string 必須

review.author.user.displayName string

人が読める表示名：アカウントの名と姓をそれぞれトリミングし、スペースでつないだもので、製品の UI に表示される名前と完全に一致します。アカウントに名前がない場合は省略され、メールアドレス、ID、その他のフィールドから生成されることはありません。アクターを特定できなかった場合、Webhook ペイロードにも含まれないことがあります。

review.author.user.handle string

ユーザーが取得済みのプロフィールハンドル (cursor.com /@handle の背後にある識別子) 。@プレフィックスは含みません。ユーザーのプロフィールが公開されている間のみ表示され、ハンドルを取得していないユーザーや非公開プロフィールの場合は省略されます。

review.author.user.performedVia object

このアクターフィールドが表すアクションについて、アプリがインストールユーザートークンを使用してこのユーザーの代理で操作した場合に設定されます。例えば、コメントの作成者の場合は、後からコメントを編集または削除したアクターではなく、コメントを作成したアプリを示します。ユーザーが直接操作した場合は存在せず、委任データを取得できない場合にも存在しないことがあります。

review.author.user.performedVia.app オブジェクト

ユーザーに代わって操作を行ったアプリ。

review.author.user.performedVia.app.id string

review.author.user.performedVia.app.displayName string

review.author.app object

review.author.app.id string

review.author.app.displayName string

review.author.serviceAccount object

review.author.serviceAccount.id string

review.verdict string

approve、request_changes、comment のいずれか。

review.body string

自由記述のレビュー要約。レビュー担当者が要約を残していない場合は空です。

review.submittedAt string

レビューが送信された時刻。未送信の下書きレビューの場合は未設定。RFC 3339 形式のタイムスタンプ。

review.pullRequestVersion オブジェクト

判定の対象となるプルリクエストのバージョンと HEAD SHA。

review.pullRequestVersion.number string

プルリクエスト内での単調増加バージョン番号 (1 始まり) 。

review.pullRequestVersion.headSha string

このバージョンのヘッドコミットのSHA。

review.pullRequestVersion.baseSha string

このバージョンの差分比較の基準となるベースコミットの SHA。

review.dismissal オブジェクト

レビューが却下されると設定されます。判定がプルリクエストのレビュー状態に反映されている間は表示されません。

review.dismissal.dismissedBy object

レビューを却下した主体。却下がこの API が公開していない種類のアクターによって記録されている場合は存在しません。

review.dismissal.dismissedBy.user object

review.dismissal.dismissedBy.user.id string

review.dismissal.dismissedBy.user.email string 必須

review.dismissal.dismissedBy.user.displayName string

review.dismissal.dismissedBy.user.handle string

review.dismissal.dismissedBy.user.performedVia object

このアクターフィールドが表す操作で、アプリがインストールユーザートークンを使用してユーザーに代わって操作した場合に設定されます。たとえば、コメントの作成者に付く場合は、後からコメントを編集または削除したアクターではなく、コメントを作成したアプリを示します。ユーザーが直接操作した場合は含まれず、委任データを利用できない場合も含まれないことがあります。

review.dismissal.dismissedBy.user.performedVia.app オブジェクト

ユーザーの代理として操作したアプリ。

review.dismissal.dismissedBy.user.performedVia.app.id string

review.dismissal.dismissedBy.user.performedVia.app.displayName string

review.dismissal.dismissedBy.app object

review.dismissal.dismissedBy.app.id string

review.dismissal.dismissedBy.app.displayName string

review.dismissal.dismissedBy.serviceAccount object

review.dismissal.dismissedBy.serviceAccount.id string

review.dismissal.dismissedAt string

レビューが却下された日時。RFC 3339形式のタイムスタンプ。

review.dismissal.message string

却下時に記録された理由。作成者が新しい判定を送信したため自動的に無効化されたレビューには、サーバーが生成した理由が付与されます。

event.payload の例:

{  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    }  },  "review": {    "id": "rev_01k2ja2000e0080000000000f6",    "author": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    },    "verdict": "approve",    "body": "Approving. The telemetry schema matches the spec.",    "submittedAt": "2026-08-02T15:00:00Z",    "pullRequestVersion": {      "number": "3",      "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"    }  }}

プルリクエストレビュアーのイベント

EVENTpull_request.reviewer.addedpull_request.reviewer.removedpull_request.reviewer.rerequested

プルリクエストのレビュー依頼先の変更。現在保留中の一覧は ListPullRequestRequestedReviewers で取得できます。

ペイロードのフィールド

pullRequest オブジェクト

レビュー依頼先が変更されたプルリクエスト。

pullRequest.id string

変更元の変更IDは不変です。

pullRequest.number string

pullRequest.repository object

このプルリクエストのリポジトリへの参照。

pullRequest.repository.id string

pullRequest.repository.name string

pullRequest.repository.owner object

リポジトリの所有者。

pullRequest.repository.owner.slug string

オーナーの一意な、URL に使用可能な名前。

pullRequest.repository.owner.id string

所有者名前空間の一意の ID。

pullRequest.repository.owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

reviewer object

このイベントに関する、依頼されたレビュー担当者。

reviewer.user object

reviewer.user.id string

reviewer.user.email string 必須

reviewer.user.displayName string

人間が読める形式の display name。account の名と姓をそれぞれトリムし、スペースで連結したもので、製品の UI が render する名前とまったく同じです。account に name がない場合は省略され、email や id、その他の field から生成されることはありません。actor を resolve できなかった webhook のペイロードでも欠落する場合があります。

reviewer.user.handle string

ユーザーが取得済みのプロフィールハンドル (cursor.com /@handle の背後にあるID) 。@ プレフィックスは含まれません。ユーザーのプロフィールが公開されている間のみ表示され、ハンドルを取得していないユーザーや非公開プロフィールでは省略されます。

reviewer.user.performedVia オブジェクト

この actor field が表す操作において、アプリがインストールユーザートークンを使用してこのユーザーの代わりに操作した場合に設定されます。例えば、コメントの作成者の場合は、後からコメントを編集または削除した actor ではなく、コメントを作成したアプリを示します。ユーザーが直接操作した場合は含まれません。また、委任データを取得できない場合も含まれないことがあります。

reviewer.user.performedVia.app オブジェクト

ユーザーに代わって操作を行ったアプリ。

reviewer.user.performedVia.app.id string

reviewer.user.performedVia.app.displayName string

アプリの登録済み表示名。存在する場合は空ではありません。アプリを特定できなかったペイロード、およびファーストパーティのCherri Codeファサードアクターでは省略されます。

reviewer.group object

公開 Origin グループの ID (grp_…) 。現在は id のみ。

reviewer.group.id string

createdVia string

確認リクエストの作成方法。manual、codeowners のいずれか。

createdBy オブジェクト

レビューリクエストを作成した主体 (判明している場合) 。

createdBy.user オブジェクト

createdBy.user.id string

createdBy.user.email string 必須

createdBy.user.displayName string

人間が読める表示名：アカウントの名と姓をそれぞれトリミングし、スペースで連結したもの。製品の UI に表示される名前と完全に一致します。アカウントに名前がない場合は省略され、メールアドレス、ID、その他のフィールドから生成されることはありません。アクターを特定できなかった場合、Webhook のペイロードにも含まれないことがあります。

createdBy.user.handle string

ユーザーが取得済みのプロフィールハンドル (cursor.com /@handle に対応するID) 。@ プレフィックスは含まれません。ユーザーのプロフィールが公開されている場合にのみ含まれ、ハンドルを取得していないユーザーや非公開のプロフィールでは省略されます。

createdBy.user.performedVia オブジェクト

この actor フィールドが示す操作について、アプリがインストールユーザートークンを使用してこのユーザーの代理で操作した場合に設定されます。たとえば、コメントの作成者には、そのコメントを作成したアプリが示され、後からコメントを編集または削除した actor は示されません。ユーザーが直接操作した場合は設定されず、委任データを利用できない場合も設定されないことがあります。

createdBy.user.performedVia.app オブジェクト

ユーザーに代わって操作を行ったアプリ。

createdBy.user.performedVia.app.id string

createdBy.user.performedVia.app.displayName string

アプリの登録済み表示名。存在する場合、空になることはありません。アプリを解決できなかった payload、および first-party の Cherri Code ファサード actor では省略されます。

createdBy.app オブジェクト

createdBy.app.id string

createdBy.app.displayName string

createdBy.serviceAccount オブジェクト

createdBy.serviceAccount.id string

createdAt string

確認リクエストが作成された日時。RFC 3339 形式のタイムスタンプ。

event.payload のサンプル:

{  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    }  },  "reviewer": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "createdVia": "codeowners",  "createdAt": "2026-08-02T14:45:00Z"}

チェック実行イベント

EVENTrepository.check_run.createdrepository.check_run.updatedrepository.check_run.completed

Origin の check-run ライフサイクルイベントのコミット済みスナップショット。

ペイロードのフィールド

repository オブジェクト

チェック実行が属するリポジトリ。

repository.id string

repository.name string

repository.owner object

リポジトリの所有者。

repository.owner.slug string

所有者の一意でURLに適した名前。

repository.owner.id string

オーナーの namespace の一意の ID。

repository.owner.type string

team または user。出力専用。不明な場合は未設定。team または user のいずれか。

checkSuite オブジェクト

このチェック実行が属するスイート。

checkSuite.id string

サーバーによって割り当てられたスイートの一意のID。

checkSuite.repository object

スイートが属するリポジトリ。

checkSuite.repository.id string

checkSuite.repository.name string

checkSuite.repository.owner object

リポジトリの所有者。

checkSuite.repository.owner.slug string

所有者の一意でURLに適した名前。

checkSuite.repository.owner.id string

所有者の名前空間の一意の ID。

checkSuite.repository.owner.type string

team または user。出力専用。不明な場合は未設定。team または user のいずれか。

checkSuite.sha string

スイートが紐付けられている解決済みヘッドコミットのSHA (小文字の16進数) 。

checkSuite.key string

スイート用にアプリが選択した冪等性キー。

checkSuite.name string

ユーザー向けのスイート名。

checkSuite.detailsUrl string

設定されている場合、スイート全体の詳細へのリンク。

checkSuite.createdAt string

RFC 3339 形式のタイムスタンプ。

checkSuite.updatedAt string

RFC 3339 形式のタイムスタンプ。

checkSuite.externalId string

このスイート試行に対してプロバイダーが割り当てた不変の識別子。

checkSuite.actor オブジェクト

スイートを生成したプリンシパル。

checkSuite.actor.user オブジェクト

checkSuite.actor.user.id string

checkSuite.actor.user.email string 必須

checkSuite.actor.user.displayName string

人間が読める表示名: アカウントの名と姓をそれぞれトリムし、スペースで結合したもので、製品の UI が表示する名前とまったく同じものです。アカウントに名前がない場合は省略されます。メール、ID、またはその他のフィールドから合成されることはありません。アクターを解決できなかった webhook のペイロードでは存在しない場合もあります。

checkSuite.actor.user.handle string

ユーザーが取得したプロフィールハンドル (cursor.com /@handle の背後にある識別子。@ プレフィックスを除く) 。ユーザーのプロフィールが公開されている場合にのみ表示され、取得済みのハンドルがないユーザーや非公開プロフィールの場合は省略されます。

checkSuite.actor.user.performedVia オブジェクト

この actor フィールドが示す操作において、アプリがインストールユーザートークンを使ってこのユーザーに代わって操作した場合に設定されます。たとえば、コメントの作成者に付随するこのフィールドは、後からコメントを編集または削除した主体ではなく、コメントを作成したアプリを示します。ユーザーが直接操作した場合は設定されず、委任データを利用できない場合も設定されないことがあります。

checkSuite.actor.user.performedVia.app オブジェクト

ユーザーに代わって操作したアプリ。

checkSuite.actor.user.performedVia.app.id string

checkSuite.actor.user.performedVia.app.displayName string

アプリに登録された表示名。存在する場合は決して空になりません。アプリを解決できなかったペイロードおよびファーストパーティの Cherri Code ファサードアクターでは省略されます。

checkSuite.actor.app オブジェクト

checkSuite.actor.app.id string

checkSuite.actor.app.displayName string

アプリに登録された表示名。存在する場合、空になることはありません。アプリを解決できなかったペイロード、およびファーストパーティの Cherri Code ファサードアクターでは省略されます。

checkSuite.actor.serviceAccount オブジェクト

checkSuite.actor.serviceAccount.id string

checkRun object

このライフサイクル時点におけるチェック実行のスナップショット。

checkRun.id string

サーバーによって割り当てられたチェック実行の一意のID。

checkRun.repository object

チェック実行が属するリポジトリ。

checkRun.repository.id string

checkRun.repository.name string

checkRun.repository.owner オブジェクト

リポジトリの所有者。

checkRun.repository.owner.slug string

所有者の一意でURLに適した名前。

checkRun.repository.owner.id string

所有者の名前空間の一意の ID。

checkRun.repository.owner.type string

team または user。出力専用。不明な場合は未設定。team または user のいずれか。

checkRun.checkSuite オブジェクト

このチェック実行が属するスイート。

checkRun.checkSuite.id string

checkRun.sha string

チェック実行が紐付けられている解決済みの head コミット SHA (小文字の16進数) 。

checkRun.key string

チェック実行に対してアプリが指定した冪等性キー。

checkRun.name string

ユーザー向けのチェックラン名。

checkRun.status string

ライフサイクルの状態。failing は、まだ実行中で、アプリがすでに失敗すると認識している実行です。ゲートと必須チェックでは保留として扱われ、conclusion はまだ設定されていません。読み手に対する早期警告となります。rerequested は、再実行がリクエストされたものの、所有アプリからまだ応答がない完了済みの実行です。読み手にとっては保留状態 (queued と同様に表示) であり、conclusion と所要時間は引き続き置き換えられた試行の内容を示します。再リクエスト時 (RerequestCheckRun) に Origin のみが設定でき、アプリはこの状態を投稿できません。queued、in_progress、completed、rerequested、failing のいずれかです。

checkRun.conclusion string

status が completed または rerequested の場合にのみ存在します。rerequested の実行では、置き換えられた試行の判定です。実行は保留中として扱い、status == completed のときにのみ conclusion を読み取ってください。success、failure、neutral、cancelled、skipped、timed_out、action_required、stale のいずれかです。

checkRun.detailsUrl string

設定されている場合、この特定のチェック実行に関する詳細情報へのリンク。

checkRun.externalUpdatedAt string

順序付けに使用する外部システムの最終更新時刻。RFC 3339形式のタイムスタンプ。

checkRun.startedAt string

チェック実行が開始された時刻 (報告されている場合) 。RFC 3339 形式のタイムスタンプ。

checkRun.completedAt string

チェックの実行が完了した時刻 (報告されている場合) 。RFC 3339形式のタイムスタンプ。

checkRun.createdAt string

RFC 3339 形式のタイムスタンプ。

checkRun.updatedAt string

Origin が最後に実行結果を記録した時刻。古いとして無視された投稿や、保存済みの値を繰り返した投稿では更新されないため、この2つを区別できません (PostCheckRunResponse.outcome を参照) 。RFC 3339 形式のタイムスタンプ。

checkRun.externalId string

このチェック試行に対してプロバイダーが割り当てる不変の識別子 (CheckRunInput.external_id を参照。実行ごとに1つ割り当てることを推奨します) 。

checkRun.actor オブジェクト

チェック実行を生成したプリンシパル。常に所有するスイートのactorです。

checkRun.actor.user object

checkRun.actor.user.id string

checkRun.actor.user.email string 必須

checkRun.actor.user.displayName string

人間が読める表示名: アカウントの名と姓をそれぞれ前後の空白を取り除いたうえでスペースで結合したもので、製品 UI に表示される名前と完全に一致します。アカウントに名前がない場合は省略され、メールアドレス、ID、その他のフィールドから生成されることはありません。アクターを特定できなかった webhook のペイロードでは、表示名が含まれない場合もあります。

checkRun.actor.user.handle string

ユーザーが取得済みのプロフィールハンドル (cursor.com /@handle の背後にある識別子)。@ 接頭辞は含みません。ユーザーのプロフィールが公開されている間のみ表示され、ハンドルを取得していないユーザーや非公開プロフィールでは省略されます。

checkRun.actor.user.performedVia オブジェクト

checkRun.actor.user.performedVia.app オブジェクト

ユーザーに代わって操作したアプリ。

checkRun.actor.user.performedVia.app.id string

checkRun.actor.user.performedVia.app.displayName string

アプリの登録済み表示名。存在する場合は空ではありません。アプリを解決できなかったペイロード、およびファーストパーティのCherri Codeファサードアクターでは省略されます。

checkRun.actor.app オブジェクト

checkRun.actor.app.id string

checkRun.actor.app.displayName string

アプリの登録済み表示名。存在する場合は空ではありません。アプリを解決できなかったペイロード、およびファーストパーティのCherri Codeファサードアクターでは省略されます。

checkRun.actor.serviceAccount object

checkRun.actor.serviceAccount.id string

checkRun.output object

設定されている場合、このチェック実行の人間が読める形式の出力。

checkRun.output.title string

出力用の短い見出し。最大文字数: 255文字。

checkRun.output.summary string

出力の要約。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRun.output.text string

詳細な出力。Markdownを含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRun.deadlineAt string

任意の期限です。省略または未設定の場合、期限はありません。実行が完了するとクリアされます。期限切れで timed_out になった場合も同様です (CheckRunInput.deadline_at を参照) 。RFC 3339 形式のタイムスタンプです。

checkRun.isRerequestable boolean

報告元のアプリがこの実行を再リクエスト可能と宣言したかどうか (CheckRunInput.is_rerequestable)。

checkRun.rerequestedAt string

再リクエストが保留中の間に設定され、プロバイダーが再度投稿するとクリアされます。未設定の場合、再リクエストは保留中ではありません。設定中は、status は rerequested となり、実行はコミットの CI 状態で保留中のままです (conclusion と実行時間には置き換えられた結果が表示されます) 。所有アプリは is_rerequestable を宣言して、対象コミットに対する実行を投稿することで応答します。これは、同じ key の新しい実行か、この実行の更新 (このフィールドはクリアされます) のいずれかです。その後、実行は再び再リクエストできるようになります。RFC 3339形式のタイムスタンプ。

checkRun.rerequestedBy オブジェクト

この実行を再リクエストした主体。rerequested_at が設定されている場合にのみ存在し、所有アプリが応答した際にそれとともにクリアされます。

checkRun.rerequestedBy.user オブジェクト

checkRun.rerequestedBy.user.id string

checkRun.rerequestedBy.user.email string 必須

checkRun.rerequestedBy.user.displayName string

checkRun.rerequestedBy.user.handle string

ユーザーが取得したプロフィールハンドル (cursor.com /@handle の背後にある識別子。@ プレフィックスを除く) 。ユーザーのプロフィールが公開されている場合にのみ表示され、ハンドルを取得していないユーザーや非公開プロフィールの場合は省略されます。

checkRun.rerequestedBy.user.performedVia オブジェクト

checkRun.rerequestedBy.user.performedVia.app オブジェクト

ユーザーに代わって操作を行ったアプリ。

checkRun.rerequestedBy.user.performedVia.app.id string

checkRun.rerequestedBy.user.performedVia.app.displayName string

アプリの登録済み表示名。存在する場合は空ではありません。アプリを解決できなかったペイロード、およびファーストパーティのCherri Codeファサードアクターでは省略されます。

checkRun.rerequestedBy.app オブジェクト

checkRun.rerequestedBy.app.id string

checkRun.rerequestedBy.app.displayName string

アプリの登録済み表示名。存在する場合は空ではありません。アプリを解決できなかったペイロード、およびファーストパーティのCherri Codeファサードアクターでは省略されます。

checkRun.rerequestedBy.serviceAccount オブジェクト

checkRun.rerequestedBy.serviceAccount.id string

event.payload のサンプル:

{  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  },  "checkSuite": {    "id": "crg_01k2ja2000e0080000000000h8",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    },    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "key": "ci-8842",    "name": "CI",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z",    "externalId": "build-8842",    "actor": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    }  },  "checkRun": {    "id": "cr_01k2ja2000e0080000000000g7",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    },    "checkSuite": {      "id": "crg_01k2ja2000e0080000000000h8"    },    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "key": "ci-8842-unit-tests",    "name": "unit-tests",    "status": "completed",    "conclusion": "success",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "externalUpdatedAt": "2026-08-02T14:44:30Z",    "startedAt": "2026-08-02T14:40:00Z",    "completedAt": "2026-08-02T14:44:30Z",    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z",    "externalId": "run-8842",    "actor": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    },    "output": {      "title": "Unit tests",      "summary": "128 tests passed.",      "text": "All suites green."    }  }}

チェック実行の再リクエスト

EVENTrepository.check_run.rerequested

チェックランを所有するアプリにのみ配信される repository.check_run.rerequested webhook ペイロードです。応答するには、同じ head SHA とキーに対して新しい run (新しい external_id) を投稿するか、再要求された run を更新します。スタンプが付いた run は、応答する投稿によって rerequested_at がクリアされるまで status: rerequested と表示されます (その conclusion と timings は置き換えられた結果のものです) 。受理された再要求ごとにイベントが1つ発行され、run は応答後に再度要求されることがあるため、再配信の重複排除にはイベント ID のみを使用してください。未処理のスタンプは check_run.rerequested_at に記録されます。ペイロードにはプルリクエストのコンテキストは含まれません (チェックランは (repository, sha) に紐づきます) 。プルリクエストが必要なコンシューマは、独自の head マッピングを介して check_run.sha から解決するか、ビルドした head ブランチでフィルタリングした ListPullRequests を使用します。

ペイロードのフィールド

repository オブジェクト

チェック実行が属するリポジトリです。

repository.id string

repository.name string

repository.owner オブジェクト

リポジトリの所有者。

repository.owner.slug string

オーナーの一意で URL に使える名前。

repository.owner.id string

所有者ネームスペースの一意のID。

repository.owner.type string

team または user。出力専用。不明な場合は未設定。team または user のいずれか。

checkSuite オブジェクト

このチェック実行が属するスイート。

checkSuite.id string

サーバーにより割り当てられたスイートの一意の ID。

checkSuite.repository object

スイートが属しているリポジトリ。

checkSuite.repository.id string

checkSuite.repository.name string

checkSuite.repository.owner object

リポジトリの所有者。

checkSuite.repository.owner.slug string

オーナーのURL向けの固有名。

checkSuite.repository.owner.id string

所有者ネームスペースの一意のID。

checkSuite.repository.owner.type string

team または user。出力専用。不明な場合は未設定。team または user のいずれか。

checkSuite.sha string

スイートが紐づけられている解決済みの head コミット SHA (小文字の16進数) 。

checkSuite.key string

スイート用にアプリが選択した冪等キー。

checkSuite.name string

ユーザー向けのスイート名。

checkSuite.detailsUrl string

設定されている場合、スイート全体の詳細へのリンク。

checkSuite.createdAt string

RFC 3339 形式のタイムスタンプ。

checkSuite.updatedAt string

RFC 3339 形式のタイムスタンプ。

checkSuite.externalId string

このスイート試行に対してプロバイダーが割り当てた不変の識別子。

checkSuite.actor オブジェクト

スイートを生成した主体。

checkSuite.actor.user オブジェクト

checkSuite.actor.user.id string

checkSuite.actor.user.email string 必須

checkSuite.actor.user.displayName string

人間が読める表示名: アカウントの名と姓をそれぞれトリミングし、スペースでつないだものです。製品の UI に表示される名前と完全に一致します。アカウントに名前がない場合は省略され、メールアドレス、ID、その他のフィールドから生成されることはありません。アクターを特定できなかった webhook ペイロードでは、表示名が含まれない場合もあります。

checkSuite.actor.user.handle string

ユーザーが取得済みのプロフィールハンドル (cursor.com/@handle の ID) 。@ は付いていません。ユーザーのプロフィールが公開されている場合にのみ表示され、ハンドルを取得していないユーザーや非公開プロフィールの場合は省略されます。

checkSuite.actor.user.performedVia オブジェクト

この actor フィールドが示す操作について、アプリがインストールユーザートークンを使用してこのユーザーに代わって操作した場合に設定されます。たとえば、コメントの作成者の場合は、そのコメントを作成したアプリを示し、後から編集または削除した主体は示しません。ユーザーが直接操作した場合は省略されます。委任データを取得できない場合も省略されることがあります。

checkSuite.actor.user.performedVia.app オブジェクト

ユーザーに代わって操作したアプリ。

checkSuite.actor.user.performedVia.app.id string

checkSuite.actor.user.performedVia.app.displayName string

アプリに登録された表示名。存在する場合は空になりません。アプリを解決できなかったペイロードや、ファーストパーティの Cherri Code ファサードアクターでは省略されます。

checkSuite.actor.app オブジェクト

checkSuite.actor.app.id string

checkSuite.actor.app.displayName string

アプリに登録された表示名。存在する場合は空になりません。アプリを解決できなかったペイロードや、ファーストパーティの Cherri Code ファサード actor では省略されます。

checkSuite.actor.serviceAccount オブジェクト

checkSuite.actor.serviceAccount.id string

checkRun オブジェクト

再リクエストされたチェック実行 (status: rerequested) 。check_run.rerequested_atには時刻が記録され、check_run.rerequested_byにはリクエストしたユーザーが記録されます。

checkRun.id 文字列

チェック実行にサーバーによって割り当てられた一意のID。

checkRun.repository object

チェック実行が属するリポジトリ。

checkRun.repository.id string

checkRun.repository.name string

checkRun.repository.owner オブジェクト

リポジトリの所有者。

checkRun.repository.owner.slug string

オーナーの一意で URL に使える名前。

checkRun.repository.owner.id string

所有者ネームスペースの一意のID。

checkRun.repository.owner.type string

team または user。出力専用。不明な場合は未設定。team または user のいずれか。

checkRun.checkSuite オブジェクト

このチェック実行が属するスイート。

checkRun.checkSuite.id string

checkRun.sha 文字列

チェック実行が紐づけられている解決済みのヘッドコミット SHA (小文字の16進数) 。

checkRun.key string

チェック実行に対してアプリが指定した冪等性キー。

checkRun.name 文字列

ユーザー向けに表示されるチェックランの名前。

checkRun.status string

ライフサイクルの状態。failing は、まだ実行中で、アプリがすでにチェックに通らないと判断している実行です。ゲートや必須チェックでは保留中として扱われ、conclusion はまだなく、読み取り側への早期警告となります。rerequested は、再実行がリクエストされたものの、所有アプリからまだ応答がない完了済みの実行です。読み取り側では保留中として扱われ (queued と同様に表示され) 、conclusion と実行時間は引き続き置き換えられた試行の内容を示します。再リクエスト時に Origin のみが設定します (RerequestCheckRun) 。アプリはこの状態を投稿できません。queued、in_progress、completed、rerequested、failing のいずれかです。

checkRun.conclusion string

status が completed または rerequested の場合にのみ存在します。rerequested の実行では、置き換えられた試行の判定を示します。実行は保留中として扱い、conclusion は status == completed の場合にのみ参照してください。値は success、failure、neutral、cancelled、skipped、timed_out、action_required、stale のいずれかです。

checkRun.detailsUrl string

設定されている場合、この特定のチェック実行の詳細へのリンク。

checkRun.externalUpdatedAt string

順序付けに使用する外部システムの最終更新時刻。RFC 3339 形式のタイムスタンプ。

checkRun.startedAt string

チェック実行が開始された時刻 (報告されている場合) 。RFC 3339形式のタイムスタンプ。

checkRun.completedAt string

チェック実行が完了した日時 (報告されている場合) 。RFC 3339形式のタイムスタンプ。

checkRun.createdAt string

RFC 3339 形式のタイムスタンプ。

checkRun.updatedAt string

Origin がこの実行を書き込んだ最終時刻。古いものとして無視された投稿や、保存済みの値を繰り返す投稿によって更新されることはありません (PostCheckRunResponse.outcome を参照) 。そのため、この2つを区別することはできません。RFC 3339 形式のタイムスタンプ。

checkRun.externalId string

このチェック試行に対してプロバイダーが割り当てる変更不可の識別子 (CheckRunInput.external_idを参照。実行ごとに1つ割り当てる方式が推奨されます) 。

checkRun.actor オブジェクト

チェック実行を生成した主体。常に所有スイートの actor と一致します。

checkRun.actor.user オブジェクト

checkRun.actor.user.id string

checkRun.actor.user.email string 必須

checkRun.actor.user.displayName string

人間が読める表示名: アカウントの名と姓をそれぞれトリムし、スペースで結合したもので、製品の UI に表示される名前とまったく同じものです。アカウントに名前がない場合は省略され、メール、ID、またはその他のフィールドから合成されることは決してありません。アクターを解決できなかった webhook ペイロードでは存在しない場合もあります。

checkRun.actor.user.handle string

ユーザーが取得したプロフィールハンドル (cursor.com /@handle の背後にある識別子。@ 接頭辞は含みません) 。ユーザーのプロフィールが公開されている場合にのみ表示され、ハンドルを取得していないユーザーや非公開プロフィールでは省略されます。

checkRun.actor.user.performedVia object

この actor フィールドが示す操作について、アプリがインストールユーザートークンを使ってこのユーザーに代わり操作した場合に設定されます。たとえば、コメントの作成者欄にはコメントを作成したアプリが示され、後から編集または削除した主体は示されません。ユーザーが直接操作した場合は設定されず、委任データを利用できない場合も設定されないことがあります。

checkRun.actor.user.performedVia.app オブジェクト

ユーザーに代わって操作したアプリ。

checkRun.actor.user.performedVia.app.id string

checkRun.actor.user.performedVia.app.displayName 文字列

アプリに登録された表示名。存在する場合は空ではありません。アプリを特定できなかったペイロードおよびファーストパーティの Cherri Code ファサードアクターでは省略されます。

checkRun.actor.app オブジェクト

checkRun.actor.app.id string

checkRun.actor.app.displayName string

checkRun.actor.serviceAccount オブジェクト

checkRun.actor.serviceAccount.id string

checkRun.output オブジェクト

設定されている場合に表示される、このチェック実行の人間が読める形式の出力。

checkRun.output.title string

出力用の短い見出し。最大文字数: 255文字。

checkRun.output.summary string

出力の要約。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRun.output.text string

詳細な出力。Markdownを含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRun.deadlineAt 文字列

任意の期限。省略または未設定の場合は有効期限なしとなります。実行が完了するとクリアされ、timed_out として期限切れになった場合も同様です (CheckRunInput.deadline_at を参照してください) 。RFC 3339形式のタイムスタンプ。

checkRun.isRerequestable boolean

レポートアプリがこの実行を再リクエスト可能と宣言したかどうか (CheckRunInput.is_rerequestable) 。

checkRun.rerequestedAt string

再リクエストが保留中の間に設定され、プロバイダーが再度投稿するとクリアされます。未設定の場合、再リクエストは保留中ではありません。設定されている間はstatusがrerequestedとなり、実行はコミットのCI状態で保留のままです (conclusionとタイミング情報には、置き換えられた結果の値が保持されます) 。所有アプリはis_rerequestableを宣言して、再リクエストに応じて実行を投稿します — 同じkeyの新しい実行、またはこの実行の更新 (このフィールドはクリアされます) です — その後、実行を再度リクエストできるようになります。RFC 3339形式のタイムスタンプ。

checkRun.rerequestedBy オブジェクト

実行を再リクエストした主体。rerequested_at が設定されている場合にのみ存在し、所有アプリが応答すると同時にクリアされます。

checkRun.rerequestedBy.user オブジェクト

checkRun.rerequestedBy.user.id string

checkRun.rerequestedBy.user.email string 必須

checkRun.rerequestedBy.user.displayName string

人間が読める表示名: アカウントの名と姓をそれぞれトリミングし、スペースで結合したもの。製品の UI に表示される名前と完全に一致します。アカウントに名前がない場合は省略され、メールアドレス、ID、その他のフィールドから生成されることはありません。アクターを特定できなかった webhook ペイロードでは、存在しない場合もあります。

checkRun.rerequestedBy.user.handle string

ユーザーが取得済みのプロフィールハンドル (cursor.com /@handle の背後にある ID) 。@ プレフィックスを除いたものです。ユーザーのプロフィールが公開されている間のみ表示され、ハンドルを取得していないユーザーや非公開プロフィールの場合は省略されます。

checkRun.rerequestedBy.user.performedVia オブジェクト

この actor フィールドが表すアクションを、アプリがインストールユーザートークンを使用してこのユーザーの代理で実行した場合に設定されます。たとえばコメントの作成者の場合は、後からコメントを編集・削除した actor ではなく、コメントを作成したアプリを示します。ユーザーが直接操作した場合は存在せず、委任データを取得できない場合も存在しないことがあります。

checkRun.rerequestedBy.user.performedVia.app オブジェクト

ユーザーに代わって操作したアプリ。

checkRun.rerequestedBy.user.performedVia.app.id string

checkRun.rerequestedBy.user.performedVia.app.displayName string

checkRun.rerequestedBy.app オブジェクト

checkRun.rerequestedBy.app.id string

checkRun.rerequestedBy.app.displayName string

checkRun.rerequestedBy.serviceAccount オブジェクト

checkRun.rerequestedBy.serviceAccount.id string

event.payload のサンプル:

{  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  },  "checkSuite": {    "id": "crg_01k2ja2000e0080000000000h8",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    },    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "key": "ci-8842",    "name": "CI",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T15:10:00Z",    "externalId": "build-8842",    "actor": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    }  },  "checkRun": {    "id": "cr_01k2ja2000e0080000000000g7",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    },    "checkSuite": {      "id": "crg_01k2ja2000e0080000000000h8"    },    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "key": "ci-8842-unit-tests",    "name": "unit-tests",    "status": "rerequested",    "conclusion": "failure",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "externalUpdatedAt": "2026-08-02T14:44:30Z",    "startedAt": "2026-08-02T14:40:00Z",    "completedAt": "2026-08-02T14:44:30Z",    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T15:10:00Z",    "externalId": "run-8842",    "actor": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    },    "output": {      "title": "Unit tests",      "summary": "1 of 129 tests failed.",      "text": "FAIL telemetry.spec.ts > flushes queued events on shutdown"    },    "isRerequestable": true,    "rerequestedAt": "2026-08-02T15:10:00Z",    "rerequestedBy": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    }  }}

インストールが作成されました

EVENTinstallation.created

ペイロードのフィールド

installation オブジェクト

イベント発生時点のインストールスナップショット。

installation.id string

installation.appId string

インストールされたアプリの識別子。ペイロードの app.id と同じ値です。

installation.target オブジェクト

リポジトリの所有者。

installation.target.slug string

オーナーの一意な URL セーフ名。

installation.target.id string

オーナー名前空間の一意な ID。

installation.target.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.repoSelectionMode string

all、selected のいずれか。

installation.repositories array

repository_selection が "all" の場合は空になります。最大 5,000 件までに制限されます。実際の合計は repositories_count を参照してください。

installation.repositories[].id string

installation.repositories[].name string

installation.repositories[].owner object

リポジトリの所有者。

installation.repositories[].owner.slug string

オーナーの一意な URL セーフ名。

installation.repositories[].owner.id string

オーナーの namespace の一意な ID。

installation.repositories[].owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.scopes array

installation.repositoriesCount integer

実際の合計数。repository_selection が "all" の場合は 0 になります。

installation.createdAt string

RFC 3339 形式のタイムスタンプ。

installation.updatedAt string

RFC 3339 形式のタイムスタンプ。

installation.deletedAt string

RFC 3339 形式のタイムスタンプ。

installation.suspendedAt string

インストールが一時停止中に設定され、アクティブな間は解除されます。RFC 3339形式のタイムスタンプ。

installation.installedBy object

アプリを最初にインストールしたユーザー。

installation.installedBy.id string

installation.installedBy.email string 必須

installation.installedBy.displayName string

人が読める表示名：アカウントの名と姓のそれぞれの前後の空白を取り除き、スペースでつないだものです。製品 UI に表示される名前と完全に一致します。アカウントに名前がない場合は省略され、メールアドレス、ID、その他のフィールドから生成されることはありません。アクターを特定できなかった webhook ペイロードでは、存在しない場合もあります。

installation.installedBy.handle string

ユーザーが取得済みのプロフィールハンドル (cursor.com /@handle の背後にある識別子) 。@ の接頭辞は含みません。ユーザーのプロフィールが公開されている場合のみ表示され、取得済みのハンドルがないユーザーや非公開プロフィールでは省略されます。

installation.installedBy.performedVia オブジェクト

この actor フィールドが示す操作で、アプリがインストールユーザートークンを使用してこのユーザーに代わって操作した場合に設定されます。たとえば、コメントの作成者に付く場合は、そのコメントを作成したアプリを示し、後から編集または削除した actor は示しません。ユーザーが直接操作した場合は存在せず、委任データを利用できない場合も存在しないことがあります。

installation.installedBy.performedVia.app オブジェクト

ユーザーに代わって操作したアプリ。

installation.installedBy.performedVia.app.id string

installation.installedBy.performedVia.app.displayName string

アプリに登録された表示名。存在する場合は空になることはありません。アプリを解決できなかったペイロードと、Cherri Code が提供するファサードの actor では省略されます。

app オブジェクト

このインストールが属するアプリ。

app.id string

app.displayName string

アプリに登録された表示名。存在する場合は空になることはありません。エンキュー時のハイドレーションでアプリを解決できなかった場合は省略されます。

event.payload のサンプル:

{  "installation": {    "id": "inst_01k2ja2000e0080000000000b2",    "appId": "app_01k2ja2000e0080000000000a1",    "target": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    },    "repoSelectionMode": "selected",    "repositories": [      {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      }    ],    "scopes": [      "repository:contents:read",      "repository:pull_requests:read"    ],    "repositoriesCount": 1,    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-01T09:30:00Z",    "installedBy": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "app": {    "id": "app_01k2ja2000e0080000000000a1",    "displayName": "CI Status Bot"  }}

インストールの更新

EVENTinstallation.updated

ペイロードのフィールド

installation オブジェクト

イベント発生時点のインストールのスナップショット。

installation.id string

installation.appId string

インストール済みアプリの識別子。ペイロード上の app.id と同じ値です。

installation.target オブジェクト

リポジトリの所有者。

installation.target.slug string

オーナーを識別する、URLで使いやすい一意の名前。

installation.target.id string

オーナーの namespace の一意な ID。

installation.target.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.repoSelectionMode string

all、selected のいずれか。

installation.repositories array

repository_selection が "all" の場合は空になります。最大 5,000 件までに制限されます。実際の合計は repositories_count を参照してください。

installation.repositories[].id string

installation.repositories[].name string

installation.repositories[].owner object

リポジトリの所有者。

installation.repositories[].owner.slug string

オーナーのURL向けの一意な名前。

installation.repositories[].owner.id string

オーナーの namespace の一意な ID。

installation.repositories[].owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.scopes array

installation.repositoriesCount integer

実際の合計数。repository_selection が "all" の場合は 0 になります。

installation.createdAt string

RFC 3339 形式のタイムスタンプ。

installation.updatedAt string

RFC 3339 形式のタイムスタンプ。

installation.deletedAt string

RFC 3339 形式のタイムスタンプ。

installation.suspendedAt string

インストールが一時停止中の場合に設定され、有効な場合は設定されません。RFC 3339 形式のタイムスタンプです。

installation.installedBy object

アプリを最初にインストールしたユーザー。

installation.installedBy.id string

installation.installedBy.email string 必須

installation.installedBy.displayName string

人間が読める形式の表示名: アカウントの名と姓をそれぞれトリミングし、スペースで連結したもので、製品 UI に表示される名前とまったく同じです。アカウントに名前がない場合は省略されます。メールアドレスや ID、その他のフィールドから生成されることはありません。アクターを解決できなかった webhook ペイロードでは、存在しない場合もあります。

installation.installedBy.handle string

ユーザーが取得済みのプロフィールハンドル (cursor.com /@handle の背後にあるID) 。@ プレフィックスは含みません。ユーザーのプロフィールが公開されている間のみ表示され、ハンドルを取得していないユーザーや非公開のプロフィールでは省略されます。

installation.installedBy.performedVia オブジェクト

この actor フィールドが示す操作を、アプリがインストールユーザートークンを使ってこのユーザーに代わって行った場合に設定されます。たとえば、コメントの作成者では、後からコメントを編集または削除した actor ではなく、コメントを作成したアプリを示します。ユーザーが直接操作した場合は設定されず、委任データを利用できない場合も設定されないことがあります。

installation.installedBy.performedVia.app オブジェクト

ユーザーに代わって操作を行ったアプリ。

installation.installedBy.performedVia.app.id string

installation.installedBy.performedVia.app.displayName string

アプリの登録済み表示名。存在する場合は空になりません。アプリを特定できなかったペイロード、およびファーストパーティの Cherri Code ファサードアクターでは省略されます。

app オブジェクト

このインストールが属するアプリ。

app.id string

app.displayName string

アプリの登録済み表示名。存在する場合は空にはなりません。エンキュー時のハイドレーションでアプリを解決できなかった場合は省略されます。

event.payload のサンプル:

{  "installation": {    "id": "inst_01k2ja2000e0080000000000b2",    "appId": "app_01k2ja2000e0080000000000a1",    "target": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    },    "repoSelectionMode": "selected",    "repositories": [      {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      }    ],    "scopes": [      "repository:contents:read",      "repository:pull_requests:read"    ],    "repositoriesCount": 1,    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z",    "installedBy": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "app": {    "id": "app_01k2ja2000e0080000000000a1",    "displayName": "CI Status Bot"  }}

インストールの一時停止

EVENTinstallation.suspended

ペイロードのフィールド

installation オブジェクト

イベント発生時点のインストールのスナップショット。

installation.id string

installation.appId string

インストールされたアプリの識別子。ペイロードの app.id と同じ値です。

installation.target オブジェクト

リポジトリの所有者。

installation.target.slug string

オーナーの一意な URL セーフ名。

installation.target.id string

オーナーの namespace の一意な ID。

installation.target.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.repoSelectionMode string

all、selected のいずれか。

installation.repositories array

repository_selection が "all" の場合は空になります。最大 5,000 件までに制限されます。実際の合計は repositories_count を参照してください。

installation.repositories[].id string

installation.repositories[].name string

installation.repositories[].owner object

リポジトリの所有者。

installation.repositories[].owner.slug string

オーナーの一意なURL向けの名前。

installation.repositories[].owner.id string

オーナーの名前空間の一意なID。

installation.repositories[].owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.scopes array

installation.repositoriesCount integer

実際の合計数。repository_selection が "all" の場合は 0 になります。

installation.createdAt string

RFC 3339 形式のタイムスタンプ。

installation.updatedAt string

RFC 3339 形式のタイムスタンプ。

installation.deletedAt string

RFC 3339 形式のタイムスタンプ。

installation.suspendedAt string

インストールが一時停止されている間に設定され、アクティブな間は解除されます。RFC 3339形式のタイムスタンプ。

installation.installedBy object

アプリを最初にインストールしたユーザー。

installation.installedBy.id string

installation.installedBy.email string 必須

installation.installedBy.displayName string

人が読める表示名：アカウントの名と姓それぞれの前後の空白を取り除き、スペースで連結したものです。製品 UI に表示される名前と完全に一致します。アカウントに名前がない場合は省略され、メールアドレスや ID、その他のフィールドから生成されることはありません。また、アクターを特定できなかった Webhook ペイロードでは存在しない場合があります。

installation.installedBy.handle string

ユーザーが取得済みのプロフィールハンドル (cursor.com /@handle の背後にある識別子) 。@ プレフィックスは含みません。ユーザーのプロフィールが公開されている間のみ表示され、ハンドルを取得していないユーザーや非公開のプロフィールでは省略されます。

installation.installedBy.performedVia オブジェクト

この actor フィールドが示す操作について、アプリがインストールユーザートークンを使用してこのユーザーの代理で操作した場合に設定されます。たとえば、コメントの作成者の場合は、そのコメントを作成したアプリを示し、後から編集または削除した actor は示しません。ユーザーが直接操作した場合は設定されず、委任データを取得できない場合も設定されないことがあります。

installation.installedBy.performedVia.app オブジェクト

ユーザーに代わって操作を行ったアプリ。

installation.installedBy.performedVia.app.id string

installation.installedBy.performedVia.app.displayName string

アプリに登録された表示名。存在する場合は空になりません。アプリを特定できなかったペイロード、およびファーストパーティのCherri Codeファサードアクターでは省略されます。

app オブジェクト

このインストールが属するアプリ。

app.id string

app.displayName string

event.payload のサンプル:

{  "installation": {    "id": "inst_01k2ja2000e0080000000000b2",    "appId": "app_01k2ja2000e0080000000000a1",    "target": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    },    "repoSelectionMode": "selected",    "repositories": [      {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      }    ],    "scopes": [      "repository:contents:read",      "repository:pull_requests:read"    ],    "repositoriesCount": 1,    "createdAt": "2026-08-01T09:30:00Z",    "installedBy": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    },    "suspendedAt": "2026-08-03T08:15:00Z"  },  "app": {    "id": "app_01k2ja2000e0080000000000a1",    "displayName": "CI Status Bot"  }}

インストールの一時停止解除

EVENTinstallation.unsuspended

ペイロードのフィールド

installation オブジェクト

イベント発生時点のインストールのスナップショット。

installation.id string

installation.appId string

インストール済みアプリの識別子。ペイロードの app.id と同じ値です。

installation.target オブジェクト

リポジトリの所有者。

installation.target.slug string

オーナーの一意な URL セーフ名。

installation.target.id string

オーナーの namespace の一意な ID。

installation.target.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.repoSelectionMode string

all、selected のいずれか。

installation.repositories array

repository_selection が "all" の場合は空になります。最大 5,000 件までに制限されます。実際の合計は repositories_count を参照してください。

installation.repositories[].id string

installation.repositories[].name string

installation.repositories[].owner object

リポジトリの所有者。

installation.repositories[].owner.slug string

オーナーの一意なURL向けの名前。

installation.repositories[].owner.id string

オーナーの namespace の一意な ID。

installation.repositories[].owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.scopes array

installation.repositoriesCount integer

実際の合計数。repository_selection が "all" の場合は 0 になります。

installation.createdAt string

RFC 3339 形式のタイムスタンプ。

installation.updatedAt string

RFC 3339 形式のタイムスタンプ。

installation.deletedAt string

RFC 3339 形式のタイムスタンプ。

installation.suspendedAt string

インストールが一時停止中は設定され、有効な場合は設定解除されます。RFC 3339形式のタイムスタンプです。

installation.installedBy object

アプリを最初にインストールしたユーザー。

installation.installedBy.id string

installation.installedBy.email string 必須

installation.installedBy.displayName string

人間が読める表示名：アカウントの名と姓をそれぞれトリミングし、スペースで連結したものです。製品 UI に表示される名前と完全に一致します。アカウントに名前がない場合は省略されます。メールアドレス、ID、その他のフィールドから生成されることはありません。アクターを特定できなかった webhook のペイロードでは、存在しない場合もあります。

installation.installedBy.handle string

ユーザーが取得済みのプロフィールハンドル (cursor.com /@handle の背後にあるアイデンティティ) 。@ プレフィックスは含みません。ユーザーのプロフィールが公開されている場合にのみ表示され、ハンドルを取得していないユーザーや非公開プロフィールでは省略されます。

installation.installedBy.performedVia オブジェクト

この actor フィールドが示す操作について、アプリがインストールユーザートークンを使ってこのユーザーに代わって操作した場合に設定されます。たとえば、コメントの作成者の場合は、後からコメントを編集または削除した actor ではなく、そのコメントを作成したアプリを示します。ユーザーが直接操作した場合は設定されず、委任データを利用できない場合も設定されないことがあります。

installation.installedBy.performedVia.app オブジェクト

ユーザーの代わりに操作を実行したアプリ。

installation.installedBy.performedVia.app.id string

installation.installedBy.performedVia.app.displayName string

アプリの登録済み表示名。存在する場合、空になることはありません。アプリを特定できなかったペイロードと、ファーストパーティのCherri Codeファサードアクターでは省略されます。

app オブジェクト

このインストールが属するアプリ。

app.id string

app.displayName string

event.payload のサンプル:

{  "installation": {    "id": "inst_01k2ja2000e0080000000000b2",    "appId": "app_01k2ja2000e0080000000000a1",    "target": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    },    "repoSelectionMode": "selected",    "repositories": [      {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      }    ],    "scopes": [      "repository:contents:read",      "repository:pull_requests:read"    ],    "repositoriesCount": 1,    "createdAt": "2026-08-01T09:30:00Z",    "installedBy": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "app": {    "id": "app_01k2ja2000e0080000000000a1",    "displayName": "CI Status Bot"  }}

インストールが削除されました

EVENTinstallation.deleted

ペイロードのフィールド

installation オブジェクト

イベント発生時点のインストールのスナップショット。

installation.id string

installation.appId string

インストールされたアプリの識別子。ペイロードの app.id と同じ値です。

installation.target オブジェクト

repo の owner。

installation.target.slug string

オーナーを識別する、URLで使いやすい一意の名前。

installation.target.id string

所有者の名前空間の一意な ID。

installation.target.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.repoSelectionMode string

all、selected のいずれか。

installation.repositories array

repository_selection が "all" の場合は空になります。最大 5,000 件までに制限されます。実際の合計は repositories_count を参照してください。

installation.repositories[].id string

installation.repositories[].name string

installation.repositories[].owner object

リポジトリの所有者。

installation.repositories[].owner.slug string

オーナーの一意な URL セーフ名。

installation.repositories[].owner.id string

オーナーの namespace の一意な ID。

installation.repositories[].owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.scopes array

installation.repositoriesCount integer

実際の合計数。repository_selection が "all" の場合は 0 になります。

installation.createdAt string

RFC 3339 形式のタイムスタンプ。

installation.updatedAt string

RFC 3339 形式のタイムスタンプ。

installation.deletedAt string

RFC 3339 形式のタイムスタンプ。

installation.suspendedAt string

インストールが一時停止されている間は設定し、有効な場合は解除します。RFC 3339形式のタイムスタンプ。

installation.installedBy object

アプリを最初にインストールしたユーザー。

installation.installedBy.id string

installation.installedBy.email string 必須

installation.installedBy.displayName string

人間が読める表示名：アカウントの名と姓それぞれの前後の空白を取り除き、スペースで連結したものです。製品の UI に表示される名前と完全に同じです。アカウントに名前がない場合は省略され、メールアドレス、ID、その他のフィールドから生成されることはありません。アクターを特定できなかった webhook のペイロードでは、存在しない場合もあります。

installation.installedBy.handle string

ユーザーが取得済みのプロフィールハンドル (cursor.com /@handle の背後にあるID) 。@ プレフィックスは含みません。ユーザーのプロフィールが公開されている場合にのみ表示され、ハンドルを取得していないユーザーや非公開プロフィールでは省略されます。

installation.installedBy.performedVia オブジェクト

この actor フィールドが示す操作で、アプリがインストールユーザートークンを使用してユーザーに代わって操作した場合に設定されます。たとえば、コメントの作成者に付随するこのフィールドには、後からコメントを編集・削除した actor ではなく、コメントを作成したアプリが示されます。ユーザーが直接操作した場合は設定されず、委任データを取得できない場合も設定されないことがあります。

installation.installedBy.performedVia.app オブジェクト

ユーザーに代わって操作を行ったアプリ。

installation.installedBy.performedVia.app.id string

installation.installedBy.performedVia.app.displayName string

アプリに登録された表示名。設定されている場合、空になることはありません。アプリを特定できなかったペイロード、およびファーストパーティのCherri Codeファサードアクターでは省略されます。

app オブジェクト

このインストールが属するアプリ。

app.id string

app.displayName string

アプリに登録された表示名。存在する場合は空になりません。キュー登録時のハイドレーションでアプリを特定できなかった場合は省略されます。

event.payload のサンプル:

{  "installation": {    "id": "inst_01k2ja2000e0080000000000b2",    "appId": "app_01k2ja2000e0080000000000a1",    "target": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    },    "repoSelectionMode": "selected",    "repositories": [      {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      }    ],    "scopes": [      "repository:contents:read",      "repository:pull_requests:read"    ],    "repositoriesCount": 1,    "createdAt": "2026-08-01T09:30:00Z",    "installedBy": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    },    "deletedAt": "2026-08-03T08:15:00Z"  },  "app": {    "id": "app_01k2ja2000e0080000000000a1",    "displayName": "CI Status Bot"  }}

チェック実行の注釈

EVENTrepository.check_run.annotations.created

1 件の CreateCheckRunAnnotations リクエストで、チェック実行に注釈が追加されました (repository.check_run.annotations.created)。注釈は追加専用で、個別に編集・削除されることはありません。そのため、.created が注釈のライフサイクル全体を表し、1 件のリクエストにつき 1 件のイベントが発行されます。check_run はスナップショットではなく参照です。実行のステータス、結論、出力は GetCheckRun で確認してください。annotations はリクエスト内の順序で並びます。Origin が本文を配信可能なサイズに収めるためリストを制限した場合、注釈の件数は annotations_count より少なくなることがあります。残りは ListCheckRunAnnotations でページネーションして取得してください。他のチェック実行ウェブフックと同様に、ペイロードにはプルリクエストのコンテキストは含まれません。sha からプルリクエストを特定してください。

ペイロードのフィールド

repository オブジェクト

チェック実行が属するリポジトリ。

repository.id string

repository.name string

repository.owner object

リポジトリの所有者。

repository.owner.slug string

所有者の一意でURLに適した名前。

repository.owner.id string

所有者の名前空間の一意の ID。

repository.owner.type string

team または user。出力専用。不明な場合は未設定。team または user のいずれか。

checkRun オブジェクト

注釈が追加されたチェック実行と、それが属するスイート。

checkRun.id 文字列

checkRun.name 文字列

checkRun.checkSuite オブジェクト

このチェック実行が属するスイート。

checkRun.checkSuite.id string

sha 文字列

チェック実行が関連付けられている解決済みの head コミット SHA (小文字の16進数) 。

annotations 配列

追加された注釈 (リクエスト順) 。Originがリストの件数を制限した場合、annotations_count より少なくなることがあります。

annotations[].id 文字列

annotations[].checkRunId 文字列

annotations[].annotationLevel 文字列

notice、warning、failure のいずれか。

annotations[].message string

annotations[].title 文字列

annotations[].rawDetails 文字列

annotations[].createdAt 文字列

RFC 3339 形式のタイムスタンプ。

annotations[].updatedAt 文字列

RFC 3339 形式のタイムスタンプ。

annotations[].location オブジェクト

チェック実行の注釈に指定できるソース位置。注釈にこのメッセージが含まれる場合、path、start_line、end_line は必須です。path は正規化されたリポジトリ相対パスです。行と列は 1 から始まる正の座標で、範囲の両端を含みます。columns は単一行の範囲でのみサポートされます。

annotations[].location.path 文字列必須

最大 UTF-8 サイズ: 4096 バイト。

annotations[].location.startLine integer 必須

annotations[].location.endLine integer 必須

annotations[].location.columns オブジェクト

1行の注釈範囲を指定する、任意の列位置の組。

annotations[].location.columns.startColumn integer

annotations[].location.columns.endColumn integer

annotationsCount integer

リクエストによって追加された注釈の数。

createdAt 文字列

バッチが追加された時刻。RFC 3339 形式のタイムスタンプ。

event.payload のサンプル:

{  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  },  "checkRun": {    "id": "cr_01k2ja2000e0080000000000g7",    "name": "unit-tests",    "checkSuite": {      "id": "crg_01k2ja2000e0080000000000h8"    }  },  "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "annotations": [    {      "id": "cra_01k2ja2000e0080000000000v1",      "checkRunId": "cr_01k2ja2000e0080000000000g7",      "annotationLevel": "warning",      "message": "Deprecated API usage; migrate to the v2 client.",      "title": "Deprecated API",      "createdAt": "2026-08-02T14:45:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "location": {        "path": "src/telemetry.ts",        "startLine": 42,        "endLine": 42,        "columns": {          "startColumn": 5,          "endColumn": 31        }      }    },    {      "id": "cra_01k2ja2000e0080000000000v2",      "checkRunId": "cr_01k2ja2000e0080000000000g7",      "annotationLevel": "failure",      "message": "Three tests failed in telemetry.test.ts.",      "title": "Test failures",      "rawDetails": "FAIL telemetry.test.ts flushes on shutdown (expected 1 call, received 0)",      "createdAt": "2026-08-02T14:45:00Z",      "updatedAt": "2026-08-02T14:45:00Z"    }  ],  "annotationsCount": 2,  "createdAt": "2026-08-02T14:45:00Z"}

Origin API

Origin は Early Beta 段階であり、変更される可能性があります。連携を更新する際は、OpenAPI 仕様を確認してください。

Origin Apps は、アプリ JWT とインストールアクセストークンで認証します。認証を参照してください。
詳細なスキーマと例については、OpenAPI 仕様の完全版を参照してください。
エージェントは、llms.txt インデックスまたは llms-full.txt の Markdown 形式の完全なリファレンスを読み込めます。

概要

Origin Apps は、OAuth 形式のインストール同意と GitHub App 形式の認証モデルを採用しています。

アプリは、Ed25519 秘密鍵を使用して短期有効の EdDSA JWT に署名します。
アプリは、その JWT とインストール ID を短期有効のインストールアクセストークン (oit_…) と交換します。
インストールトークンは、インストールで承認されたリポジトリとスコープ内でリポジトリ API を呼び出し、HTTPS 経由の Git 認証に使用します。
Origin は、アプリに登録された webhook URL に署名付き webhook 配信を送信します。

ベース URL

https://api.cursor.com/v1/origin

リファレンスのエンドポイントパスには、/v1/originプレフィックス全体が含まれます。

プロトコルの規約

プレビュー

はじめに

Origin へのアクセス

cursor.com/codebase で Origin をブラウズします。
cursor.com/codebase/settings/apps でアプリの設定を管理します。
アプリの署名キーを生成し、公開キーのみを登録します。

Origin CLI

Origin CLI をインストールしてサインインします。

curl -fsSL https://downloads.cursor.com/origin/install.sh | shorigin auth login

既存のリポジトリをクローンする：

origin repo clone '{ownerSlug}/{repoName}'# または git を直接使用するgit clone 'https://origin.cursor.com/{ownerSlug}/{repoName}.git'

Apps は、ユーザーログインではなく、インストールアクセストークンによる Git HTTPS 認証を使用してクローンします。

インストール

顧客の Workspace 管理者に以下を送信してください：

/codebase/apps/install  ?client_id=APP_ID  &scope=SPACE_SEPARATED_SCOPES  &redirect_uri=REGISTERED_CALLBACK  &state=RANDOM_ANTI_FORGERY_VALUE  &summary=SHORT_REASON_FOR_ACCESS  &include_granted_scopes=true

パラメータ	必須	説明
`client_id`	対応	Origin Apps ID。
`scope`	対応	スペース区切りのスコープ。`repository:metadata:read` は自動的に追加されます。
`redirect_uri`	パートナー主導のインストールでは対応	登録済みのコールバック URI と完全に一致する URI。
`state`	強く推奨	インストールレシートの `state` クレームとしてエコーされる偽造防止用のランダムな値。リダイレクト前に生成し、コールバック時にクレームを確認してください。
`summary`	非対応	同意画面に表示される簡単な説明。
`include_granted_scopes`	非対応	`true` の場合、既存の付与を維持し、追加分のみをリクエストします。

承認後、Origin は登録済みのコールバック URI にリダイレクトします。

https://ci.example.com/origin/callback?installation_receipt=RECEIPT_JWT

インストールでは、次の 2 つのリポジトリ選択モードのいずれかを使用します。

all: インストールは、選択したターゲットが所有するすべてのリポジトリにアクセスできます。
selected: インストールは、Workspace 管理者が選択したリポジトリにのみアクセスできます。

インストールレシート

JOSE ヘッダー:

{  "alg": "EdDSA",  "kid": "origin-key-id",  "typ": "origin-installation-receipt+jwt"}

クレーム:

{  "iss": "https://api.cursor.com/v1/origin",  "aud": "app_01...",  "sub": "i_01...",  "namespace_id": "ns_01...",  "iat": 1786465200,  "exp": 1786465500,  "jti": "RECEIPT_UUID",  "installedBy": {    "id": "user_01...",    "email": "[email protected]",    "displayName": "Jane Doe"  },  "state": "ORIGINAL_VALUE"}

aud はアプリ ID、sub はインストールアクセストークンを発行する際に使用するインストール ID です。
namespace_id は、アプリがインストールされた namespace の安定した ID です。
installedBy は、このインストールまたは再同意を実行したユーザーを識別します。現在のアクションを示すため、再同意時には Get App Installation の永続的な installedBy と異なる場合があります。アカウントに名前がある場合は displayName を含みますが、handle は含みません。handle は REST レスポンスまたは webhook のペイロードから取得してください。
レシートは発行から 5 分で期限切れになります。jti はレシートごとに一意です。
state は、インストール URL に空でない state が含まれる場合にのみ存在し、その値をそのまま返します。リダイレクト前に生成した偽造防止用の値と照合してください。

認証

REST認証情報はBearerスキームで送信してください。各エンドポイントのAuthバッジに、受け入れ可能な認証情報のタイプが一覧表示されます。

curl --request GET \  --url https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME \  --header "Authorization: Bearer $ORIGIN_BEARER_TOKEN"

アプリの署名キーを生成する

OpenSSL を使用して、PKCS#8 秘密鍵と PEM SPKI 公開鍵を作成します。

openssl genpkey -algorithm ED25519 -out origin-app-private.pemopenssl pkey -in origin-app-private.pem -pubout -out origin-app-public.pem

アプリ JWT

JOSE ヘッダー:

{  "alg": "EdDSA",  "kid": "app_01...",  "typ": "JWT"}

クレーム：

{  "iss": "app_01...",  "aud": "origin-apps",  "iat": 1782928800,  "exp": 1782929100}

iss と kid にはアプリ ID を設定します。有効期限は約 5 分に設定します。

Authorization: Bearer APP_JWT

インストールアクセストークン

アプリ JWT を使用して POST /app/installations/{installationId}/access_tokens を呼び出します。インストールトークンは oit_ で始まります。

Authorization: Bearer oit_...

Pull Requestsやチェック実行の書き込み、HTTPS 経由の Gitを含む、リポジトリスコープの操作にはインストールトークンを使用します。

Git HTTPS 認証

Git 操作の直前に、Create Installation Access Token でトークンを発行します。トークンの有効期限は最長 15 分です。

git clone "https://x-access-token:${INSTALLATION_TOKEN}@origin.cursor.com/OWNER_SLUG/REPO_NAME.git"

git remote set-url origin "https://origin.cursor.com/OWNER_SLUG/REPO_NAME.git"

トークンをリモート URL に含めないよう、Git の認証情報ヘルパーを使って指定します：

git -c credential.helper="!f() { echo username=x-access-token; echo password=${INSTALLATION_TOKEN}; }; f" \  clone "https://origin.cursor.com/OWNER_SLUG/REPO_NAME.git"

ユーザー認証による CLI リクエスト

ユーザー認証されたリクエストには origin api を使用します。対話型セッションの場合は、ブラウザからサインインします。

origin auth loginorigin api /repos/OWNER_SLUG/REPO_NAME/pulls

非対話型セッションの場合は、Cherri Code Dashboard → API キーで取得した個人ユーザーの API キーを指定してください。

export CURSOR_API_KEY="YOUR_PERSONAL_USER_API_KEY"origin api /repos/OWNER_SLUG/REPO_NAME/pulls

ディスカバリーと署名キー

ディスカバリーメタデータには、issuer と jwks_uri が含まれます：

curl https://api.cursor.com/v1/origin/.well-known/openid-configuration

{  "issuer": "https://api.cursor.com/v1/origin",  "jwks_uri": "https://api.cursor.com/v1/origin/keys",  "response_types_supported": ["id_token"],  "subject_types_supported": ["public"],  "id_token_signing_alg_values_supported": ["EdDSA"]}

/keys は有効な Ed25519 JWK を返します：

curl https://api.cursor.com/v1/origin/keys

{  "keys": [    {      "kty": "OKP",      "crv": "Ed25519",      "use": "sig",      "alg": "EdDSA",      "kid": "origin-key-id",      "x": "PUBLIC_KEY_MATERIAL"    }  ]}

スコープ

スコープ	許可される操作
`repository:metadata:read`	リポジトリのメタデータを読み取る。自動的に追加されます。
`repository:contents:read`	コミット、ブランチ、コンテンツ、比較ファイル、低レベルの Git オブジェクトを読み取る。ファイルのテキストを検索する。リポジトリのアーカイブをダウンロードする。Git HTTPS 経由でクローン、フェッチ、プルする。ミラーリポジトリをアップストリームソースから同期する。
`repository:contents:write`	Git HTTPS 経由でプッシュする。Pull Requests をマージする。Git data エンドポイント経由でブランチを作成し、ファイルの変更をコミットする。チェック実行を再リクエストする。
`repository:pull_requests:read`	Pull Requests、変更ファイル、Pull Requests のコミット、割り当てられたラベル、マージ可否を読み取る。
`repository:pull_requests:write`	Pull Requests を作成・更新する。Pull Requests のラベルを割り当て・削除する。
`repository:pull_requests:reviews:read`	Pull Requestsコメント、コメントスレッド、送信済み確認、レビュー依頼先を読み取る。
`repository:pull_requests:reviews:write`	コメントを作成・更新し、コメントスレッドを解決・再オープンし、確認を作成・更新・却下し、レビュー担当者を依頼・削除する。
`repository:checks:read`	チェックスイート、実行、チェック実行の注釈を読み取る。
`repository:checks:write`	チェックスイートと実行を作成・更新する。チェック実行の注釈を追加する。
`repository:labels:read`	リポジトリが所有するラベル定義を読み取る。
`repository:labels:write`	リポジトリのラベル定義を作成・更新・削除する。
`repository:rulesets:read`	リポジトリのルールセットを読み取る。
`repository:rulesets:write`	リポジトリのルールセットを作成・更新・削除する。
`repository:settings:read`	リポジトリに直接付与されている権限付与を読み取る。
`repository:settings:write`	リポジトリの設定を更新する: デフォルトブランチ、可視性、マージ方法、自動ヘッドブランチ削除。リポジトリの権限付与を upsert・削除する。
`namespace:settings:read`	所有者に直接付与されている権限付与を読み取る。所有者が信頼する SSH 認証局と、証明書を必須とするかどうかを読み取る。
`namespace:settings:write`	所有者の権限付与を upsert・削除する。SSH 認証局を追加・削除し、所有者が証明書を必須とするかどうかを設定する。これらの書き込みには Cherri Code ユーザー認証情報が必要です。
`namespace:user_tokens:write`	インストールの名前空間のメンバーとして動作するインストールユーザートークンを発行する。トークン自体がこのスコープを持つことはできません。ユーザーの代理としての操作を参照してください。

ミラーリポジトリ

repository:metadata:read
repository:contents:read

レート制限

プリンシパル	デフォルトの予算
インストールアクセストークン	3,000 ポイント/分
アプリ JWT	6,000 ポイント/分
Cherri Code ユーザーまたはサービスアカウント	600 ポイント/分

各エンドポイントは、ハンドラーの実行前にこの予算から固定コストを差し引きます。認証または認可に失敗した場合、コストはかかりません。

コスト	操作
0	レート制限の取得。ステータスの取得のみで、ポイントは消費しません。
1	ほとんどの読み取りエンドポイント、およびインストールアクセストークンを作成
5	通常の書き込み操作、および次の負荷の高い読み取り操作: Get Commit、List Commit Files、List Comparison Files、List Pull Request Files、Get Repo Tarball、Grep Contents
10	Create App、Create Repo、Create Commit From Files、Merge Pull Request、Get Pull Request Mergeability、リポジトリミラーを移行、リポジトリミラーの切り替えを強制

レスポンスヘッダー

課金対象のレスポンスおよびレート制限の取得には、以下のヘッダーが含まれます。

ヘッダー	説明
`X-RateLimit-Limit`	このプリンシパルに対する現在のウィンドウ内の利用可能ポイント数
`X-RateLimit-Remaining`	現在のウィンドウ内の残りポイント数
`X-RateLimit-Used`	現在のウィンドウ内で消費されたポイント数
`X-RateLimit-Reset`	ウィンドウがリセットされる Unix タイムスタンプ (UTC秒)
`X-RateLimit-Resource`	共有パブリック API の予算では常に `core`

上限を超えた場合

リクエストが予算を超過する場合、API は次の内容とともに HTTP 429 を返します。

Retry-After: 再試行までの待機時間 (秒) (60)
X-RateLimit-Remaining が 0 に設定された同じ X-RateLimit-* ヘッダー

{  "code": 8,  "message": "Rate limit exceeded: 3000 points per minute for this installation. Retry after 60s.",  "details": []}

残りのクォータを確認する

共通の規約

ページネーション

ページネーション対応のエンドポイントでは、以下を受け付けます。

pageSize: デフォルトは30で、最大100です。
pageToken: 前のページで返される不透明なトークンです。内容を確認したり、生成したりしないでください。

エラー

エラーの本文には、Google RPC スタイルの形式を使用します。

{  "code": 5,  "message": "resource not found",  "details": []}

エラーの処理を分岐するには、HTTP ステータスと code を使用します。message は開発者向けのテキストとして扱います。

ID

リポジトリパス

リソースリファレンス

RepositoryReference はリポジトリを識別します。
PullRequestReference はプルリクエストを識別し、そのリポジトリリファレンスをネストします。
ThreadReference はプルリクエストコメントを含むスレッドを識別します。
OriginActor は公開actorを user、app、または serviceAccount のいずれかとして識別します。存在するバリアントは必ず1つです。そのバリアントからIDを読み取ってください。

チェック実行

試行と現在の試行

(actor, key) ごとの現在のスイート試行は、第 2 段階で選ばれた配下の現在の実行が最も新しい externalUpdatedAt を持つものです。実行を持たないスイートは自身の createdAt で順位付けされます。同値の場合はスイートの createdAt、次に id の順で、新しいものが優先されます。
そのスイート試行の中で、ある key の現在の実行は、最も新しい externalUpdatedAt を持つものです。同値の場合は createdAt、次に id の順で、新しいものが優先されます。

書き込みの順序付け

`outcome`	意味
`created`	スイート内に `(externalId, key)` に対応する実行が存在せず、新たに作成されました。
`updated`	既存の実行が投稿された値で置き換えられました。
`unchanged`	`externalUpdatedAt` を含む投稿された値が保存済みの実行と等しく、何も書き込まれませんでした。
`ignored_stale`	投稿は stale として無視されました。`checkRun` には投稿された値ではなく保存済みの実行が入ります。

タイムスタンプと期限

現在の制限事項

名前空間全体でのリポジトリ一覧取得とリポジトリ作成は、パートナー API ではサポートされていません。リポジトリはインストール経由で検出してください。
コミット比較では、埋め込みのコミット一覧ではなく、要約データが返されます。変更されたファイルには、専用のページネーション対応のエンドポイント比較ファイルの一覧があります。
スレッドは解決時にのみ指定できます。スレッドを直接一覧表示するエンドポイントはないため、含まれるコメントから読み取ってください。
プッシュ Webhook には完全なコミット一覧は含まれません。
プルリクエストのマージはネイティブのオリジンリポジトリでのみサポートされます。ミラーリポジトリは拒否されます。
ミラーリポジトリは、安定したアウトバウンドミラーになるまで、インストールでは参照専用です。ミラーリポジトリを参照してください。

実装チェックリスト

Ed25519 秘密鍵はシークレットマネージャーに保存し、意図的にローテーションします。アプリの署名キーを生成を参照してください。
インストールコールバックでインストールレシートを確認し、そのクレームからインストール ID と state を読み取ります。
短期有効な app JWT を使用し、必要なタイミングでインストールトークンを発行します。
リポジトリスコープの API、チェック実行の書き込み、Git HTTPS には、app JWT ではなくインストールトークンを使用します。
要求するスコープとリポジトリアクセスは最小限にします。
ページトークンは不透明なものとして扱い、フィルターを変更した場合はページネーションを最初からやり直します。
チェックの key 値は安定していて読みやすいものにします。再試行ごとに新しい不変の externalId を使用し、更新時にはより大きい externalUpdatedAt 値を使用します。
Post Check Run のレスポンスごとに outcome を、Batch Upsert Check Runs のレスポンスごとに各 results[].outcome を読み取ります。古い投稿の場合は、保存済みの実行とともに 200 が返されます。チェック実行を参照してください。
解析前に、生のリクエスト本文を使用して webhook 署名を確認します。
webhook-id を使用して配信を重複排除し、2xx を返した後に非同期で処理します。
将来の互換性のため、未知の JSON フィールドは無視します。

Retry-After と X-RateLimit-* ヘッダーの指示に従います。ポイントを消費せずに残りのポイントを監視するには、レート制限を取得を使用します。

エンドポイントリファレンス

アプリとインストール

レート制限を取得

GET/v1/origin/rate_limit

AuthApp JWTInstallation tokenUser access token

認証済みプリンシパルの現在のパブリック API レート制限のステータスを返します。

レスポンスフィールド

resources オブジェクト

認証済みプリンシパルのレート制限リソース。

resources.core オブジェクト

パブリック API エンドポイントで共有される1分あたりのポイント予算。

resources.core.limit integer

現在のウィンドウで利用可能な最大ポイント数。

resources.core.remaining integer

現在のウィンドウの残りポイント数。

resources.core.reset integer

現在のウィンドウがリセットされる Unix タイムスタンプ (UTC秒) 。

resources.core.used integer

現在のウィンドウで消費されたポイント数。

rate オブジェクト

resources.core の別名です。新しいクライアントでは resources.core を使用してください。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/rate_limit' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "resources": {    "core": {      "limit": 6000,      "remaining": 5994,      "reset": 1785682800,      "used": 6    }  },  "rate": {    "limit": 6000,    "remaining": 5994,    "reset": 1785682800,    "used": 6  }}

認証済みアプリを取得

GET/v1/origin/app

AuthApp JWT

認証済みアプリのメタデータを返します。

レスポンスフィールド

id 文字列

JWT の発行者およびキー ID として使用される Origin アプリの識別子。

displayName 文字列

人が読みやすいアプリの表示名。

webhookUrl 文字列

アプリの Webhook 配信を受信する、登録済みの HTTPS URL。

events 配列

アプリに設定された Webhook イベントのサブスクリプション。installation.* イベントは常に配信されるため、ここには含まれません。

createdAt 文字列

アプリ作成時の RFC 3339 タイムスタンプ。

updatedAt 文字列

最新のアプリメタデータ更新時の RFC 3339 タイムスタンプ。

installationRedirectUris 配列

登録済みのインストールコールバック URI。ローカル以外のコールバックは完全に一致し、HTTPS を使用する必要があります。

namespaceSlug 文字列

アプリを所有する namespace の slug。

description 文字列

publisher が指定したアプリの説明。未設定の場合は空です。

websiteUrl 文字列

publisher の Web サイト。未設定の場合は空です。

defaultScopes 配列

アプリのインストール時に提示されるデフォルトの scope。カタログの scope 文字列として指定されます。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/app' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "app_01k2ja2000e0080000000000a1",  "displayName": "CI Status Bot",  "webhookUrl": "https://ci.acme.dev/webhooks/origin",  "events": [    "pull_request.created",    "pull_request.merged"  ],  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "installationRedirectUris": [    "https://ci.acme.dev/origin/setup"  ],  "namespaceSlug": "acme",  "description": "Posts CI status on pull requests.",  "websiteUrl": "https://ci.acme.dev",  "defaultScopes": [    "repository:contents:read",    "repository:pull_requests:read"  ]}

アプリのインストール一覧

GET/v1/origin/app/installations

AuthApp JWT

認証済みアプリのインストールを一覧表示します。

クエリパラメータ

pageSize 整数

返されるインストールの最大数。未設定または0の場合はデフォルトで30になり、100を超える値は100に制限されます。

pageToken 文字列

前回のレスポンスのnext_page_tokenによる不透明なカーソル。最初のページでは空です。

レスポンスフィールド

installations 配列

認証済みアプリが所有するインストールのページです。

installations[].id 文字列

アプリが保存し、インストール用アクセストークンの発行に使用するインストール識別子。

installations[].appId 文字列

インストール済みアプリの識別子です。

installations[].target オブジェクト

このインストールのために顧客が選択した所有者。

installations[].target.slug 文字列

リポジトリ所有者を識別するために所有者IDとともに使用される、URL 表示用のオーナースラッグです。

installations[].target.id 文字列

オリジン所有者の識別子。

installations[].target.type 文字列

所有者の名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

installations[].createdAt 文字列

RFC 3339 形式のインストール作成タイムスタンプ。

installations[].updatedAt 文字列

最新のインストール更新のRFC3339タイムスタンプ。

installations[].repoSelectionMode 文字列

リポジトリ付与モード: 完全(all)または選択(selected)のいずれか。

installations[].scopes 配列

インストールに対して承認されたスコープです。

installations[].installedBy オブジェクト

installations[].installedBy.id 文字列

ユーザーの公開識別子です。user_ のプレフィックスが付きます。

installations[].installedBy.email 文字列

ユーザーのメールアドレスです。

installations[].installedBy.displayName 文字列

installations[].installedBy.handle 文字列

installations[].suspendedAt 文字列

インストールが停止されている間に設定される RFC 3339 形式のタイムスタンプ。インストールが有効な間は省略されます。

installations[].deletedAt 文字列

nextPageToken 文字列

次のページ用の不透明なカーソル。これ以上ページがない場合は空になります。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/app/installations' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "installations": [    {      "id": "inst_01k2ja2000e0080000000000b2",      "appId": "app_01k2ja2000e0080000000000a1",      "target": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      },      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "repoSelectionMode": "selected",      "scopes": [        "repository:contents:read",        "repository:pull_requests:read"      ]    }  ]}

アプリのインストールを取得

GET/v1/origin/app/installations/{installationId}

AuthApp JWT

認証済みアプリのインストールを1件取得します。

repoSelectionMode は all または selected です。

パスパラメータ

installationId 文字列必須

インストール識別子。

レスポンスフィールド

id 文字列

アプリが保存し、インストールアクセストークンの発行に使用するインストール識別子。

appId 文字列

インストールされたアプリの識別子。

target オブジェクト

このインストールのために顧客が選択した所有者。

target.slug 文字列

リポジトリ所有者を識別するために所有者 ID とともに使用する、URL 向けの所有者スラッグ。

target.id 文字列

Origin の所有者識別子。

target.type 文字列

所有者の名前空間の種類。出力専用。許容される値: team、user。不明な場合は省略されます。

createdAt 文字列

RFC 3339 形式のインストール作成タイムスタンプ。

updatedAt 文字列

最新のインストール更新の RFC 3339 タイムスタンプ。

repoSelectionMode 文字列

リポジトリ付与モード。厳密に "all" または "selected" のいずれかです。

scopes 配列

インストールに対して承認されたスコープ。

installedBy オブジェクト

installedBy.id 文字列

user_ プレフィックスが付いたユーザーの公開識別子。

installedBy.email 文字列

ユーザーのメールアドレス。

installedBy.displayName 文字列

installedBy.handle 文字列

suspendedAt 文字列

インストールが一時停止されている間に設定される RFC 3339 タイムスタンプ。インストールが有効な間は省略されます。

deletedAt 文字列

curl --request GET \  --url 'https://api.cursor.com/v1/origin/app/installations/INSTALLATION_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "inst_01k2ja2000e0080000000000b2",  "appId": "app_01k2ja2000e0080000000000a1",  "target": {    "slug": "acme",    "id": "ns_01k2ja2000e0080000000000p3",    "type": "team"  },  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "repoSelectionMode": "selected",  "scopes": [    "repository:contents:read",    "repository:pull_requests:read"  ]}

アプリのインストールを削除

DELETE/v1/origin/app/installations/{installationId}

AuthApp JWT

パスパラメータ

installationId 文字列必須

削除するインストールの一意の識別子です。URL パスから取得されます。インストールは認証済みアプリに属している必要があります。

レスポンスフィールド

成功したリクエストではレスポンス本文は返されません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/app/installations/INSTALLATION_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンス:

204 No Content

インストールアクセストークンを作成

POST/v1/origin/app/installations/{installationId}/access_tokens

AuthApp JWT

認証済みアプリ用のインストールアクセストークンを作成します。

パスパラメータ

installationId 文字列必須

トークンの対象とするインストールの一意の識別子です。URL パスから取得されます。インストールは認証済みアプリに属している必要があります。

リクエスト本文

scopes 配列

repositoryIds 配列

レスポンスフィールド

token 文字列

oit_ プレフィックスを持つ有効期間の短いインストール認証情報です。

expiresAt 文字列

RFC 3339 形式の有効期限です。トークンは最長 15 分で期限切れとなり、発行に使用した app JWT より長く有効であることはありません。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/app/installations/INSTALLATION_ID/access_tokens' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "scopes": [    "repository:contents:read",    "repository:pull_requests:read"  ],  "repositoryIds": [    "repo_01k2ja2000e0080000000000q4"  ]}'

レスポンスの構造:

{  "token": "oit_2v8xkq4m1c7p9t3w5y0z6r4b",  "expiresAt": "2026-08-01T10:30:00Z"}

インストールユーザートークンの作成

POST/v1/origin/app/installations/{installationId}/user_access_tokens

Installation scopenamespace:user_tokens:writeAuthApp JWT

インストールの名前空間に属するメンバーの代理として動作するインストールユーザートークンを作成します。

パスパラメータ

installationId string 必須

トークンの対象となるインストールの一意の識別子。URL パスから取得されます。インストールは認証済みアプリに属している必要があります。

リクエスト本文

userId string

アクターのペイロードで返される、ユーザーの user_… ID。userId と userEmail のどちらか一方だけを設定してください。

userEmail string

ユーザーのアカウントのメールアドレス。利用対象となる名前空間のメンバー 1 人だけと一致する必要があります。

scopes array

repositoryIds array

レスポンスフィールド

token string

短期有効のインストールユーザートークン。シークレットとして扱い、ログに記録しないでください。

expiresAt string

RFC 3339 形式の有効期限。トークンは最大 15 分で失効し、発行に使用したアプリ JWT より長く有効になることはありません。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/app/installations/INSTALLATION_ID/user_access_tokens' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "userId": "user_01k2ja2000e0080000000000c3",  "scopes": [    "repository:pull_requests:reviews:write"  ],  "repositoryIds": [    "repo_01k2ja2000e0080000000000q4"  ]}'

レスポンスの構造：

{  "token": "YOUR_INSTALLATION_USER_TOKEN",  "expiresAt": "2026-08-01T10:30:00Z"}

アプリのインストール用リポジトリ一覧

GET/v1/origin/installation/repos

AuthInstallation token

認証済みアプリのインストールがアクセス可能なリポジトリを一覧表示します。

CreateInstallationAccessToken で発行されたインストールアクセストークン (oit_) が必要です。

クエリパラメータ

pageSize 整数

返すリポジトリの最大数。未設定または0の場合はデフォルトで30になります。100を超える値は100に制限されます。

pageToken 文字列

filter 文字列

レスポンスフィールド

repositories 配列

簡略化されたリポジトリの概要。完全なタイムスタンプは get-repository を使用してください。

repositories[].id 文字列

Origin リポジトリ識別子。

repositories[].name 文字列

所有者内のリポジトリ名。

repositories[].fullName 文字列

acme/api のように、所有者名とリポジトリ名を組み合わせた名前。

repositories[].owner オブジェクト

リポジトリのオーナー参照。

repositories[].owner.slug 文字列

リポジトリ所有者を識別するために所有者IDとともに使用される、URL表示用の所有者スラッグ。

repositories[].owner.id 文字列

オリジン所有者識別子。

repositories[].owner.type 文字列

所有者の名前空間タイプ。出力専用。許容値: team、user。不明な場合は省略されます。

repositories[].defaultBranch 文字列

リポジトリのデフォルトブランチ名。

repositories[].mirror オブジェクト

ミラーのメタデータ。ネイティブリポジトリとミラーの初回同期が準備できる前は存在しません。

repositories[].mirror.source 文字列

ミラー元。指定可能な値: github。

repositories[].mirror.sourceId 文字列

ソースによって割り当てられた不透明なリポジトリ識別子。

repositories[].mirror.status 文字列

移行中 (カットオーバー完了まで) の実効ミラー方向。許可される値: inbound、outbound。

repositories[].visibility 文字列

リポジトリの可視性。許可される値: internal、private。

repositories[].allowMergeCommit ブール値

プルリクエストをマージコミットとして取り込めるかどうか。

repositories[].allowSquashMerge boolean

プルリクエストをスカッシュマージとしてマージできるかどうか。

repositories[].deleteBranchOnMerge ブール値

マージ時にヘッドブランチを自動的に削除するかどうか。

nextPageToken 文字列

次ページ用の不透明なカーソル。これ以上ページがない場合は空です。

repoSelectionMode 文字列

インストールがすべてのリポジトリに対して権限を付与するか、選択したリポジトリのみに付与するかを報告します。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/installation/repos' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "repositories": [    {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "fullName": "acme/rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      },      "defaultBranch": "main",      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "pushedAt": "2026-08-02T14:45:00Z",      "cloneUrl": "https://origin.cursor.com/git/acme/rocket.git"    }  ],  "repoSelectionMode": "selected"}

Webhook配信の一覧

GET/v1/origin/app/webhook/deliveries

AuthApp JWT

認証済みアプリのWebhook配信を新しい順に一覧表示します。

クエリパラメータ

delivered 真偽値

eventType 文字列

完全一致するイベントタイプ。例: pull_request.created。

installationId 文字列

1つのインストールに絞り込みます (WebhookDelivery.installation.id) 。

createdAfter 文字列

配信の作成時刻で絞り込みます。閲覧用であり、復旧用ではありません。

createdBefore 文字列

pageSize 整数

未設定または0の場合はデフォルトで30になります。100を超える値は100に制限されます。

pageToken 文字列

前のレスポンスのnext_page_tokenに由来する不透明なカーソル。最初のページでは空です。

レスポンスフィールド

deliveries 配列

認証済みアプリのWebhook配信 (新しい順) 。各配信IDは受信者に表示されるwebhook-idです。

deliveries[].id 文字列

安定した配信識別子であり、受信者に表示される webhook-id の値です。冪等性キーとして使用してください。

deliveries[].event オブジェクト

この配信が運ぶイベント。

deliveries[].event.id 文字列

基となる Origin イベントの識別子です。安定した配信 ID と共に存在する場合がありますが、冪等性キーではありません。

deliveries[].event.type 文字列

ルーティングのために配信に含まれるイベントスラッグ。

deliveries[].installation オブジェクト

deliveries[].installation.id 文字列

Webhook配信リスト項目に関連付けられたインストール識別子。

deliveries[].installation.target オブジェクト

インストールの対象となる所有者。

deliveries[].installation.target.slug 文字列

リポジトリ所有者を識別するために所有者IDとともに使用される、URL 表示用のオーナースラッグ。

deliveries[].installation.target.id 文字列

オリジン所有者の識別子。

deliveries[].installation.target.type 文字列

オーナーの名前空間の種類。出力専用。許可される値: team、user。不明な場合は省略されます。

deliveries[].createdAt 文字列

createdAfter および createdBefore の閲覧フィルターで使用される配信作成タイムスタンプ。

deliveries[].deliveredAt 文字列

未設定は delivered=false に対応します：受信者がこの配信を 2xx レスポンスで一度も確認していません。

deliveries[].lastAttempt オブジェクト

最新の HTTP 試行 (存在する場合) ：レスポンスのステータスコード、レイテンシ、トランスポートエラー、トリガー、および時刻。

deliveries[].lastAttempt.id 文字列

Webhook配信試行の識別子。

deliveries[].lastAttempt.deliveryId 文字列

この試行に関連付けられた安定した配信識別子。

deliveries[].lastAttempt.trigger 文字列

この配達試行が送信された理由。許容される値: automatic、manual。

deliveries[].lastAttempt.responseStatusCode 整数

POSTでHTTPレスポンスが返されなかった場合 (トランスポートエラー、タイムアウト) は未設定になります。

deliveries[].lastAttempt.latencyMs 整数

配信試行のレイテンシ (ミリ秒) 。

deliveries[].lastAttempt.errorMessage 文字列

HTTPレスポンスがない場合のトランスポートエラーの詳細。そうでない場合は空です。

deliveries[].lastAttempt.attemptedAt 文字列

この配信試行のRFC 3339タイムスタンプ。

nextPageToken 文字列

次のページ用の不透明なカーソル。次のページがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/app/webhook/deliveries' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "deliveries": [    {      "id": "whd_01k2ja2000e0080000000000j9",      "event": {        "id": "evt_01k2ja2000e0080000000000r5",        "type": "pull_request.created"      },      "installation": {        "id": "inst_01k2ja2000e0080000000000b2",        "target": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      },      "createdAt": "2026-08-01T09:30:00Z",      "deliveredAt": "2026-08-02T14:45:05Z",      "lastAttempt": {        "id": "wha_01k2ja2000e0080000000000k0",        "deliveryId": "whd_01k2ja2000e0080000000000j9",        "trigger": "automatic",        "responseStatusCode": 200,        "latencyMs": 182,        "attemptedAt": "2026-08-02T14:45:05Z"      }    }  ]}

Webhook配信を一括再配信

POST/v1/origin/app/webhook/deliveries:batchRedeliver

AuthApp JWT

Origin に配信を再送するよう要求します。

リクエスト本文

deliveryIds 配列必須

レスポンスフィールド

results 配列

受け付けられた非同期再配信の結果です。一意の配信 ID ごとに1件で、結果は queued、already_in_flight、または not_found です。

results[].deliveryId 文字列

このバッチ結果に対応する、リクエストされた安定した配信 ID です。

results[].outcome 文字列

curl --request POST \  --url 'https://api.cursor.com/v1/origin/app/webhook/deliveries:batchRedeliver' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "deliveryIds": [    "whd_01k2ja2000e0080000000000j9"  ]}'

レスポンスの構造:

{  "results": [    {      "deliveryId": "whd_01k2ja2000e0080000000000j9",      "outcome": "queued"    }  ]}

Webhook Ping

POST/v1/origin/app/webhook/pings

AuthApp JWT

認証済みアプリの webhook URL にテスト配信を送信し、受信側からの応答を返します。

実際のイベントを待たずに、アプリの設定中に受信側を確認できます。認証済みアプリを取得と同様に、app signing-JWT による認証が必要です。

リクエスト本文

リクエストにフィールドはありません。空の JSON オブジェクトを送信します。

レスポンスフィールド

deliveryId 文字列

テスト配信の webhook-id。受信側に送信されたヘッダーの値と一致します。

eventId 文字列

署名付きエンベロープ内のイベント ID。event.id と同じ値です。

delivered boolean

配信タイムアウト前に受信側が 2xx ステータスで応答した場合は true。常に含まれます。

responseStatusCode integer

受信側から返された HTTP ステータス。接続失敗またはタイムアウトにより応答がなかった場合は 0。常に含まれます。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/app/webhook/pings' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{}'

レスポンスの構造:

{  "deliveryId": "whd_01k2ja2000e0080000000000j9",  "eventId": "evt_01k2ja2000e0080000000000r5",  "delivered": true,  "responseStatusCode": 200}

アプリを取得

GET/v1/origin/apps/{appId}

Scopenamespace:apps:readAuthUser access token

パスパラメータ

appId string 必須

app_ のプレフィックスが付いたアプリの identifier。

レスポンスフィールド

id string

app_ のプレフィックスが付いた、グローバルに一意なアプリの identifier。

displayName string

ユーザーに表示されるアプリ名。

webhookUrl string

アプリの webhook deliveries を受信する、登録済みの HTTPS URL。アプリが deliveries を受信しない場合は空になります。

events array

アプリに設定された webhook event の subscriptions。installation.* イベントは常に配信され、ここには表示されません。

createdAt string

アプリ作成時の RFC 3339 タイムスタンプ。

updatedAt string

アプリの metadata が最後に更新された RFC 3339 タイムスタンプ。

installationRedirectUris array

OAuth インストール callback の許可リスト。アプリ起点のインストールが戻り先にできるリダイレクト URI で、authorize 時に完全一致で照合されます。

namespaceSlug string

アプリを所有する namespace の slug。

description string

publisher が指定したアプリの説明。未設定の場合は空になります。

websiteUrl string

publisher のウェブサイト。未設定の場合は空になります。

defaultScopes array

アプリのインストール時に提示されるデフォルトの scopes。catalog の scope の string で表されます。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/apps/{appId}' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "app_01k2ja2000e0080000000000a1",  "displayName": "CI Status Bot",  "webhookUrl": "https://ci.acme.dev/webhooks/origin",  "events": [    "pull_request.created",    "pull_request.merged"  ],  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "installationRedirectUris": [    "https://ci.acme.dev/origin/setup"  ],  "namespaceSlug": "acme",  "description": "Posts CI status on pull requests.",  "websiteUrl": "https://ci.acme.dev",  "defaultScopes": [    "repository:contents:read",    "repository:pull_requests:read"  ]}

アプリの更新

PATCH/v1/origin/apps/{appId}

Scopeapp:settings:writeAuthUser access token

パスパラメータ

appId string 必須

アプリの識別子。app_ のプレフィックスが付きます。

リクエスト本文

displayName string

ユーザーに表示される新しいアプリ名。指定する場合は空にできません。

webhookUrl string

events オブジェクト

Webhook イベントのサブスクリプションを完全に置き換えます。省略した場合は変更されません。

events.events 配列

description string

新しいアプリの説明。省略した場合は変更されません。空文字列を指定するとクリアされます。

websiteUrl string

新しいパブリッシャーのウェブサイト。省略した場合は変更されません。空の文字列を指定すると設定が解除されます。

installationRedirectUris object

OAuth インストールコールバックの許可リストを完全に置き換えます。省略した場合は変更されません。

installationRedirectUris.installationRedirectUris 配列

新しい許可リストの全体。空のリストを指定すると許可リストが解除されます。

defaultScopes オブジェクト

アプリのデフォルトのインストールスコープを丸ごと置き換えます。変更しない場合は省略してください。

defaultScopes.scopes 配列

デフォルトのインストールスコープの新しい完全なセット。空のリストを指定すると設定が解除されます。

レスポンスフィールド

id string

グローバルに一意なアプリ識別子。app_ のプレフィックスが付きます。

displayName string

ユーザーに表示されるアプリ名。

webhookUrl string

アプリの Webhook 配信を受信する、登録済みの HTTPS URL。アプリが配信を受信しない場合は空になります。

events 配列

アプリに設定されている Webhook イベントのサブスクリプション。installation.* イベントは常に配信され、ここには表示されません。

createdAt string

app の作成日時を示す RFC 3339 形式のタイムスタンプ。

updatedAt string

アプリのメタデータが最後に更新された日時の RFC 3339 タイムスタンプ。

installationRedirectUris 配列

namespaceSlug string

app を所有する namespace の slug。

description string

パブリッシャーが提供するアプリの説明。未設定の場合は空。

websiteUrl string

出版元のウェブサイト。未設定の場合は空になります。

defaultScopes 配列

アプリのインストール時に提供されるデフォルトのスコープ。カタログのスコープ文字列で指定します。

curl --request PATCH \  --url 'https://api.cursor.com/v1/origin/apps/APP_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "webhookUrl": "https://ci.acme.dev/webhooks/origin-v2",  "events": {    "events": [      "pull_request.created",      "pull_request.merged",      "repository.pushed"    ]  }}'

レスポンスの構造:

{  "id": "app_01k2ja2000e0080000000000a1",  "displayName": "CI Status Bot",  "webhookUrl": "https://ci.acme.dev/webhooks/origin-v2",  "events": [    "pull_request.created",    "pull_request.merged",    "repository.pushed"  ],  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "installationRedirectUris": [    "https://ci.acme.dev/origin/setup"  ],  "namespaceSlug": "acme",  "description": "Posts CI status on pull requests.",  "websiteUrl": "https://ci.acme.dev",  "defaultScopes": [    "repository:contents:read",    "repository:pull_requests:read"  ]}

アプリの署名キーを追加

POST/v1/origin/apps/{appId}/signing_keys

Scopeapp:settings:writeAuthUser access token

パスパラメータ

appId 文字列 Required

app_ のプレフィックスが付いたアプリの識別子。

リクエスト本文

publicKey 文字列 Required

アプリの署名キーセットに追加する PEM SPKI 形式の Ed25519 公開鍵。

レスポンスフィールド

kid 文字列

キー ID：キーの SPKI DER エンコーディングの SHA-256 ダイジェストを base64url でエンコードした値。JWT の kid header や、キーの失効に使用します。

createdAt 文字列

キーが登録された日時を示す RFC 3339 形式のタイムスタンプ。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/apps/APP_ID/signing_keys' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "publicKey": "-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEAq9zTf3hL6wXe1cVj0bYs5mKR8uDnG2oAaPp4NiEkKlM=\n-----END PUBLIC KEY-----"}'

レスポンスの構造:

{  "kid": "3q2xW9dK5fJm8vB1nY6cT0aZrQpLh4eGkVsN7uMxOdI",  "createdAt": "2026-08-02T14:45:00Z"}

アプリの署名キーを取り消す

DELETE/v1/origin/apps/{appId}/signing_keys/{kid}

Scopeapp:settings:writeAuthUser access token

パスパラメータ

appId 文字列必須

app_ のプレフィックスが付いたアプリの識別子。

kid 文字列必須

取り消す署名キーのキー ID。

レスポンスフィールド

リクエストが成功した場合、レスポンス本文は返されません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/apps/{appId}/signing_keys/{kid}' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンス:

204 No Content

List 名前空間 Apps

GET/v1/origin/namespaces/{namespaceSlug}/apps

Scopenamespace:apps:readAuthUser access token

パスパラメータ

namespaceSlug 文字列 Required

app を一覧する名前空間の slug。

Query Parameters

pageSize integer

返す app の最大数。未設定または 0 の場合は 30 になります。100 を超える値は 100 に制限されます。

pageToken 文字列

前回のレスポンスの next_page_token から得られる不透明なカーソル。最初のページでは空です。

レスポンスフィールド

apps 配列

名前空間が所有する app の 1 ページ分。

apps[].id 文字列

グローバルに一意な app 識別子。app_ のプレフィックスが付きます。

apps[].displayName 文字列

ユーザーに表示される app 名。

apps[].description 文字列

publisher が指定した description。未設定の場合は空です。

nextPageToken 文字列

次のページ用の不透明なカーソル。これ以上ページがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/namespaces/{namespaceSlug}/apps' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "apps": [    {      "id": "app_01k2ja2000e0080000000000a1",      "displayName": "CI Status Bot",      "description": "Posts CI status on pull requests."    },    {      "id": "app_01k2ja2000e0080000000000a2",      "displayName": "Deploy Bot",      "description": ""    }  ],  "nextPageToken": ""}

アプリの作成

POST/v1/origin/namespaces/{namespaceSlug}/apps

Scopenamespace:apps:createAuthUser access token

パスパラメータ

namespaceSlug string 必須

アプリを所有する名前空間のスラッグ。

リクエストボディ

displayName string 必須

ユーザーに表示されるアプリ名。空にすることはできません。

publicKey string 必須

アプリの署名キーペアの PEM SPKI 形式 Ed25519 公開鍵。アプリの署名キーを生成するを参照してください。

webhookUrl string

アウトバウンドウェブフックの配信先URL (絶対HTTPS URL) 。空の場合、アプリはウェブフックの配信を受け取りません。

events 配列

description string

アプリの簡単な説明。

websiteUrl string

出版社のウェブサイト。絶対HTTPS URLで指定します。

installationRedirectUris 配列

OAuth インストールコールバックの許可リスト: フラグメントを含まない絶対 HTTPS URI で、承認時に完全一致で照合されます。

defaultScopes 配列

レスポンスフィールド

id string

グローバルに一意なアプリ識別子。app_ プレフィックスが付きます。

displayName string

ユーザーに表示されるアプリ名。

webhookUrl string

アプリのWebhook配信を受信する、登録済みのHTTPS URLです。アプリが配信を受信しない場合は空です。

events 配列

アプリに設定されているWebhookイベントのサブスクリプションです。installation.*イベントは常に配信され、ここには表示されません。

createdAt string

app の作成日時を示す RFC 3339 形式のタイムスタンプ。

updatedAt string

app のメタデータが最後に更新された日時 (RFC 3339 形式のタイムスタンプ) 。

installationRedirectUris 配列

OAuthインストールコールバックの許可リスト: アプリ起点のインストールがリダイレクト先として使用できるURI。認可時に完全一致で照合されます。

namespaceSlug string

アプリを所有するネームスペースのスラッグ。

description string

パブリッシャーが提供するアプリの説明。未設定の場合は空です。

websiteUrl string

パブリッシャーのウェブサイト。未設定の場合は空です。

defaultScopes 配列

アプリのインストール時に提供されるデフォルトのスコープ。カタログのスコープ文字列で指定します。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/namespaces/NAMESPACE_SLUG/apps' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "displayName": "CI Status Bot",  "publicKey": "-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEAv7wFoV1bC9yKq3nZ8dQmXh5uJb2tR4sEwG6aP0iN8kY=\n-----END PUBLIC KEY-----",  "webhookUrl": "https://ci.acme.dev/webhooks/origin",  "events": [    "pull_request.created",    "pull_request.merged"  ],  "description": "Posts CI status on pull requests.",  "websiteUrl": "https://ci.acme.dev",  "installationRedirectUris": [    "https://ci.acme.dev/origin/setup"  ],  "defaultScopes": [    "repository:contents:read",    "repository:pull_requests:read"  ]}'

レスポンスの構造:

{  "id": "app_01k2ja2000e0080000000000a1",  "displayName": "CI Status Bot",  "webhookUrl": "https://ci.acme.dev/webhooks/origin",  "events": [    "pull_request.created",    "pull_request.merged"  ],  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-01T09:30:00Z",  "installationRedirectUris": [    "https://ci.acme.dev/origin/setup"  ],  "namespaceSlug": "acme",  "description": "Posts CI status on pull requests.",  "websiteUrl": "https://ci.acme.dev",  "defaultScopes": [    "repository:contents:read",    "repository:pull_requests:read"  ]}

アプリインストール用リポジトリを追加する

POST/v1/origin/namespaces/{namespaceSlug}/installations/{installationId}/repos

Scopenamespace:installations:writeAuthUser access token

パスパラメータ

namespaceSlug string 必須

インストールが属する名前空間の slug。

installationId 文字列必須

インストール識別子。

リクエスト本文

repoIds 配列必須

レスポンスフィールド

id 文字列

アプリが保存し、インストールアクセストークンの発行に使用するインストール識別子。

appId 文字列

インストール済みアプリの識別子。

target オブジェクト

このインストールに対して顧客が選択した所有者。

target.slug 文字列

所有者 ID とともにリポジトリの所有者を識別するために使用される、URL 用の所有者スラッグ。

target.id 文字列

オリジンの所有者識別子。

target.type 文字列

オーナーの namespace の種類。出力専用。使用可能な値: team、user。不明な場合は省略されます。

createdAt 文字列

RFC 3339 形式のインストール作成タイムスタンプ。

updatedAt 文字列

インストールの最終更新日時を示す RFC 3339 形式のタイムスタンプ。

repoSelectionMode 文字列

リポジトリの権限付与モード。all または selected のいずれか。

scopes 配列

インストールで承認されたスコープ。

installedBy オブジェクト

installedBy.id 文字列

ユーザーの公開識別子。接頭辞は user_ です。

installedBy.email 文字列

ユーザーのメールアドレス。

installedBy.displayName 文字列

installedBy.handle 文字列

suspendedAt 文字列

インストールが一時停止中に設定されたRFC 3339タイムスタンプ。インストールが有効なときは省略されます。

deletedAt 文字列

curl --request POST \  --url 'https://api.cursor.com/v1/origin/namespaces/NAMESPACE_SLUG/installations/INSTALLATION_ID/repos' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "repoIds": [    "repo_01k2ja2000e0080000000000q4",    "repo_01k2ja2000e0080000000000q5"  ]}'

レスポンスの構造:

{  "id": "inst_01k2ja2000e0080000000000b2",  "appId": "app_01k2ja2000e0080000000000a1",  "target": {    "slug": "acme",    "id": "ns_01k2ja2000e0080000000000p3",    "type": "team"  },  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "repoSelectionMode": "selected",  "scopes": [    "repository:contents:read",    "repository:pull_requests:read",    "repository:metadata:read"  ]}

リポジトリ

cloneUrlは出力専用のHTTPSクローンURLです。Get RepoのレスポンスにはcloneUrlが含まれます。

名前空間の一覧取得

GET/v1/origin/namespaces

AuthUser access token

リポジトリを一覧取得できる名前空間を、slug 順に一覧表示します。

クエリパラメータ

pageSize integer

返す名前空間の最大数。未設定または 0 の場合はデフォルトの 30 になります。100 を超える値は 100 に制限されます。

pageToken string

レスポンスフィールド

namespaces array

リポジトリを一覧取得できる名前空間 (slug 順) 。

namespaces[].namespace object

名前空間の所有者への参照。

namespaces[].namespace.slug string

URL で使用される所有者の slug。List Repos の ownerSlug として使用します。

namespaces[].namespace.id string

Origin の所有者識別子。

namespaces[].namespace.type string

オーナーの namespace の種類。出力専用。使用可能な値：team、user。不明な場合は省略されます。

namespaces[].viewerCanCreateRepositories boolean

この名前空間で Create Repo を実行した場合に、認可チェック、および所有者のプランと設定に関するチェックを通過できるかどうか。

nextPageToken string

次のページを取得するための不透明なカーソル。次のページがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/namespaces' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造：

{  "namespaces": [    {      "namespace": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      },      "viewerCanCreateRepositories": true    },    {      "namespace": {        "slug": "jane",        "id": "ns_01k2ja2000e0080000000000p4",        "type": "user"      },      "viewerCanCreateRepositories": false    }  ]}

リポジトリ一覧

GET/v1/origin/repos/{ownerSlug}

Scopenamespace:repositories:readAuthUser access token

オーナーエンティティに属するリポジトリを一覧表示します。

パスパラメータ

ownerSlug 文字列必須

親所有エンティティのスラッグ。

クエリパラメータ

pageSize 整数

返却するリポジトリの最大数。未設定または0の場合はデフォルトで30になります。100を超える値は100に制限されます。

pageToken 文字列

filter 文字列

大文字小文字を区別しない任意の部分文字列フィルター。

レスポンスフィールド

repositories 配列

指定された所有者に属するリポジトリ。

repositories[].id 文字列

オリジンリポジトリの識別子。

repositories[].name 文字列

所有者内のリポジトリ名。

repositories[].fullName 文字列

acme/api のような、オーナー名とリポジトリ名を組み合わせたもの。

repositories[].owner オブジェクト

リポジトリの所有者参照。

repositories[].owner.slug 文字列

オーナーIDと組み合わせてリポジトリのオーナーを識別する、URL 表示用のオーナースラッグ。

repositories[].owner.id 文字列

Originオーナーの識別子。

repositories[].owner.type 文字列

所有者名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

repositories[].defaultBranch 文字列

リポジトリのデフォルトブランチ名。

repositories[].createdAt 文字列

RFC 3339形式のリポジトリ作成タイムスタンプ。

repositories[].updatedAt 文字列

RFC 3339形式のリポジトリ更新タイムスタンプ。

repositories[].pushedAt 文字列

完全なリポジトリのレスポンスに表示される、最新のプッシュの RFC 3339 タイムスタンプ。

repositories[].cloneUrl 文字列

出力専用の HTTPS クローン URL。get-repository レスポンスに含まれます。

repositories[].mirror オブジェクト

ミラーのメタデータ。ネイティブリポジトリの場合や、ミラーの初回同期が完了していない間は存在しません。

repositories[].mirror.source 文字列

ミラー元。指定可能な値: github。

repositories[].mirror.sourceId 文字列

ソースによって割り当てられた不透明なリポジトリ識別子。

repositories[].mirror.status 文字列

移行中 (カットオーバー完了まで) の実効的なミラー方向。許容値: inbound、outbound。

repositories[].visibility 文字列

リポジトリの可視性。許容値: internal、private。

repositories[].allowMergeCommit boolean

プルリクエストをマージコミットとしてマージできるかどうか。

repositories[].allowSquashMerge ブール値

プルリクエストをスカッシュマージでマージできるかどうか。

repositories[].deleteBranchOnMerge ブール値

マージ時にヘッドブランチが自動的に削除されるかどうか。

nextPageToken 文字列

次のページ用の不透明なカーソル。これ以上ページがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "repositories": [    {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "fullName": "acme/rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      },      "defaultBranch": "main",      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "pushedAt": "2026-08-02T14:45:00Z",      "cloneUrl": "https://origin.cursor.com/git/acme/rocket.git"    }  ]}

Get Repo

GET/v1/origin/repos/{ownerSlug}/{repoName}

Scoperepository:metadata:readAuthInstallation tokenUser access token

(owner_id, name) 識別子で指定した単一のリポジトリを返します。

cloneUrl は出力専用の HTTPS クローン URL です。リポジトリの取得結果には cloneUrl が含まれます。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

レスポンスフィールド

id 文字列

Origin リポジトリ識別子。

name 文字列

所有者内のリポジトリ名。

fullName 文字列

acme/api などの、オーナー名とリポジトリ名を組み合わせた名前。

owner オブジェクト

リポジトリの所有者参照。

owner.slug 文字列

リポジトリのオーナーを識別するために、オーナー ID と共に使用される URL 表示用のオーナースラッグ。

owner.id 文字列

Origin オーナー識別子。

owner.type 文字列

オーナーの名前空間タイプ。出力専用。指定可能な値: team, user。不明な場合は省略されます。

defaultBranch 文字列

リポジトリのデフォルトブランチ名。

createdAt 文字列

RFC 3339 形式のリポジトリ作成タイムスタンプ。

updatedAt 文字列

RFC 3339 形式のリポジトリ更新タイムスタンプ。

pushedAt 文字列

リポジトリの完全なレスポンスに表示される、最新のプッシュの RFC 3339 タイムスタンプ。

cloneUrl 文字列

出力専用の HTTPS クローン URL。get-repository のレスポンスに含まれます。

mirror オブジェクト

ミラーのメタデータ。ネイティブリポジトリの場合、またはミラーの初回同期が準備できる前は存在しません。

mirror.source 文字列

ミラー元。指定可能な値: github。

mirror.sourceId 文字列

ソースによって割り当てられる不透明なリポジトリ識別子。

mirror.status 文字列

移行中 (カットオーバー完了まで) の有効なミラー方向。指定可能な値: inbound、outbound。

visibility 文字列

リポジトリの可視性。指定可能な値: internal、private。

allowMergeCommit ブール値

プルリクエストをマージコミットとして取り込めるかどうか。

allowSquashMerge ブール値

プルリクエストをスカッシュマージでマージできるかどうか。

deleteBranchOnMerge boolean

マージ時にヘッドブランチを自動的に削除するかどうか。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "repo_01k2ja2000e0080000000000q4",  "name": "rocket",  "fullName": "acme/rocket",  "owner": {    "slug": "acme",    "id": "ns_01k2ja2000e0080000000000p3",    "type": "team"  },  "defaultBranch": "main",  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "pushedAt": "2026-08-02T14:45:00Z",  "cloneUrl": "https://origin.cursor.com/git/acme/rocket.git"}

リポジトリを更新

PATCH/v1/origin/repos/{ownerSlug}/{repoName}

Scoperepository:settings:writeAuthInstallation tokenUser access token

リポジトリの設定を更新します。省略したフィールドは変更されず、設定可能なフィールドを少なくとも 1 つ指定する必要があります。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

リクエスト本文

defaultBranch string

allowMergeCommit boolean

allowSquashMerge boolean

deleteBranchOnMerge boolean

visibility string

変更後のリポジトリの可視性。指定可能な値: internal、private。可視性を変更しない場合は省略します。

レスポンスフィールド

id string

Origin リポジトリ識別子。

name string

所有者内でのリポジトリ名。

fullName string

acme/api のような、所有者名とリポジトリ名を組み合わせた名前。

owner object

リポジトリ所有者のリファレンス。

owner.slug string

リポジトリ所有者を識別するために所有者IDと組み合わせて使用される、URL 表示用の所有者スラッグ。

owner.id string

オリジン所有者識別子。

owner.type string

オーナーの namespace の種類。出力専用。指定可能な値: team、user。不明な場合は省略されます。

defaultBranch string

リポジトリのデフォルトブランチ名。

createdAt string

RFC 3339形式のリポジトリ作成タイムスタンプ。

updatedAt string

RFC 3339 形式のリポジトリ更新タイムスタンプ。

pushedAt string

完全なリポジトリ応答に表示される最新のプッシュのRFC 3339タイムスタンプ。

cloneUrl string

出力専用の HTTPS クローン URL。get-repository のレスポンスに含まれます。

mirror mirror オブジェクト

ミラーのメタデータ。ネイティブリポジトリの場合、およびミラーの初回同期が完了する前は含まれません。

mirror.source string

ミラー元。指定可能な値: github。

mirror.sourceId string

ソースによって割り当てられる不透明なリポジトリ識別子。

mirror.status string

移行中 (切り替えが完了するまで) の有効なミラー方向。許可される値: inbound、outbound。

visibility string

リポジトリの可視性。指定可能な値: internal、private。

allowMergeCommit boolean

プルリクエストをマージコミットとして取り込めるかどうか。

allowSquashMerge boolean

プルリクエストをスカッシュマージとして適用できるかどうか。

deleteBranchOnMerge boolean

マージ時にヘッドブランチが自動的に削除されるかどうか。

curl --request PATCH \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "defaultBranch": "main",  "allowMergeCommit": false,  "allowSquashMerge": true,  "deleteBranchOnMerge": true,  "visibility": "private"}'

レスポンスの構造:

{  "id": "repo_01k2ja2000e0080000000000q4",  "name": "rocket",  "fullName": "acme/rocket",  "owner": {    "slug": "acme",    "id": "ns_01k2ja2000e0080000000000p3",    "type": "team"  },  "defaultBranch": "main",  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "pushedAt": "2026-08-02T14:45:00Z",  "cloneUrl": "https://origin.cursor.com/git/acme/rocket.git",  "visibility": "private",  "allowMergeCommit": false,  "allowSquashMerge": true,  "deleteBranchOnMerge": true}

リポジトリを作成

POST/v1/origin/repos/{ownerSlug}

Scopenamespace:repositories:createAuthUser access token

オーナーに属するリポジトリを作成します。

パスパラメータ

ownerSlug 文字列必須

親オーナーエンティティのスラッグ。

リクエスト本文

name 文字列必須

オーナー内で一意のリポジトリ名。作成時に必須です。

defaultBranch 文字列

レスポンスフィールド

id 文字列

Origin リポジトリ識別子。

name 文字列

所有者内のリポジトリ名。

fullName 文字列

acme/api などの、オーナー名とリポジトリ名を組み合わせた名前。

owner オブジェクト

リポジトリのオーナー参照。

owner.slug 文字列

リポジトリのオーナーを識別するためにオーナーIDと共に使用される、URL表示用のオーナースラッグ。

owner.id 文字列

Origin オーナー識別子。

owner.type 文字列

オーナーの namespace タイプ。出力専用。許容値: team、user。不明な場合は省略されます。

defaultBranch 文字列

リポジトリのデフォルトブランチ名。

createdAt 文字列

RFC 3339 形式のリポジトリ作成タイムスタンプ。

updatedAt 文字列

RFC 3339 準拠のリポジトリ更新タイムスタンプ。

pushedAt 文字列

完全なリポジトリ応答に表示される最新のプッシュの RFC 3339 タイムスタンプ。

cloneUrl 文字列

出力専用の HTTPS クローンの URL。get-repository のレスポンスに含まれます。

mirror オブジェクト

ミラーのメタデータ。ネイティブリポジトリの場合およびミラーの初回同期が準備できる前は存在しません。

mirror.source 文字列

ミラー元。指定できる値は github のみです。

mirror.sourceId 文字列

ソースによって割り当てられた不透明なリポジトリ識別子。

mirror.status 文字列

切替が完了するまでの遷移中に有効なミラーの方向。許容値: inbound、outbound。

visibility 文字列

リポジトリの可視性。許容値: internal、private。

allowMergeCommit ブール値

プルリクエストをマージコミットとして取り込めるかどうか。

allowSquashMerge ブール値

プルリクエストを squash merge としてマージできるかどうか。

deleteBranchOnMerge boolean

マージ時にヘッドブランチが自動的に削除されるかどうか。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "name": "rocket",  "defaultBranch": "main"}'

レスポンスの構造:

{  "id": "repo_01k2ja2000e0080000000000q4",  "name": "rocket",  "fullName": "acme/rocket",  "owner": {    "slug": "acme",    "id": "ns_01k2ja2000e0080000000000p3",    "type": "team"  },  "defaultBranch": "main",  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "pushedAt": "2026-08-02T14:45:00Z",  "cloneUrl": "https://origin.cursor.com/git/acme/rocket.git"}

ブランチ一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/branches

Scoperepository:contents:readAuthInstallation tokenUser access token

リポジトリのブランチとその先端コミットを名前の昇順で取得します。page_size と page_token によるページネーションに対応しています。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

クエリパラメータ

pageSize integer

返すブランチの最大数。未指定または0の場合、デフォルトは30です。100を超える値は100に制限されます。

pageToken 文字列

レスポンスフィールド

branches 配列

ブランチ名と先端コミットのSHAを含む、ページネーションされたブランチレコード。

branches[].name 文字列

ブランチ名。

branches[].commit オブジェクト

ブランチの先端にあるコミット。

branches[].commit.sha 文字列

ブランチの先端にあるコミットの完全な16進数SHA。

nextPageToken 文字列

次のページの不透明なカーソル。これ以上ページがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/branches' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "branches": [    {      "name": "main",      "commit": {        "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"      }    }  ]}

リポジトリの Tarball を取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/tarball/{ref}

Scoperepository:contents:readAuthInstallation tokenUser access token

ref 時点のリポジトリツリーを gzip 圧縮された tar としてダウンロードします。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

ref 文字列必須

レスポンスフィールド

sha 文字列

downloadUrl 文字列

curl --request GET --location --output repo.tar.gz \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/tarball/HEAD' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "downloadUrl": "https://artifacts.origin.cursor.com/tarballs/0192f7a4-6c1e-7b3a-9f21-3d54c9a7e6b0/9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4.tar.gz?Expires=1767225600&Signature=EXAMPLE&Key-Pair-Id=KEXAMPLE123",  "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"}

ミラーを同期

POST/v1/origin/repos/{ownerSlug}/{repoName}:syncMirror

Scoperepository:contents:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

リクエスト本文

ref 文字列必須

wait boolean

true の場合、同期が完了するか待機時間の上限に達するまでブロックします。デフォルトは false です。

sha 文字列

レスポンスフィールド

synced boolean

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME:syncMirror' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "ref": "refs/heads/main",  "wait": true}'

レスポンスの構造:

{  "synced": true}

ミラーの移行に関するエンドポイントは Origin Migration API に記載されています。ミラーを同期はこのページに残ります。

ミラーリポジトリを切断

ミラーリポジトリを切断を参照してください。

ミラー移行ジョブを取得

ミラー移行ジョブを取得を参照してください。

有効なミラー移行ジョブを取得

有効なミラー移行ジョブを取得を参照してください。

ミラーリポジトリのカットオーバーを強制

Force Repo Mirror を参照してください。

ミラーリポジトリを移行

Transition Repo Mirror を参照してください。

チェック

初回の実行のupsertでは、対応するスイートが自動的に作成されます。
必須チェックは、インストール元のアプリとスイートのkey、必要に応じて実行のkeyによって照合されます。nameは表示専用で、照合には使用されません。
必須チェックの設定ではkey値が照合に使用されるため、試行をまたいでkey値を安定させ、ユーザーにとってわかりやすい値にしてください。
試行を更新するにはexternalIdを再利用します (その試行の以前の結果は破棄されます) 。再試行には新しいexternalIdを使用すると、以前の試行が履歴として残ります。
人間が読みやすい結果にはcheckRun.outputを使用します。
- title：255文字以内の短い結果見出し。
- summary：65,535 UTF-8バイト以内の主要なMarkdown要約。
- text：65,535 UTF-8バイト以内の詳細なMarkdown情報。
プロバイダーの外部結果ページへのリンクにはdetailsUrlを使用します。

チェック実行後

POST/v1/origin/repos/{ownerSlug}/{repoName}/check-runs

Scoperepository:checks:writeAuthInstallation token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

リポジトリ名。所有者エンティティ内で一意です。

リクエスト本文

headSha string 必須

チェック実行の報告対象となるHEADコミットのSHA (40桁または64桁の16進数) 。

checkSuite オブジェクト必須

チェック実行が属するスイート。チェック実行とともにアップサートされます。

checkSuite.key string 必須

試行をまたいで論理スイートを識別する、アプリが選択した安定したキー。

checkSuite.name string 必須

ユーザー向けに表示されるスイート名。

checkSuite.detailsUrl string

スイート全体の詳細情報への任意のリンク。

checkSuite.externalId string 必須

このスイート試行に対してプロバイダーが割り当てた不変の識別子。

checkRun オブジェクト必須

アップサートするチェック実行。

checkRun.key string 必須

複数回の試行にまたがってその論理チェックを識別する、アプリが選択した安定したキー。

checkRun.name string 必須

ユーザー向けに表示されるチェック実行の名前。

checkRun.status string 必須

checkRun.conclusion string

checkRun.externalUpdatedAt string 必須

外部システムの最終更新時刻。並行する更新の順序を決めるために使用され、古い再試行が新しい状態を上書きできないようにします。

checkRun.startedAt 文字列

チェック実行の開始時刻。現在より60秒を超えて先の値を指定すると、InvalidArgument (HTTP 400) が返されます。

checkRun.completedAt string

checkRun.detailsUrl 文字列

この特定のチェック実行の詳細への任意のリンク (例：プロバイダーのジョブ／ビルド URL) 。

checkRun.externalId string 必須

このチェック試行に対してプロバイダーが割り当てた不変の識別子。

checkRun.output object

このチェックの実行に対する人間が読みやすい出力。

checkRun.output.title string

出力の短い見出し。最大長: 255文字。

checkRun.output.summary string

出力の概要。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRun.output.text string

詳細な出力。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRun.deadlineAt string

checkRun.isRerequestable boolean

レスポンスフィールド

checkSuite オブジェクト

作成または更新されたチェックスイート。

checkSuite.id string

サーバー割り当てのチェックスイート識別子。

checkSuite.repository オブジェクト

スイートのリポジトリ参照。

checkSuite.repository.id string

コンテナ参照内のリポジトリ識別子。

checkSuite.repository.name string

コンテナ参照内のリポジトリ名。

checkSuite.repository.owner オブジェクト

リポジトリの所有者参照。

checkSuite.repository.owner.slug string

リポジトリの所有者を識別するために owner ID とともに使用される、URL 表示用の所有者スラッグ。

checkSuite.repository.owner.id string

発生元の所有者識別子。

checkSuite.repository.owner.type string

所有者の名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

checkSuite.sha string

スイートが紐づくコミットの SHA。

checkSuite.key string

アプリが選択した「stable」必須チェックの識別子。この必須チェックは名前ではなく、アプリとこのキーの組み合わせで照合されます。

checkSuite.name string

表示専用のスイート名です。必須チェックの照合には使用されません。

checkSuite.detailsUrl string

プロバイダーのスイートレベルの結果への任意のリンク。

checkSuite.createdAt string

スイート作成時の RFC 3339 タイムスタンプ。

checkSuite.updatedAt string

最新のスイート更新時刻を示すRFC 3339タイムスタンプ。

checkSuite.externalId string

このスイート試行のプロバイダー識別子。

checkSuite.actor オブジェクト

スイートを作成したパブリックアクター。

checkSuite.actor.user object

アクターのユーザー版。ユーザーが操作を行ったときに設定されます。

checkSuite.actor.user.id string

ユーザーの公開識別子。

checkSuite.actor.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

checkSuite.actor.user.displayName string

checkSuite.actor.user.handle string

checkSuite.actor.app オブジェクト

アクターのアプリバリアント。アプリが操作を実行したときに設定されます。

checkSuite.actor.app.id 文字列

アプリの公開識別子。

checkSuite.actor.app.displayName string

アプリに登録された表示名。アプリを解決できない場合や Cherri Code のファーストパーティ管理アクターの場合は省略されます。

checkSuite.actor.serviceAccount オブジェクト

アクターのサービスアカウント版。サービスアカウントが操作を実行したときに設定されます。

checkSuite.actor.serviceAccount.id string

サービスアカウントの公開識別子。

checkRun オブジェクト

アップサートされたチェック実行。

checkRun.id string

サーバーが割り当てたチェック実行の識別子。

checkRun.repository オブジェクト

実行のリポジトリ参照。

checkRun.repository.id string

コンテナ参照内のリポジトリ識別子。

checkRun.repository.name string

コンテナ参照内のリポジトリ名。

checkRun.repository.owner オブジェクト

リポジトリの所有者参照。

checkRun.repository.owner.slug string

リポジトリの所有者を識別するために owner ID とともに使用される、URL 表示用の所有者スラッグ。

checkRun.repository.owner.id string

Origin の所有者識別子。

checkRun.repository.owner.type string

所有者の名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

checkRun.checkSuite オブジェクト

このチェックを含むチェックスイートへの参照。

checkRun.checkSuite.id string

このチェックを含むチェックスイートにサーバーが割り当てた識別子。

checkRun.sha string

run が紐づくコミットの SHA。

checkRun.key string

アプリが選択する安定した論理実行識別子。必須チェックは、アプリ、スイートキー、およびこのキーで照合される場合があります。

checkRun.name string

表示専用の実行名です。必須チェックの照合には使用されません。

checkRun.status string

checkRun.conclusion string

checkRun.detailsUrl 文字列

プロバイダーの完全な結果ページへの個別リンク。

checkRun.externalUpdatedAt string

更新の順序付けに使用される外部更新タイムスタンプ。古い再試行が新しい状態を置き換えられないようにします。

checkRun.startedAt 文字列

提供された場合にプロバイダーが報告する RFC 3339 形式の開始時刻。

checkRun.completedAt string

提供された場合にプロバイダーが報告する RFC 3339 形式の完了時刻。

checkRun.createdAt 文字列

RFC 3339形式のラン作成タイムスタンプ。

checkRun.updatedAt string

最新の永続化された実行更新の RFC 3339 タイムスタンプ。

checkRun.externalId string

1回の試行に対するプロバイダーの識別子。該当の試行を更新するにはこれを再利用し、再試行する場合は新しい値を使用してください。

checkRun.actor オブジェクト

この実行を行ったパブリックアクター。常に、所有するチェックスイートの actor と同じです。

checkRun.actor.user オブジェクト

アクターのユーザー版。ユーザーが操作を行ったときに設定されます。

checkRun.actor.user.id string

ユーザーの公開識別子。

checkRun.actor.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

checkRun.actor.user.displayName string

checkRun.actor.user.handle string

checkRun.actor.app オブジェクト

アクターのアプリ版。アプリがアクションを実行した場合に設定されます。

checkRun.actor.app.id string

アプリの公開識別子。

checkRun.actor.app.displayName string

アプリに登録された表示名。アプリを解決できない場合や Cherri Code のファーストパーティ管理アクターの場合は省略されます。

checkRun.actor.serviceAccount オブジェクト

アクターのサービスアカウント版。サービスアカウントが操作を実行したときに設定されます。

checkRun.actor.serviceAccount.id string

サービスアカウントの公開識別子。

checkRun.output object

タイトル、要約、および提供された場合は長文を含む、人間が読める結果オブジェクト。

checkRun.output.title string

出力の短い見出し。最大長: 255文字。

checkRun.output.summary string

出力の概要。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRun.output.text string

詳細な出力。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRun.deadlineAt string

チェック実行の期限を RFC 3339 形式のタイムスタンプとして記録します。実行に期限がない場合 (実行完了後を含む) は記録されません。

checkRun.isRerequestable boolean

報告アプリがこの実行を再リクエスト可能と宣言したかどうか。

checkRun.rerequestedAt string

checkRun.rerequestedBy オブジェクト

outcome string

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/check-runs' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "checkSuite": {    "key": "ci-8842",    "name": "CI",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "externalId": "build-8842"  },  "checkRun": {    "key": "ci-8842-unit-tests",    "name": "unit-tests",    "status": "completed",    "conclusion": "success",    "externalUpdatedAt": "2026-08-02T14:44:30Z",    "startedAt": "2026-08-02T14:40:00Z",    "completedAt": "2026-08-02T14:44:30Z",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "externalId": "run-8842",    "output": {      "title": "Unit tests",      "summary": "128 tests passed.",      "text": "All suites green."    }  }}'

レスポンスの構造:

{  "checkSuite": {    "id": "crg_01k2ja2000e0080000000000h8",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    },    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "key": "ci-8842",    "name": "CI",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z",    "externalId": "build-8842",    "actor": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    }  },  "checkRun": {    "id": "cr_01k2ja2000e0080000000000g7",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    },    "checkSuite": {      "id": "crg_01k2ja2000e0080000000000h8"    },    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "key": "ci-8842-unit-tests",    "name": "unit-tests",    "status": "completed",    "conclusion": "success",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "externalUpdatedAt": "2026-08-02T14:44:30Z",    "startedAt": "2026-08-02T14:40:00Z",    "completedAt": "2026-08-02T14:44:30Z",    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z",    "externalId": "run-8842",    "actor": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    },    "output": {      "title": "単体テスト",      "summary": "128 tests passed.",      "text": "All suites green."    }  },  "outcome": "created"}

チェック実行の一括アップサート

POST/v1/origin/repos/{ownerSlug}/{repoName}/check-runs:batchUpsert

Scoperepository:checks:writeAuthInstallation token

各実行では、チェック実行を投稿と同じ任意のdeadlineAtを指定できます。

パスパラメーター

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

リクエスト本文

headSha string 必須

チェック実行の報告対象となるヘッドコミットSHA (40文字または64文字の16進数) 。

checkSuite オブジェクト必須

このリクエストの各チェック実行で共有されるスイート。

checkSuite.key 文字列必須

複数回の試行を通じて論理スイートを識別する、アプリが選択する安定したキー。

checkSuite.name string 必須

ユーザーに表示されるスイート名。

checkSuite.detailsUrl string

スイート全体の詳細情報への任意のリンク。

checkSuite.externalId string 必須

このスイート試行に対するプロバイダー割り当ての不変の識別子。

checkRuns array 必須

レスポンス順でアップサートするチェック実行。(external_id, key) が一意のエントリを1〜10件含める必要があります。

checkRuns[0].key string 必須

複数の試行にわたる論理チェックを識別する、アプリが選択する安定したキー。

checkRuns[0].name string 必須

ユーザー向けに表示されるチェックランの名前。

checkRuns[0].status string 必須

checkRuns[0].conclusion string

checkRuns[0].externalUpdatedAt string 必須

外部システムの最終更新時刻。並行する更新の順序付けに使用され、古い再試行が新しい状態を上書きできないようにします。

checkRuns[0].startedAt 文字列

チェックの実行が開始された時刻。現在より60秒を超えて先の値は InvalidArgument (HTTP 400) を返します。

checkRuns[0].completedAt string

checkRuns[0].detailsUrl string

この特定のチェック実行に関する詳細への任意のリンク (例：プロバイダーのジョブ/ビルドの URL) 。

checkRuns[0].externalId string 必須

このチェック試行に対してプロバイダーが割り当てた不変の識別子。

checkRuns[0].output オブジェクト

このチェック実行の人間が読める出力。

checkRuns[0].output.title 文字列

出力の短い見出し。最大長: 255文字。

checkRuns[0].output.summary string

出力の概要。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRuns[0].output.text string

詳細な出力。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRuns[0].deadlineAt string

checkRuns[0].isRerequestable boolean

レスポンスフィールド

checkSuite オブジェクト

返されたすべてのチェック実行で共有される永続化されたスイート。

checkSuite.id string

サーバーによって割り当てられたチェックスイートの識別子。

checkSuite.repository オブジェクト

スイートのリポジトリ参照。

checkSuite.repository.id string

コンテナ参照内のリポジトリ識別子。

checkSuite.repository.name string

コンテナ参照内のリポジトリ名。

checkSuite.repository.owner オブジェクト

リポジトリの所有者参照。

checkSuite.repository.owner.slug string

リポジトリの所有者を識別するために、所有者IDとともに使用されるURL表示用のオーナースラッグ。

checkSuite.repository.owner.id string

オリジンの所有者識別子。

checkSuite.repository.owner.type string

所有者の名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

checkSuite.sha string

スイートが紐付いているコミットの SHA。

checkSuite.key 文字列

アプリが選択する安定した必須チェックの識別子。必須チェックは名前ではなく、アプリとこのキーで照合されます。

checkSuite.name string

表示専用のスイート名です。必須チェックの照合には使用されません。

checkSuite.detailsUrl string

プロバイダーのスイートレベルの結果への任意のリンク。

checkSuite.createdAt string

RFC 3339形式のスイート作成タイムスタンプ。

checkSuite.updatedAt string

スイートの最終更新を示すRFC 3339形式のタイムスタンプ。

checkSuite.externalId string

このスイート試行のプロバイダー識別子。

checkSuite.actor オブジェクト

スイートを作成した公開アクター。

checkSuite.actor.user オブジェクト

ユーザーがアクションを実行したときに設定される、アクターのユーザー固有のバリアント。

checkSuite.actor.user.id string

ユーザーの公開識別子。

checkSuite.actor.user.email string

ユーザーのメールアドレス。user バリアントが存在する場合は常に設定されます。

checkSuite.actor.user.displayName string

checkSuite.actor.user.handle string

checkSuite.actor.app オブジェクト

アクターのアプリバリアント。アプリが操作を実行したときに設定されます。

checkSuite.actor.app.id 文字列

アプリの公開識別子。

checkSuite.actor.app.displayName string

アプリの登録表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターでは省略されます。

checkSuite.actor.serviceAccount オブジェクト

アクターのサービスアカウントのバリアント。サービスアカウントがアクションを実行したときに設定されます。

checkSuite.actor.serviceAccount.id string

サービスアカウントの公開識別子。

checkRuns 配列

非推奨: 代わりに results[].checkRun を読み取ってください。リクエスト順で引き続き設定されています。

checkRuns[].id string

サーバー割り当てのチェック実行識別子。

checkRuns[].repository オブジェクト

この実行のリポジトリ参照。

checkRuns[].repository.id string

コンテナ参照内のリポジトリ識別子。

checkRuns[].repository.name string

コンテナ参照内のリポジトリ名。

checkRuns[].repository.owner object

リポジトリの所有者参照。

checkRuns[].repository.owner.slug string

リポジトリの所有者を識別するために、所有者IDとともに使用されるURL表示用のオーナースラッグ。

checkRuns[].repository.owner.id string

Origin の所有者識別子。

checkRuns[].repository.owner.type string

所有者の名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

checkRuns[].checkSuite オブジェクト

所属するチェックスイートへの参照。

checkRuns[].checkSuite.id string

所属するチェックスイートのサーバー割り当て識別子。

checkRuns[].sha 文字列

実行に紐付けられているコミットのSHAです。

checkRuns[].key string

アプリが選択する安定した論理的実行識別子。必要なチェックはアプリ、スイートキー、およびこのキーで一致する場合があります。

checkRuns[].name string

表示専用の実行名です。必須チェックの照合には使用されません。

checkRuns[].status string

checkRuns[].conclusion string

checkRuns[].detailsUrl 文字列

プロバイダーの完全な結果ページへの個別リンク。

checkRuns[].externalUpdatedAt string

古い再試行が新しい状態を置き換えられないように、更新の順序付けに使用される外部更新タイムスタンプ。

checkRuns[].startedAt string

提供元が指定した場合の RFC 3339 形式の開始時刻。

checkRuns[].completedAt string

提供元が指定した場合の RFC 3339 形式の完了時刻。

checkRuns[].createdAt string

RFC 3339形式の実行作成タイムスタンプ。

checkRuns[].updatedAt string

最後に永続化された実行の更新を示す RFC 3339 形式のタイムスタンプ。

checkRuns[].externalId string

1回の試行に対するプロバイダーの識別子です。その試行を更新するには同じ値を再利用し、再試行する場合は新しい値を使用してください。

checkRuns[].actor オブジェクト

この実行を作成した公開アクター。常に所有するチェックスイートの actor です。

checkRuns[].actor.user オブジェクト

ユーザーがアクションを実行したときに設定される、アクターのユーザー固有のバリアント。

checkRuns[].actor.user.id 文字列

ユーザーの公開識別子。

checkRuns[].actor.user.email 文字列

ユーザーのメールアドレス。user バリアントが存在する場合は常に設定されます。

checkRuns[].actor.user.displayName string

checkRuns[].actor.user.handle string

checkRuns[].actor.app オブジェクト

アクターのアプリバリアント。アプリが操作を実行したときに設定されます。

checkRuns[].actor.app.id string

アプリの公開識別子。

checkRuns[].actor.app.displayName string

アプリの登録表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターの場合は省略されます。

checkRuns[].actor.serviceAccount オブジェクト

アクターのサービスアカウントのバリアント。サービスアカウントがアクションを実行したときに設定されます。

checkRuns[].actor.serviceAccount.id string

サービスアカウントの公開識別子。

checkRuns[].output オブジェクト

タイトル、要約、および (提供されている場合の) 詳細なテキストを含む、人間が読める結果オブジェクト。

checkRuns[].output.title string

出力の短い見出し。最大長: 255文字。

checkRuns[].output.summary string

出力の概要。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRuns[].output.text string

詳細な出力。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRuns[].deadlineAt string

チェック実行の期限。RFC 3339 形式のタイムスタンプとして記録されます。実行に期限がない場合 (完了後を含む) は存在しません。

checkRuns[].isRerequestable boolean

報告元のアプリがこの実行を再リクエスト可能と宣言しているかどうか。

checkRuns[].rerequestedAt string

checkRuns[].rerequestedBy オブジェクト

results 配列

投稿された実行ごとに1件の結果を、リクエストの順序で返します。

results[].checkRun オブジェクト

results[].outcome 文字列

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/check-runs:batchUpsert' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "checkSuite": {    "key": "ci-8842",    "name": "CI",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "externalId": "build-8842"  },  "checkRuns": [    {      "key": "ci-8842-unit-tests",      "name": "unit-tests",      "status": "completed",      "conclusion": "success",      "externalUpdatedAt": "2026-08-02T14:44:30Z",      "startedAt": "2026-08-02T14:40:00Z",      "completedAt": "2026-08-02T14:44:30Z",      "detailsUrl": "https://ci.acme.dev/runs/8842",      "externalId": "run-8842",      "output": {        "title": "Unit tests",        "summary": "128 tests passed.",        "text": "All suites green."      }    }  ]}'

レスポンスの構造:

{  "checkSuite": {    "id": "crg_01k2ja2000e0080000000000h8",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    },    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "key": "ci-8842",    "name": "CI",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z",    "externalId": "build-8842",    "actor": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    }  },  "checkRuns": [    {      "id": "cr_01k2ja2000e0080000000000g7",      "repository": {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      },      "checkSuite": {        "id": "crg_01k2ja2000e0080000000000h8"      },      "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "key": "ci-8842-unit-tests",      "name": "unit-tests",      "status": "completed",      "conclusion": "success",      "detailsUrl": "https://ci.acme.dev/runs/8842",      "externalUpdatedAt": "2026-08-02T14:44:30Z",      "startedAt": "2026-08-02T14:40:00Z",      "completedAt": "2026-08-02T14:44:30Z",      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "externalId": "run-8842",      "actor": {        "user": {          "id": "user_01k2ja2000e0080000000000c3",          "email": "[email protected]"        }      },      "output": {        "title": "Unit tests",        "summary": "128 tests passed.",        "text": "All suites green."      }    }  ],  "results": [    {      "checkRun": {        "id": "cr_01k2ja2000e0080000000000g7",        "repository": {          "id": "repo_01k2ja2000e0080000000000q4",          "name": "rocket",          "owner": {            "slug": "acme",            "id": "ns_01k2ja2000e0080000000000p3",            "type": "team"          }        },        "checkSuite": {          "id": "crg_01k2ja2000e0080000000000h8"        },        "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",        "key": "ci-8842-unit-tests",        "name": "unit-tests",        "status": "completed",        "conclusion": "success",        "detailsUrl": "https://ci.acme.dev/runs/8842",        "externalUpdatedAt": "2026-08-02T14:44:30Z",        "startedAt": "2026-08-02T14:40:00Z",        "completedAt": "2026-08-02T14:44:30Z",        "createdAt": "2026-08-01T09:30:00Z",        "updatedAt": "2026-08-02T14:45:00Z",        "externalId": "run-8842",        "actor": {          "user": {            "id": "user_01k2ja2000e0080000000000c3",            "email": "[email protected]"          }        },        "output": {          "title": "Unit tests",          "summary": "128 tests passed.",          "text": "All suites green."        }      },      "outcome": "created"    }  ]}

チェック実行を取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/check-runs/{checkRunId}

Scoperepository:checks:readAuthInstallation tokenUser access token

サーバーによって割り当てられた ID (cr_...) で単一のチェック実行を返します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

checkRunId string 必須

サーバーが割り当てたチェック実行 ID (cr_...)。

レスポンスフィールド

id string

サーバーによって割り当てられたチェック実行の識別子。

repository object

この実行のリポジトリ参照。

repository.id string

コンテナ参照内のリポジトリ識別子。

repository.name string

コンテナ参照内のリポジトリ名。

repository.owner object

リポジトリのオーナー参照。

repository.owner.slug string

リポジトリの所有者を識別するために所有者IDとともに使用される、URLに表示されるオーナースラッグ。

repository.owner.id string

オリジン所有者の識別子。

repository.owner.type string

所有者の名前空間の種類。出力専用。許容値: team, user。不明な場合は省略されます。

checkSuite オブジェクト

このチェックを含むチェックスイートへの参照。

checkSuite.id string

所属するチェックスイートにサーバーが割り当てた識別子。

sha string

run が紐付けられている commit の SHA。

key string

アプリが選択する安定した論理実行ID。必須チェックは app、suite key、この key に基づいて照合される場合があります。

name string

表示専用の実行名です。必須チェックの照合には使用されません。

status string

conclusion string

detailsUrl string

プロバイダーの完全な結果ページへの個別リンク。

externalUpdatedAt string

更新の順序付けに使用される外部更新タイムスタンプ。古い再試行が新しい状態を置き換えられないようにするためのものです。

startedAt 文字列

提供されている場合、プロバイダーが報告した RFC 3339 形式の開始時刻。

completedAt string

提供された場合、プロバイダーが報告した RFC 3339 形式の完了時刻。

createdAt string

RFC 3339形式のラン作成タイムスタンプ。

updatedAt string

最後に永続化された実行の更新時刻を示す RFC 3339 タイムスタンプ。

externalId string

1回の試行に対するプロバイダーの識別子です。更新する際はこれを再利用し、再試行する場合は新しい値を使用してください。

actor オブジェクト

実行を生成した公開アクター。常に所有するチェックスイートの actor です。

actor.user オブジェクト

ユーザーがアクションを実行したときに設定される、アクターのユーザー変種。

actor.user.id string

ユーザーの公開識別子。

actor.user.email string

ユーザーのメールアドレス。ユーザーバリアントが存在する場合は常に設定されます。

actor.user.displayName string

actor.user.handle string

actor.app object

アクターのアプリのバリアント。アプリがアクションを実行したときに設定されます。

actor.app.id string

アプリの公開識別子。

actor.app.displayName string

アプリに登録された表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターの場合は省略されます。

actor.serviceAccount object

アクターのサービスアカウントのバリアント。サービスアカウントが操作を実行したときに設定されます。

actor.serviceAccount.id string

サービスアカウントの公開識別子。

output object

タイトル、要約、必要に応じて詳細なテキストを含む、人間が読める形式の結果オブジェクト。

output.title string

出力の短い見出し。最大長: 255文字。

output.summary string

出力の要約。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

output.text string

詳細な出力。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

deadlineAt 文字列

isRerequestable boolean

レポートを送信したアプリがこの実行を再リクエスト可能と宣言したかどうか。

rerequestedAt string

rerequestedBy object

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/check-runs/CHECK_RUN_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "cr_01k2ja2000e0080000000000g7",  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  },  "checkSuite": {    "id": "crg_01k2ja2000e0080000000000h8"  },  "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "key": "ci-8842-unit-tests",  "name": "unit-tests",  "status": "completed",  "conclusion": "success",  "detailsUrl": "https://ci.acme.dev/runs/8842",  "externalUpdatedAt": "2026-08-02T14:44:30Z",  "startedAt": "2026-08-02T14:40:00Z",  "completedAt": "2026-08-02T14:44:30Z",  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "externalId": "run-8842",  "actor": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "output": {    "title": "Unit tests",    "summary": "128 tests passed.",    "text": "All suites green."  }}

チェック実行の一覧注釈

GET/v1/origin/repos/{ownerSlug}/{repoName}/check-runs/{checkRunId}/annotations

Scoperepository:checks:readAuthInstallation tokenUser access token

チェック実行のアノテーションをIDの昇順で一覧表示します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

checkRunId string 必須

サーバーによって割り当てられたチェック実行ID。

クエリパラメータ

pageSize 整数

返す注釈の最大数。省略または 0 の場合はデフォルトで 30 になります。100 を超える値は 100 に制限されます。

pageToken string

レスポンスフィールド

annotations 配列

注釈のページ。IDは昇順で表示されます。

annotations[].id string

Stable Origin アノテーション ID。ID は時間でソート可能です。

annotations[].checkRunId string

この注釈が属するチェック実行のID。

annotations[].annotationLevel string

注釈の重大度。指定可能な値: notice、warning、failure。

annotations[].message string

アノテーションメッセージ。Markdownを含む場合があります。

annotations[].title string

注釈のタイトル。注釈にタイトルがない場合は表示されません。

annotations[].rawDetails string

生の詳細テキスト。アノテーションがない場合は表示されません。

annotations[].createdAt string

アノテーションが作成された日時 (RFC 3339)

annotations[].updatedAt string

アノテーションの最終更新日時 (RFC 3339) 。

annotations[].location オブジェクト

ソースの場所。run レベルの注釈では指定されません。

annotations[].location.path string

リポジトリに対する正規化された相対ファイルパス。

annotations[].location.startLine 整数

範囲の先頭行。行番号は1から始まり、範囲は両端を含みます。

annotations[].location.endLine integer

範囲の最終行。行番号は1から始まり、終端を含みます。

annotations[].location.columns object

列の範囲。注釈が単一行を含む場合にのみ存在します。

annotations[].location.columns.startColumn integer

範囲の先頭列。1始まりで、両端を含みます。

annotations[].location.columns.endColumn integer

範囲の最終列。1始まりで、終端を含みます。

nextPageToken string

次のページ用の不透明なカーソル。結果がこれ以上ない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/check-runs/CHECK_RUN_ID/annotations' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "annotations": [    {      "id": "cra_01k2ja2000e0080000000000v1",      "checkRunId": "cr_01k2ja2000e0080000000000g7",      "annotationLevel": "warning",      "message": "Deprecated API usage; migrate to the v2 client.",      "title": "Deprecated API",      "createdAt": "2026-08-02T14:45:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "location": {        "path": "src/telemetry.ts",        "startLine": 42,        "endLine": 42      }    }  ]}

チェック実行アノテーションの作成

POST/v1/origin/repos/{ownerSlug}/{repoName}/check-runs/{checkRunId}/annotations

Scoperepository:checks:writeAuthInstallation token

1〜25 件の注釈を、単一のアトミックなバッチでチェック実行に追加します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

checkRunId string 必須

サーバーが割り当てたチェック実行のID。

リクエスト本文

annotations array 必須

追加するバッチ。エントリを1～25件含める必要があります。

annotations[].annotationLevel string 必須

注釈の重大度。指定可能な値: notice, warning, failure。

annotations[].message string 必須

注釈メッセージ。Markdown を含めることができます。空にできません。UTF-8 で最大 65,535 バイトです。

annotations[].title string

注釈のタイトル。最大長: 255 Unicode 文字。

annotations[].rawDetails string

生の詳細テキスト。UTF-8で最大65,535バイト。

annotations[].location オブジェクト

注釈が指すソースの場所。コード行に紐づかない実行レベルの注釈では省略してください。

annotations[].location.path string 必須

リポジトリ相対の正規化されたファイルパス。最大 4,096 バイト (UTF-8) 。

annotations[].location.startLine integer 必須

範囲の開始行。1始まりで、この行を含みます。

annotations[].location.endLine integer 必須

範囲の最終行。1始まりで包含的で、startLine と同じかそれ以降の行です。

annotations[].location.columns オブジェクト

行内の列範囲。startLine と endLine が同じ行の場合にのみサポートされ、両方の列は一緒に送信する必要があります。

annotations[].location.columns.startColumn integer

範囲の先頭列。1始まりでこの値を含みます。

annotations[].location.columns.endColumn integer

範囲の最終列。1始まりで終端を含み、startColumn 以降です。

レスポンスフィールド

annotations 配列

このリクエストによって作成された注釈。

annotations[].id string

Stable Origin の注釈 ID。ID は時間順に並べ替え可能です。

annotations[].checkRunId string

この注釈が属するチェック実行のID。

annotations[].annotationLevel string

注釈の重大度。指定可能な値: notice, warning, failure。

annotations[].message string

注釈メッセージ。Markdown を含めることがあります。

annotations[].title string

注釈のタイトル。注釈にタイトルがない場合は存在しません。

annotations[].rawDetails string

生の詳細テキスト。注釈に詳細がない場合は存在しません。

annotations[].createdAt string

注釈が作成された日時 (RFC 3339) 。

annotations[].updatedAt string

注釈が最後に更新された日時 (RFC 3339)。

annotations[].location オブジェクト

ソースの場所。実行レベルの注釈では省略されます。

annotations[].location.path string

標準的なリポジトリ相対ファイルパス。

annotations[].location.startLine integer

範囲の開始行。1 始まりで、この行を含みます。

annotations[].location.endLine integer

範囲の最終行。行番号は1始まりで、終端を含みます。

annotations[].location.columns オブジェクト

列の範囲。注釈が単一行を対象とする場合にのみ存在します。

annotations[].location.columns.startColumn integer

範囲の開始列。1始まりでこの値を含みます。

annotations[].location.columns.endColumn integer

範囲の最終列。1始まりで、終端を含みます。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/check-runs/CHECK_RUN_ID/annotations' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "annotations": [    {      "annotationLevel": "warning",      "message": "Deprecated API usage; migrate to the v2 client.",      "title": "Deprecated API",      "location": {        "path": "src/telemetry.ts",        "startLine": 42,        "endLine": 42      }    }  ]}'

レスポンスの構造:

{  "annotations": [    {      "id": "cra_01k2ja2000e0080000000000v1",      "checkRunId": "cr_01k2ja2000e0080000000000g7",      "annotationLevel": "warning",      "message": "Deprecated API usage; migrate to the v2 client.",      "title": "Deprecated API",      "createdAt": "2026-08-02T14:45:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "location": {        "path": "src/telemetry.ts",        "startLine": 42,        "endLine": 42      }    }  ]}

チェック実行を再リクエスト

POST/v1/origin/repos/{ownerSlug}/{repoName}/check-runs/{checkRunId}/rerequest

Scoperepository:contents:writeAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

checkRunId string 必須

サーバーが割り当てたチェック実行 ID (cr_...)。

リクエストボディ

このリクエストにフィールドはありません。空の JSON オブジェクトを送信してください。

レスポンスフィールド

id string

サーバー割り当てのチェック実行識別子。

repository object

この実行のリポジトリ参照。

repository.id string

コンテナ参照内のリポジトリ識別子。

repository.name string

コンテナ参照内のリポジトリ名。

repository.owner object

リポジトリのオーナー参照。

repository.owner.slug string

リポジトリの所有者を識別するために所有者IDとともに使用される、URLに表示されるオーナースラッグ。

repository.owner.id string

オリジン所有者の識別子。

repository.owner.type string

所有者の名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

checkSuite オブジェクト

このチェックを含むチェックスイートへの参照。

checkSuite.id string

所属するチェックスイートにサーバーが割り当てた識別子。

sha string

実行に紐づけられているコミットの SHA。

key string

アプリが選択する安定した論理的実行識別子。必須チェックは app、suite key、およびこの key に基づいて照合される場合があります。

name string

表示専用の実行名です。必須チェックの照合には使用されません。

status string

conclusion string

detailsUrl string

プロバイダーの完全な結果ページへの個別リンク。

externalUpdatedAt string

更新の順序付けに使用される外部更新タイムスタンプ。古い再試行が新しい状態を置き換えられないようにします。

startedAt 文字列

提供された場合、プロバイダーが報告した RFC 3339 形式の開始時刻。

completedAt string

提供されている場合、プロバイダーが報告した RFC 3339 形式の完了時刻。

createdAt string

RFC 3339 形式の run 作成タイムスタンプ。

updatedAt string

最後に永続化された実行の更新時刻を示す RFC 3339 タイムスタンプ。

externalId string

1回の試行に対するプロバイダーの識別子です。その試行を更新するには再利用し、再試行する場合は新しい値を使用してください。

actor オブジェクト

実行を生成した公開アクター。常に所有するチェックスイートのactorです。

actor.user オブジェクト

アクターのユーザー版。ユーザーが操作を行ったときに設定されます。

actor.user.id string

ユーザーの公開識別子。

actor.user.email string

ユーザーのメールアドレス。ユーザーバリアントが存在する場合は常に設定されます。

actor.user.displayName string

actor.user.handle string

actor.app object

アクターのアプリのバリアント。アプリがその操作を行った場合に設定されます。

actor.app.id string

アプリの公開識別子。

actor.app.displayName string

アプリに登録された表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターの場合は省略されます。

actor.serviceAccount object

アクターのサービスアカウントのバリアント。サービスアカウントが操作を実行したときに設定されます。

actor.serviceAccount.id string

サービスアカウントの公開識別子。

output object

タイトル、要約、必要に応じてより長いテキストを含む、人間が読める形式の結果オブジェクト。

output.title string

出力の短い見出し。最大長: 255文字。

output.summary string

出力の要約。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

output.text string

詳細な出力。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

deadlineAt 文字列

チェック実行の期限を RFC 3339 形式のタイムスタンプで記録します。実行に期限がない場合 (実行完了後を含む) は存在しません。

isRerequestable boolean

レポート元のアプリがこの実行を再リクエスト可能と宣言したかどうか。

rerequestedAt string

rerequestedBy object

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/check-runs/CHECK_RUN_ID/rerequest' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{}'

レスポンスの構造:

{  "id": "cr_01k2ja2000e0080000000000g7",  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  },  "checkSuite": {    "id": "crg_01k2ja2000e0080000000000h8"  },  "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "key": "ci-8842-unit-tests",  "name": "unit-tests",  "status": "rerequested",  "conclusion": "failure",  "detailsUrl": "https://ci.acme.dev/runs/8842",  "externalUpdatedAt": "2026-08-02T14:44:30Z",  "startedAt": "2026-08-02T14:40:00Z",  "completedAt": "2026-08-02T14:44:30Z",  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T15:02:10Z",  "externalId": "run-8842",  "actor": {    "app": {      "id": "app_01k2ja2000e0080000000000a1",      "displayName": "Acme CI"    }  },  "output": {    "title": "Unit tests",    "summary": "3 of 128 tests failed."  },  "isRerequestable": true,  "rerequestedAt": "2026-08-02T15:02:10Z",  "rerequestedBy": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  }}

チェックスイートの取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/check-suites/{checkSuiteId}

Scoperepository:checks:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

リポジトリ名。オーナーエンティティ内で一意です。

checkSuiteId string 必須

サーバー割り当てのチェックスイートID (crg_...) 。

レスポンスフィールド

id string

サーバーによって割り当てられたチェック・スイート識別子。

repository object

スイートのリポジトリ参照。

repository.id string

コンテナ参照内のリポジトリ識別子。

repository.name string

コンテナ参照内のリポジトリ名。

repository.owner object

リポジトリの所有者への参照。

repository.owner.slug string

リポジトリのオーナーを識別するために、オーナーIDとともに使用されるURL向けのオーナースラッグです。

repository.owner.id string

Origin の所有者識別子。

repository.owner.type string

所有者の名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

sha 文字列

スイートに関連付けられたコミットのSHA。

key string

app が選択する安定した必須チェック識別子です。必須チェックは name ではなく、app とこのキーの組み合わせで照合されます。

name string

表示専用のスイート名です。必須チェックの照合には使用されません。

detailsUrl string

プロバイダーのスイートレベルの結果への任意のリンク。

createdAt string

RFC 3339形式のスイート作成タイムスタンプ。

updatedAt 文字列

スイートの最終更新を示す RFC 3339 形式のタイムスタンプ。

externalId string

このスイート試行のプロバイダー識別子。

actor オブジェクト

スイートを作成した公開アクター。

actor.user オブジェクト

アクターがユーザーである場合のバリアント。ユーザーがアクションを実行したときに設定されます。

actor.user.id string

ユーザーの公開識別子。

actor.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

actor.user.displayName string

ユーザーの表示名: アカウントの名と姓をスペースで結合した、製品に表示される名前です。アカウントに名前がない場合は省略されます。

actor.user.handle string

actor.app object

アクターがアプリである場合のバリアント。アプリがアクションを実行したときに設定されます。

actor.app.id string

アプリの公開識別子。

actor.app.displayName string

アプリの登録表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターでは省略されます。

actor.serviceAccount オブジェクト

アクターのサービスアカウント版。サービスアカウントがアクションを実行したときに設定されます。

actor.serviceAccount.id string

サービスアカウントの公開識別子。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/check-suites/CHECK_SUITE_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "crg_01k2ja2000e0080000000000h8",  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  },  "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "key": "ci-8842",  "name": "CI",  "detailsUrl": "https://ci.acme.dev/runs/8842",  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "externalId": "build-8842",  "actor": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  }}

スイートのチェック実行一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/check-suites/{checkSuiteId}/check-runs

Scoperepository:checks:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

checkSuiteId string 必須

サーバー割り当てのチェックスイートID (crg_...) 。

クエリパラメータ

pageSize 整数

返されるチェック実行の最大数。未設定または0の場合のデフォルトは30です。100を超える値は100に切り捨てられます。

pageToken string

レスポンスフィールド

checkRuns 配列

指定されたスイートに属するページネーション対応のチェック実行。

checkRuns[].id string

サーバー割り当てのチェック実行識別子。

checkRuns[].repository object

実行のリポジトリ参照。

checkRuns[].repository.id string

コンテナ参照内のリポジトリ識別子。

checkRuns[].repository.name string

コンテナ参照内のリポジトリ名。

checkRuns[].repository.owner オブジェクト

リポジトリの所有者参照。

checkRuns[].repository.owner.slug string

リポジトリの所有者を識別するために所有者IDとともに使用される、URL 表示用のオーナースラッグ。

checkRuns[].repository.owner.id string

オリジン所有者識別子。

checkRuns[].repository.owner.type string

オーナーの名前空間の種類。出力専用。許容値: team, user。不明な場合は省略されます。

checkRuns[].checkSuite オブジェクト

所属するチェックスイートへの参照。

checkRuns[].checkSuite.id string

所属するチェックスイートのサーバー割り当て識別子。

checkRuns[].sha string

実行に関連付けられているコミット SHA。

checkRuns[].key string

アプリ側で選択される安定した論理実行識別子。必須のチェックはアプリ、スイートキー、およびこのキーで一致することがあります。

checkRuns[].name string

表示専用の実行名です。必須チェックの照合には使用されません。

checkRuns[].status string

checkRuns[].conclusion string

checkRuns[].detailsUrl string

プロバイダーの完全な結果ページへの個別リンク。

checkRuns[].externalUpdatedAt string

古い再試行が新しい状態を置き換えないよう、更新の順序を決めるために使用される外部更新タイムスタンプ。

checkRuns[].startedAt string

プロバイダーから提供された場合の RFC 3339 形式の開始時刻。

checkRuns[].completedAt string

提供されている場合、プロバイダーが報告した RFC 3339 形式の完了時刻。

checkRuns[].createdAt string

RFC 3339 形式の実行作成タイムスタンプ。

checkRuns[].updatedAt string

最後に永続化された実行の更新時刻を表す RFC 3339 タイムスタンプ。

checkRuns[].externalId string

1回の試行に対するプロバイダー識別子です。試行を更新する際はこれを再利用し、再試行する場合は新しい値を使用してください。

checkRuns[].actor オブジェクト

実行を作成した公開アクター。常に所有するチェックスイートの actor です。

checkRuns[].actor.user オブジェクト

ユーザーがアクションを実行したときに設定される、アクターのユーザー用バリアント。

checkRuns[].actor.user.id string

ユーザーの公開識別子。

checkRuns[].actor.user.email string

ユーザーのメールアドレス。ユーザーバリアントが存在する場合は常に設定されます。

checkRuns[].actor.user.displayName string

checkRuns[].actor.user.handle string

checkRuns[].actor.app object

アクターのアプリのバリアント。アプリがアクションを実行したときに設定されます。

checkRuns[].actor.app.id string

アプリの公開識別子。

checkRuns[].actor.app.displayName string

アプリに登録された表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターの場合は省略されます。

checkRuns[].actor.serviceAccount オブジェクト

アクターのサービスアカウント版。サービスアカウントが操作を実行したときに設定されます。

checkRuns[].actor.serviceAccount.id string

サービスアカウントの公開識別子。

checkRuns[].output object

タイトル、要約、および提供された場合のより長いテキストを含む、人間が読める形式の結果オブジェクト。

checkRuns[].output.title string

出力の短い見出し。最大長: 255文字。

checkRuns[].output.summary string

出力の概要。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRuns[].output.text 文字列

詳細な出力。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRuns[].deadlineAt string

チェック実行の期限を RFC 3339 形式のタイムスタンプで記録します。実行に期限がない場合 (実行完了後を含む) は存在しません。

checkRuns[].isRerequestable boolean

報告アプリがこの実行を再リクエスト可能と宣言したかどうか。

checkRuns[].rerequestedAt string

checkRuns[].rerequestedBy object

nextPageToken string

次のページ用の不透明なカーソル。これ以上ページがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/check-suites/CHECK_SUITE_ID/check-runs' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "checkRuns": [    {      "id": "cr_01k2ja2000e0080000000000g7",      "repository": {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      },      "checkSuite": {        "id": "crg_01k2ja2000e0080000000000h8"      },      "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "key": "ci-8842-unit-tests",      "name": "unit-tests",      "status": "completed",      "conclusion": "success",      "detailsUrl": "https://ci.acme.dev/runs/8842",      "externalUpdatedAt": "2026-08-02T14:44:30Z",      "startedAt": "2026-08-02T14:40:00Z",      "completedAt": "2026-08-02T14:44:30Z",      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "externalId": "run-8842",      "actor": {        "user": {          "id": "user_01k2ja2000e0080000000000c3",          "email": "[email protected]"        }      },      "output": {        "title": "Unit tests",        "summary": "128 tests passed.",        "text": "All suites green."      }    }  ]}

コミットのチェック実行一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/commits/{sha}/check-runs

Scoperepository:checks:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

sha string 必須

チェック実行を一覧表示する対象のコミットSHA (40文字または64文字の16進数) 。

クエリパラメータ

pageSize 整数

返されるチェック実行の最大数。未設定または0の場合の既定値は30です。100を超える値は100に丸められます。

pageToken string

checkName string

任意の完全一致チェック実行名フィルター。checkRuns[].name に対して照合されます。省略すると任意の名前の実行が一覧表示されます。

status string

レスポンスフィールド

checkRuns 配列

解決されたコミット SHA に関連付けられたページネーション対応のチェック実行。

checkRuns[].id string

サーバーによって割り当てられたチェック実行識別子。

checkRuns[].repository object

実行のリポジトリ参照。

checkRuns[].repository.id string

コンテナ参照内のリポジトリ識別子。

checkRuns[].repository.name string

コンテナ参照内のリポジトリ名。

checkRuns[].repository.owner オブジェクト

リポジトリのオーナー参照。

checkRuns[].repository.owner.slug string

リポジトリの所有者を識別するために所有者 ID とともに使用される、URL 表示用のオーナースラッグ。

checkRuns[].repository.owner.id 文字列

Origin のオーナー識別子。

checkRuns[].repository.owner.type string

所有者のネームスペースの種類。出力専用。許可される値: team、user。不明な場合は省略されます。

checkRuns[].checkSuite object

このチェックを含むチェック・スイートへの参照。

checkRuns[].checkSuite.id string

所属するチェックスイートのサーバー割り当て識別子。

checkRuns[].sha 文字列

実行に関連付けられたコミット SHA。

checkRuns[].key string

アプリが選択する安定した論理実行識別子。必要なチェックは app、suite key、およびこの key で一致する場合があります。

checkRuns[].name string

表示専用の実行名。必須チェックの照合には使用されません。

checkRuns[].status string

checkRuns[].conclusion string

checkRuns[].detailsUrl string

プロバイダーの詳細な結果ページへの個別リンク。

checkRuns[].externalUpdatedAt 文字列

古い再試行が新しい状態を置き換えられないよう、更新の順序付けに使用される外部更新タイムスタンプ。

checkRuns[].startedAt 文字列

提供されている場合、プロバイダーが報告した RFC 3339 形式の開始時刻。

checkRuns[].completedAt string

提供されている場合の、プロバイダーが報告した RFC 3339 形式の完了時刻。

checkRuns[].createdAt 文字列

RFC 3339 実行作成のタイムスタンプ。

checkRuns[].updatedAt string

最新の永続化された実行更新の RFC 3339 タイムスタンプ。

checkRuns[].externalId string

1回の試行に対するプロバイダーの識別子です。同じ試行を更新するにはこれを再利用し、再試行する場合は新しい値を使用してください。

checkRuns[].actor オブジェクト

この実行を生成した公開アクター。常に所有するチェックスイートのactorです。

checkRuns[].actor.user オブジェクト

実行者のユーザー版。ユーザーが操作を行ったときに設定されます。

checkRuns[].actor.user.id 文字列

ユーザーの公開識別子。

checkRuns[].actor.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

checkRuns[].actor.user.displayName string

checkRuns[].actor.user.handle string

checkRuns[].actor.app object

アクターのアプリバリアント。アプリがアクションを実行したときに設定されます。

checkRuns[].actor.app.id string

アプリの公開識別子。

checkRuns[].actor.app.displayName string

アプリの登録表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターでは省略されます。

checkRuns[].actor.serviceAccount object

アクターのサービスアカウント変種。サービスアカウントが操作を実行したときに設定されます。

checkRuns[].actor.serviceAccount.id string

サービスアカウントの公開識別子。

checkRuns[].output object

タイトル、要約、および (指定された場合の) より長いテキストを含む、人間が読みやすい結果オブジェクト。

checkRuns[].output.title string

出力の短い見出し。最大長: 255文字。

checkRuns[].output.summary string

出力の概要。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRuns[].output.text 文字列

詳細な出力。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRuns[].deadlineAt 文字列

チェック実行の締め切りを RFC 3339 形式のタイムスタンプで記録します。実行に締め切りがない場合 (実行完了後を含む) は存在しません。

checkRuns[].isRerequestable boolean

報告元のアプリがこの実行を再リクエスト可能と宣言しているかどうか。

checkRuns[].rerequestedAt 文字列

checkRuns[].rerequestedBy object

nextPageToken string

次ページ用の不透明なカーソル。次のページがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/commits/SHA/check-runs' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "checkRuns": [    {      "id": "cr_01k2ja2000e0080000000000g7",      "repository": {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      },      "checkSuite": {        "id": "crg_01k2ja2000e0080000000000h8"      },      "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "key": "ci-8842-unit-tests",      "name": "unit-tests",      "status": "completed",      "conclusion": "success",      "detailsUrl": "https://ci.acme.dev/runs/8842",      "externalUpdatedAt": "2026-08-02T14:44:30Z",      "startedAt": "2026-08-02T14:40:00Z",      "completedAt": "2026-08-02T14:44:30Z",      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "externalId": "run-8842",      "actor": {        "user": {          "id": "user_01k2ja2000e0080000000000c3",          "email": "[email protected]"        }      },      "output": {        "title": "Unit tests",        "summary": "128 tests passed.",        "text": "All suites green."      }    }  ]}

コミットのチェックスイートを一覧表示

GET/v1/origin/repos/{ownerSlug}/{repoName}/commits/{sha}/check-suites

Scoperepository:checks:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

sha string 必須

チェックスイートを一覧表示する対象のコミットSHA (40文字または64文字の16進数) です。

クエリパラメータ

pageSize 整数

返却するスイートの最大数。未設定または0の場合はデフォルトで30になります。100を超える値は100に制限されます。

pageToken string

レスポンスフィールド

checkSuites 配列

解決されたコミットSHAに紐づくページ分割されたチェックスイート。

checkSuites[].id string

サーバー割り当てのチェックスイート識別子。

checkSuites[].repository オブジェクト

スイートのリポジトリ参照。

checkSuites[].repository.id string

コンテナ参照内のリポジトリ識別子。

checkSuites[].repository.name string

コンテナ参照内のリポジトリ名。

checkSuites[].repository.owner object

リポジトリのオーナー参照。

checkSuites[].repository.owner.slug string

リポジトリの所有者を識別するために所有者IDとともに使用される、URL 表示用のオーナースラッグ。

checkSuites[].repository.owner.id 文字列

オリジン所有者の識別子。

checkSuites[].repository.owner.type string

所有者の名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

checkSuites[].sha string

スイートが紐づけられているコミットのSHA。

checkSuites[].key string

app が指定する安定した必須チェックの識別子。必須チェックは name ではなく、app とこのキーで照合されます。

checkSuites[].name string

表示専用のスイート名。必須チェックの照合には使用されません。

checkSuites[].detailsUrl 文字列

プロバイダーのスイートレベルの結果への任意のリンク。

checkSuites[].createdAt 文字列

RFC 3339 形式の suite 作成タイムスタンプ。

checkSuites[].updatedAt 文字列

最新のスイート更新時刻を示すRFC 3339タイムスタンプ。

checkSuites[].externalId string

このスイート試行のプロバイダーの識別情報。

checkSuites[].actor オブジェクト

スイートを作成した公開アクター。

checkSuites[].actor.user オブジェクト

アクターのユーザー版。ユーザーが操作を行ったときに設定されます。

checkSuites[].actor.user.id string

ユーザーの公開識別子。

checkSuites[].actor.user.email string

ユーザーのメールアドレス。ユーザーのバリアントがある場合は常に設定されます。

checkSuites[].actor.user.displayName string

checkSuites[].actor.user.handle string

checkSuites[].actor.app オブジェクト

アクターのアプリのバリアント。アプリが操作を実行したときに設定されます。

checkSuites[].actor.app.id string

アプリの公開識別子。

checkSuites[].actor.app.displayName string

アプリに登録されている表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターの場合は省略されます。

checkSuites[].actor.serviceAccount オブジェクト

アクターのサービスアカウント版。サービスアカウントが操作を実行したときに設定されます。

checkSuites[].actor.serviceAccount.id string

サービスアカウントの公開識別子。

nextPageToken string

次ページ用の不透明なカーソル。これ以上ページがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/commits/SHA/check-suites' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "checkSuites": [    {      "id": "crg_01k2ja2000e0080000000000h8",      "repository": {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      },      "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "key": "ci-8842",      "name": "CI",      "detailsUrl": "https://ci.acme.dev/runs/8842",      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "externalId": "build-8842",      "actor": {        "user": {          "id": "user_01k2ja2000e0080000000000c3",          "email": "[email protected]"        }      }    }  ]}

コミットとコンテンツ

コミット一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/commits

Scoperepository:contents:readAuthInstallation tokenUser access token

ブランチまたは開始リファレンスのコミットを一覧表示します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

所有者エンティティ内で一意のリポジトリ名。

クエリパラメータ

sha string

一覧表示の開始位置となる SHA、ブランチ、タグ、またはシンボリック ref (例: HEAD) 。空の場合はリポジトリのデフォルトブランチを使用します。

pageSize integer

返されるコミットの最大数。未指定または0の場合はデフォルトで30になります。100を超える値は100に制限されます。

pageToken string

authorEmails 配列

committerEmails 配列

レスポンスフィールド

commits 配列

stats を含まない簡略化されたコミット。変更されたファイルは埋め込まれません。

commits[].sha string

コミットの完全なSHA。

commits[].commit オブジェクト

トップレベルのリポジトリ関係とは別にネストされた Git オブジェクトのメタデータ。

commits[].commit.author オブジェクト

Origin のユーザーオブジェクトではなく、コミットに記録された Git の作成者情報。

commits[].commit.author.name string

Git の作成者情報に記録された名前。

commits[].commit.author.email string

Git の著者情報に記録されたメールアドレス。

commits[].commit.author.date string

Git の作成者情報に記録された RFC 3339 形式の日付。

commits[].commit.committer object

Origin のユーザーオブジェクトではなく、コミットに記録された Git コミッターの識別情報。

commits[].commit.committer.name string

Git の識別情報に記録された名前。

commits[].commit.committer.email string

Gitのユーザー情報に登録されているメールアドレス。

commits[].commit.committer.date string

Git署名の元のタイムゾーンオフセットを保持するISO-8601タイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

commits[].commit.message string

コミットメッセージ。

commits[].commit.tree オブジェクト

コミットが参照するツリー。

commits[].commit.tree.sha string

コミットが参照するツリーの SHA。

commits[].parents 配列

各親コミットへの参照。各参照にはSHAが含まれます。

commits[].parents[].sha string

親コミットのSHA。

nextPageToken string

次のページ用の不透明なカーソル。これ以上ページがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/commits' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "commits": [    {      "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "commit": {        "author": {          "name": "Jane Doe",          "email": "[email protected]",          "date": "2026-08-01T09:30:00Z"        },        "committer": {          "name": "Jane Doe",          "email": "[email protected]",          "date": "2026-08-01T09:30:00Z"        },        "message": "Add launch telemetry",        "tree": {          "sha": "a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8"        }      },      "parents": [        {          "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"        }      ],      "stats": {        "additions": 128,        "deletions": 46,        "total": 174      }    }  ]}

コミットを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/commits/{sha}

Scoperepository:contents:readAuthInstallation tokenUser access token

author と committer はコミットに記録された Git アイデンティティであり、Origin ユーザーオブジェクトではありません。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

sha string 必須

取得するコミットの SHA、ブランチ、タグ、またはシンボリック ref (例: HEAD) 。短縮 SHA は Git コミットを取得の場合と同じ方法で解決されます。

レスポンスフィールド

sha string

コミットの完全な SHA。

commit object

トップレベルのリポジトリ関係とは別にネストされた Git オブジェクトのメタデータ。

commit.author object

コミットに記録された Git 作成者の識別情報であり、Origin のユーザーオブジェクトではありません。

commit.author.name string

Git の作成者情報に記録された名前。

commit.author.email string

Git author ID に記録されたメールアドレス。

commit.author.date string

Git の author アイデンティティに記録された RFC 3339 形式の日付。

commit.committer object

コミットに記録された Git コミッターの識別情報であり、Origin のユーザーオブジェクトではありません。

commit.committer.name string

Git の識別情報に記録されている名前。

commit.committer.email string

Git IDに記録されたメールアドレス。

commit.committer.date string

git署名に記録された元のタイムゾーンオフセットを保持するISO-8601タイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

commit.message string

コミットメッセージ。

commit.tree オブジェクト

コミットが参照するツリー。

commit.tree.sha string

コミットが参照するツリーの SHA。

parents 配列

各親コミットの参照には、それぞれSHAが含まれます。

parents[].sha string

親コミットのSHA。

stats object

コミット全体の追加、削除、および合計の集計；get-commit では含まれ、list のプロジェクションでは省略されます。

stats.additions 整数

コミットで追加された行数の合計。

stats.deletions integer

コミットで削除された行数の合計。

stats.total integer

コミットにおける追加と削除の合計。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/commits/SHA' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "commit": {    "author": {      "name": "Jane Doe",      "email": "[email protected]",      "date": "2026-08-01T09:30:00Z"    },    "committer": {      "name": "Jane Doe",      "email": "[email protected]",      "date": "2026-08-01T09:30:00Z"    },    "message": "Add launch telemetry",    "tree": {      "sha": "a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8"    }  },  "parents": [    {      "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"    }  ],  "stats": {    "additions": 128,    "deletions": 46,    "total": 174  }}

コミットで変更されたファイルを一覧表示

GET/v1/origin/repos/{ownerSlug}/{repoName}/commits/{sha}/files

Scoperepository:contents:readAuthInstallation tokenUser access token

コミットで変更されたファイルを一覧表示します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

sha string 必須

ファイルを一覧表示するコミットの SHA、ブランチ、タグ、またはシンボリック参照 (例: HEAD) 。短縮 SHA は Get Git Commit と同様に解決されます。

クエリパラメータ

pageSize integer

返す変更ファイルの最大数。未指定または0の場合のデフォルトは30です。100を超える値は100に制限されます。

pageToken string

レスポンスフィールド

files 配列

files[].filename string

変更されたファイルのパス。

files[].status string

変更ステータス: 追加、削除、変更、名前変更、またはコピー。

files[].additions integer

ファイルの追加された行数。

files[].deletions integer

ファイルから削除された行数。

files[].changes integer

ファイル内で変更された行の合計数。

files[].patch string

統合形式のパッチ。バイナリファイルの場合は空です。

files[].previousFilename string

ファイルが名前変更またはコピーされたときの以前のパス。

nextPageToken string

トークンは解決済みコミットおよびファイルカーソルを固定します。以降の sha の値はそれと一致している必要があります。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/commits/SHA/files' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "files": [    {      "filename": "src/telemetry.ts",      "status": "modified",      "additions": 6,      "deletions": 3,      "changes": 9,      "patch": "@@ -12,6 +12,9 @@\n import { ignite } from \"./ignition\";\n+import { emitLaunchTelemetry } from \"./telemetry\";\n"    }  ]}

コミットの比較

GET/v1/origin/repos/{ownerSlug}/{repoName}/compare/{basehead}

Scoperepository:contents:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

basehead string 必須

"{base}...{head}"。各リビジョンは SHA、ブランチ、タグ、または HEAD のようなシンボリック参照で指定できます。

レスポンスフィールド

status string

比較状態: 完全に一致、先行、遅延、または分岐しています。

aheadBy integer

HEAD が先行しているコミット数。

behindBy 整数

HEAD が遅れているコミット数。

baseCommit object

stats やファイルを含まない、スパースに解決されたベースコミット。

baseCommit.sha string

コミットの完全な SHA。

baseCommit.commit オブジェクト

トップレベルのリポジトリ関係とは別にネストされたGitオブジェクトのメタデータ。

baseCommit.commit.author object

コミットに記録された Git の著者情報であり、Origin のユーザーオブジェクトではありません。

baseCommit.commit.author.name string

Git の作成者 ID に記録される名前。

baseCommit.commit.author.email string

Git の作成者情報に記録されるメールアドレス。

baseCommit.commit.author.date string

Git作者の識別情報に記録された RFC 3339 形式の日付。

baseCommit.commit.committer オブジェクト

コミットに記録された Git コミッターの識別情報であり、Origin のユーザーオブジェクトではありません。

baseCommit.commit.committer.name string

Git の識別情報に記録された名前。

baseCommit.commit.committer.email string

Git の識別情報に記録されているメールアドレス。

baseCommit.commit.committer.date string

git署名の元のタイムゾーンオフセットを保持するISO-8601タイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

baseCommit.commit.message string

コミットメッセージ。

baseCommit.commit.tree オブジェクト

コミットが参照するツリー。

baseCommit.commit.tree.sha string

コミットが参照するツリーの SHA。

baseCommit.parents 配列

親コミットへの参照。それぞれ SHA を含みます。

baseCommit.parents[].sha string

親コミットの SHA。

headCommit オブジェクト

統計やファイルを含まないスパース解決済みヘッドコミット。

headCommit.sha string

コミットの完全な SHA。

headCommit.commit オブジェクト

トップレベルのリポジトリ関係とは別にネストされた Git オブジェクトのメタデータ。

headCommit.commit.author object

コミットに記録された Git の著者情報であり、Origin のユーザーオブジェクトではありません。

headCommit.commit.author.name string

Git の作成者 ID に記録される名前。

headCommit.commit.author.email string

Git の作成者情報に記録されるメールアドレス。

headCommit.commit.author.date string

Git作者の識別情報に記録された RFC 3339 形式の日付。

headCommit.commit.committer オブジェクト

コミットに記録された Git コミッターの識別情報であり、Origin のユーザーオブジェクトではありません。

headCommit.commit.committer.name string

Git の識別情報に記録された名前。

headCommit.commit.committer.email string

Git の識別情報に記録されているメールアドレス。

headCommit.commit.committer.date string

git署名の元のタイムゾーンオフセットを保持するISO-8601タイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

headCommit.commit.message string

コミットメッセージ。

headCommit.commit.tree オブジェクト

コミットが参照するツリー。

headCommit.commit.tree.sha string

コミットが参照するツリーの SHA。

headCommit.parents array

親コミットへの参照。各参照は SHA を含みます。

headCommit.parents[].sha string

親コミットの SHA。

mergeBaseCommit オブジェクト

統計やファイルを含まないスパースなマージベースコミット。

mergeBaseCommit.sha string

コミットの完全な SHA。

mergeBaseCommit.commit オブジェクト

トップレベルのリポジトリ関係とは別にネストされた Git オブジェクトのメタデータ。

mergeBaseCommit.commit.author オブジェクト

コミットに記録された Git の著者情報であり、Origin のユーザーオブジェクトではありません。

mergeBaseCommit.commit.author.name string

Git の作成者 ID に記録される名前。

mergeBaseCommit.commit.author.email string

Git の作成者情報に記録されるメールアドレス。

mergeBaseCommit.commit.author.date string

Git作者の識別情報に記録された RFC 3339 形式の日付。

mergeBaseCommit.commit.committer オブジェクト

コミットに記録された Git コミッターの識別情報であり、Origin のユーザーオブジェクトではありません。

mergeBaseCommit.commit.committer.name string

Git の識別情報に記録された名前。

mergeBaseCommit.commit.committer.email string

Git の識別情報に記録されているメールアドレス。

mergeBaseCommit.commit.committer.date string

git署名の元のタイムゾーンオフセットを保持するISO-8601タイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

mergeBaseCommit.commit.message string

コミットメッセージ。

mergeBaseCommit.commit.tree オブジェクト

コミットが参照するツリー。

mergeBaseCommit.commit.tree.sha string

コミットが参照するツリーの SHA。

mergeBaseCommit.parents 配列

親コミットへの参照。それぞれ SHA を含みます。

mergeBaseCommit.parents[].sha string

親コミットの SHA。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/compare/BASE...HEAD' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "status": "ahead",  "aheadBy": 2,  "behindBy": 0,  "baseCommit": {    "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8",    "commit": {      "author": {        "name": "Jane Doe",        "email": "[email protected]",        "date": "2026-08-01T09:30:00Z"      },      "committer": {        "name": "Jane Doe",        "email": "[email protected]",        "date": "2026-08-01T09:30:00Z"      },      "message": "Add launch telemetry",      "tree": {        "sha": "a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8"      }    },    "parents": [      {        "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"      }    ],    "stats": {      "additions": 128,      "deletions": 46,      "total": 174    }  },  "headCommit": {    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "commit": {      "author": {        "name": "Jane Doe",        "email": "[email protected]",        "date": "2026-08-01T09:30:00Z"      },      "committer": {        "name": "Jane Doe",        "email": "[email protected]",        "date": "2026-08-01T09:30:00Z"      },      "message": "Add launch telemetry",      "tree": {        "sha": "a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8"      }    },    "parents": [      {        "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"      }    ],    "stats": {      "additions": 128,      "deletions": 46,      "total": 174    }  },  "mergeBaseCommit": {    "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8",    "commit": {      "author": {        "name": "Jane Doe",        "email": "[email protected]",        "date": "2026-08-01T09:30:00Z"      },      "committer": {        "name": "Jane Doe",        "email": "[email protected]",        "date": "2026-08-01T09:30:00Z"      },      "message": "Add launch telemetry",      "tree": {        "sha": "a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8"      }    },    "parents": [      {        "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"      }    ],    "stats": {      "additions": 128,      "deletions": 46,      "total": 174    }  }}

リスト比較ファイル

GET/v1/origin/repos/{ownerSlug}/{repoName}/compare/{basehead}/files

Scoperepository:contents:readAuthInstallation tokenUser access token

比較によって変更されたファイルを一覧表示します。すなわち、base と head のマージベースに対する head の差分です。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

basehead string 必須

"{base}...{head}"。各リビジョンには SHA、ブランチ、タグ、または HEAD のようなシンボリック参照を指定できます。

クエリパラメータ

pageSize integer

返す変更ファイルの最大数。未指定または0の場合はデフォルトで30になります。100を超える値は100に制限されます。

pageToken string

レスポンスフィールド

files 配列

files[].filename string

変更されたファイルのパス。

files[].status string

変更ステータス: 追加、削除、変更、名前変更、またはコピー。

files[].additions 整数

ファイルの行数を追加しました。

files[].deletions integer

ファイルの削除行数。

files[].changes integer

ファイル内で変更された行の合計数。

files[].patch string

統合形式のパッチ。バイナリファイルの場合は空です。

files[].previousFilename string

ファイルが名前変更またはコピーされたときの以前のパス。

nextPageToken string

次のページ用の不透明なカーソル。これ以上ファイルがない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/compare/BASE...HEAD/files' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "files": [    {      "filename": "src/telemetry.ts",      "status": "modified",      "additions": 6,      "deletions": 3,      "changes": 9,      "patch": "@@ -12,6 +12,9 @@\n import { ignite } from \"./ignition\";\n+import { emitLaunchTelemetry } from \"./telemetry\";\n"    }  ]}

コンテンツを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/contents

Scoperepository:contents:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

クエリパラメータ

path string

リポジトリのルートからの相対ファイルまたはディレクトリパス。空の場合はルートディレクトリを返します。

ref string

レスポンスフィールド

type string

コンテンツの種類。file または dir。

encoding string

ファイルエンコーディング。ファイルのレスポンスには base64 を使用します。

size string

name string

ファイルまたはディレクトリのベース名。

path string

リポジトリのルートからの相対パス。

sha string

ファイルの場合は Blob SHA、ディレクトリの場合は tree SHA。

content string

base64エンコードされたファイル本文。取得したファイルに含まれます。

entries array

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/contents' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "type": "file",  "encoding": "base64",  "size": "312",  "name": "telemetry.ts",  "path": "src/telemetry.ts",  "sha": "c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0",  "content": "Y29uc29sZS5sb2coImxhdW5jaCIpOwo="}

コンテンツを一括取得

POST/v1/origin/repos/{ownerSlug}/{repoName}/contents:batchGet

Scoperepository:contents:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

所有者エンティティ内で一意のリポジトリ名。

リクエスト本文

paths array 必須

ref string

読み取り元のコミット、ブランチ、タグ、またはシンボリック参照 (例: HEAD) 。空の場合はリポジトリのデフォルトブランチを使用します。

レスポンスフィールド

results array

返された各正確なパスごとに1件の結果を返し、最初に見つかったリクエストの順序を保持します。

results[].path string

この結果に対応するリクエストパス。

results[].found boolean

解決されたコミット時点でリクエストされたパスが存在するかどうか。

results[].content オブジェクト

found が true の場合のコンテンツ値。found が false の場合は省略されます。

results[].content.type string

コンテンツの種類: ファイルまたはディレクトリ。

results[].content.encoding string

ファイルのエンコーディング。ファイル応答は base64 を使用します。

results[].content.size string

results[].content.name string

ファイルまたはディレクトリのベース名。

results[].content.path string

リポジトリのルートからの相対パス。

results[].content.sha string

ファイルの場合は Blob SHA、ディレクトリの場合は tree SHA。

results[].content.content string

Base64 エンコードされたファイル本文。取得したファイルに含まれます。

results[].content.entries array

ディレクトリの直接のスパースな子要素。エントリには type、name、path、sha、size が含まれます。子のパスを取得してその内容を読み取ります。

resolvedCommitSha string

リクエストした ref が解決されたコミット SHA。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/contents:batchGet' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "paths": [    "src/telemetry.ts"  ],  "ref": "main"}'

レスポンスの構造:

{  "results": [    {      "path": "src/telemetry.ts",      "found": true,      "content": {        "type": "file",        "encoding": "base64",        "size": "312",        "name": "telemetry.ts",        "path": "src/telemetry.ts",        "sha": "c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0",        "content": "Y29uc29sZS5sb2coImxhdW5jaCIpOwo="      }    }  ],  "resolvedCommitSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"}

コンテンツをGrep検索

POST/v1/origin/repos/{ownerSlug}/{repoName}:grep

Scoperepository:contents:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

リポジトリ名。オーナーエンティティ内で一意です。

リクエスト本文

ref 文字列

検索対象のコミット、ブランチ、タグ、またはシンボリック参照 (例: HEAD) 。空の場合はリポジトリのデフォルトブランチが対象になります。

query 文字列必須

literal boolean

query を正規表現ではなく完全一致のテキストとして検索します。

caseInsensitive boolean

wholeWord boolean

contextBefore integer

各一致行の直前の何行をコンテキストとして返すか。10 を超える値は 10 に丸められます。

contextAfter integer

一致した各行の直後からコンテキストとして返す行数。10 を超える値は 10 に切り捨てられます。

filterPath 文字列

includes 配列

excludes 配列

maxResults integer

レスポンスフィールド

matches 配列

一致した行とそのコンテキスト行。ファイルおよび行が返される順序は規定されておらず、同一のリクエストでも異なる場合があります。

matches[].path 文字列

リポジトリのルートからの相対パスで指定するファイルのパス。

matches[].lineNumber integer

ファイル内におけるこの行の行番号 (1 始まり)。

matches[].line 文字列

行のテキスト (末尾の行終端文字を除く) 。

matches[].kind 文字列

この行がマッチを含むか、コンテキストとして返されたか。許可される値: match、context。

matches[].submatches 配列

matches[].submatches[].start integer

行内でのマッチの先頭バイトのバイトオフセット。

matches[].submatches[].end integer

行内のマッチの最終バイトの1バイト後を指すバイトオフセット。

limitHit boolean

検索が maxResults に達したかどうか。query、filterPath、または glob リストを絞り込んで、検索対象のファイルを減らしてください。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME:grep' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "ref": "main",  "query": "emitLaunchTelemetry\\(",  "contextBefore": 1,  "contextAfter": 1,  "includes": [    "*.ts"  ],  "excludes": [    "**/node_modules/**"  ],  "maxResults": 50}'

{  "matches": [    {      "path": "src/telemetry.ts",      "lineNumber": 11,      "line": "export function emitLaunchTelemetry(stage: string): void {",      "kind": "match",      "submatches": [        {          "start": 16,          "end": 37        }      ]    },    {      "path": "src/telemetry.ts",      "lineNumber": 12,      "line": "  console.log(\"launch\", stage);",      "kind": "context",      "submatches": []    }  ],  "limitHit": false}

Git データ

Blob を取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/git/blobs/{sha}

Scoperepository:contents:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

sha 文字列必須

blob オブジェクトの完全または省略形の 16 進数 SHA。

レスポンスフィールド

sha 文字列

Git blob オブジェクトの SHA。

size integer

JSON 数値としてのデコード後の blob サイズ。4 MiB を超える blob は JSON エンドポイントで拒否されます。

encoding 文字列

JSON blob レスポンスでは base64 エンコーディングを使用します。

content 文字列

base64 エンコードされた blob バイト。呼び出し元は Accept: application/vnd.origin.raw を指定して生のバイトをリクエストできます。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/blobs/SHA' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "sha": "c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0",  "size": 312,  "encoding": "base64",  "content": "Y29uc29sZS5sb2coImxhdW5jaCIpOwo="}

Gitコミットを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/git/commits/{sha}

Scoperepository:contents:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

sha string 必須

レスポンスフィールド

sha string

完全な16進数のコミットSHA。

author object

Gitオブジェクトの作成者の署名。

author.name string

Gitの識別情報に記録された名前。

author.email string

GitのIDに記録されたメールアドレス。

author.date string

git署名の元のタイムゾーンオフセットを保持したISO-8601タイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

committer object

Gitオブジェクトからのコミッター署名。

committer.name string

Gitの識別情報に記録された名前。

committer.email string

GitのIDに記録されたメールアドレス。

committer.date string

git署名の元のタイムゾーンオフセットを保持したISO-8601タイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

message string

コミットメッセージ全文。

tree object

このコミットが指すツリー。

tree.sha string

コミットが参照するツリーの SHA。

parents array

親コミットのSHA (ルートコミットの場合は空です) 。

parents[].sha string

親コミットのSHA。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/commits/SHA' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "author": {    "name": "Jane Doe",    "email": "[email protected]",    "date": "2026-08-01T09:30:00Z"  },  "committer": {    "name": "Jane Doe",    "email": "[email protected]",    "date": "2026-08-01T09:30:00Z"  },  "message": "Add launch telemetry",  "tree": {    "sha": "a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8"  },  "parents": [    {      "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"    }  ]}

ファイルから commit を作成

POST/v1/origin/repos/{ownerSlug}/{repoName}/git/commits:createFromFiles

Scoperepository:contents:writeAuthInstallation tokenUser access token

インラインのファイル変更からブランチにコミットを作成し、ブランチをそのコミットまで進めます。

ブランチは事前に存在している必要があります。まず Create Git Ref で作成してから、そのブランチにコミットしてください。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意の slug。

repoName string 必須

リポジトリ名。オーナーエンティティ内で一意です。

リクエストボディ

targetBranch string 必須

expectedHeadSha string 必須

ターゲットブランチが現在指している必要がある完全な16進SHA。これが新しいコミットの親になります。すべてゼロのSHAは拒否されます。

message string 必須

コミットメッセージ。

author object 必須

コミットの作成者。タイムスタンプはサーバー側で付与されます。

author.name string 必須

Git の ID に記録されている名前。

author.email string 必須

Git IDに記録されているメールアドレス。

committer オブジェクト

コミットのコミッター。省略時は author が使用されます。

committer.name string

Git IDに記録される名前。committer が指定されている場合は必須です。

committer.email string

Git IDに記録されているメールアドレス。committer がある場合は必須です。

files array 必須

ブランチの tip の tree に適用されるファイル変更です。変更は少なくとも 1 つ必要で、パスは 1 つのリクエスト内で一意である必要があります。

files[].path string 必須

/ 区切りで表したリポジトリからの相対パス (例: docs/changelog.md) 。

files[].content string

files[].delete boolean

ファイルを削除します。指定する場合は true にする必要があります。files[].content と files[].delete のうち、いずれか一方のみを指定してください。

files[].encoding string

files[].content のエンコーディング。指定できる値: utf-8 (デフォルト) 、base64。削除の場合は無視されます。

files[].mode string

レスポンスフィールド

sha string

新しいコミットの SHA。現在のブランチの tip です。

treeSha string

新しい commit のルート tree の SHA。

previousHeadSha string

書き込み前のブランチ先端。新しいコミットの親になります。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/commits:createFromFiles' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "targetBranch": "feature/login",  "expectedHeadSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "message": "Add login telemetry",  "author": {    "name": "Jane Doe",    "email": "[email protected]"  },  "files": [    {      "path": "src/login/telemetry.ts",      "content": "export const LOGIN_EVENT = 1;"    },    {      "path": "assets/login.png",      "content": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==",      "encoding": "base64"    },    {      "path": "src/login/legacy.ts",      "delete": true    }  ]}'

レスポンスの構造:

{  "sha": "5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9a8b7c6d",  "treeSha": "a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8",  "previousHeadSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"}

Git リファレンスを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/git/ref/{ref}

Scoperepository:contents:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

ref 文字列必須

レスポンスフィールド

ref 文字列

完全なリファレンス名。例: "refs/heads/main"。

object オブジェクト

object.sha 文字列

ターゲットオブジェクトの 16 進数 SHA。

object.type 文字列

"commit"、"tree"、"blob"、または "tag" のいずれか。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/ref/REF' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "ref": "refs/heads/main",  "object": {    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "type": "commit"  }}

Git Ref の作成

POST/v1/origin/repos/{ownerSlug}/{repoName}/git/refs

Scoperepository:contents:writeAuthInstallation tokenUser access token

既存の commit を指すブランチリファレンスを作成します。

Path Parameters

ownerSlug string 必須

所有エンティティの unique slug。

repoName string 必須

オーナーエンティティ内で一意なリポジトリ名。

Request Body

ref string 必須

作成するブランチリファレンス。refs/heads/<branch> または heads/<branch> の形式で指定します。

sha string 必須

新しいブランチが指す既存の commit の完全な hex SHA。

Response Fields

ref string

完全なリファレンス名。例: "refs/heads/main"。

object object

このリファレンスが直接指している object (展開されていないもの) 。ブランチの場合、object.type は "commit" です。

object.sha string

ターゲット object の hex SHA。

object.type string

"commit"、"tree"、"blob"、"tag" のいずれか。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/refs' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "ref": "refs/heads/feature/login",  "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"}'

レスポンスの構造:

{  "ref": "refs/heads/feature/login",  "object": {    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "type": "commit"  }}

Git リファレンスを削除

DELETE/v1/origin/repos/{ownerSlug}/{repoName}/git/refs/{ref}

Scoperepository:contents:writeAuthInstallation tokenUser access token

ブランチのリファレンスを削除します。レスポンス本文は空です。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

ref 文字列必須

削除するブランチのリファレンス。refs/heads/<branch> または heads/<branch> の形式で指定します。

レスポンスフィールド

成功したリクエストではレスポンス本文は返されません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/refs/REF' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンス:

204 No Content

一致する Git リファレンスを一覧表示

GET/v1/origin/repos/{ownerSlug}/{repoName}/git/matching-refs

Scoperepository:contents:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

クエリパラメータ

ref 文字列

レスポンスフィールド

レスポンスは配列です。各項目には次が含まれます。

ref 文字列

完全なリファレンス名。例: "refs/heads/main"。

object オブジェクト

object.sha 文字列

ターゲットオブジェクトの 16 進数 SHA。

object.type 文字列

"commit"、"tree"、"blob"、または "tag" のいずれか。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/matching-refs' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "refs": [    {      "ref": "refs/heads/main",      "object": {        "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",        "type": "commit"      }    }  ]}

パスで一致する Git リファレンスを一覧表示

GET/v1/origin/repos/{ownerSlug}/{repoName}/git/matching-refs/{ref}

Scoperepository:contents:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

ref 文字列必須

レスポンスフィールド

レスポンスは配列です。各項目には以下が含まれます。

ref 文字列

完全なリファレンス名。例: "refs/heads/main"。

object オブジェクト

object.sha 文字列

ターゲットオブジェクトの 16 進数 SHA。

object.type 文字列

"commit"、"tree"、"blob"、または "tag" のいずれか。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/matching-refs/REF' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "refs": [    {      "ref": "refs/heads/main",      "object": {        "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",        "type": "commit"      }    }  ]}

タグを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/git/tags/{sha}

Scoperepository:contents:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

sha string 必須

注釈付きタグオブジェクトの完全な、または省略形式の 16 進数 SHA。

レスポンスフィールド

sha string

タグオブジェクトの SHA (16 進数) 。

tag string

タグ名 (例: "v1.0") 。

message string

タグメッセージ。

tagger object

タグオブジェクトに記録されたタグ作成者の署名。

tagger.name string

Git ID に記録された名前。

tagger.email string

Git ID に記録されたメールアドレス。

tagger.date string

Git 署名の元のタイムゾーンオフセットを保持する ISO-8601 タイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

object object

このタグが指すオブジェクト。

object.sha string

ターゲットオブジェクトの 16 進数 SHA。

object.type string

"commit"、"tree"、"blob"、または "tag" のいずれか。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/tags/SHA' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "sha": "e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2",  "tag": "v1.2.0",  "message": "Release v1.2.0",  "tagger": {    "name": "Jane Doe",    "email": "[email protected]",    "date": "2026-08-01T09:30:00Z"  },  "object": {    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "type": "commit"  }}

ツリーを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/git/trees/{sha}

Scoperepository:contents:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーに対して一意のリポジトリ名。

sha string 必須

ツリー SHA、コミット SHA、ブランチ、タグ、または HEAD のようなシンボリックリファレンス。

クエリパラメータ

recursive boolean

レスポンスフィールド

sha string

ツリーオブジェクトの SHA (16進数) 。

tree array

このツリー配下のエントリ (直下の子、またはツリー全体の再帰的走査) 。

tree[].path string

リクエストされたツリーのルートからの相対パス。

tree[].mode string

8進数文字列としての Git モード: "100644"、"100755"、"040000"、"120000"、"160000"。

tree[].type string

"blob"、"tree"、または"commit" (gitlink/サブモジュール) のいずれか。

tree[].sha string

オブジェクト SHA (16進)。

tree[].size integer

truncated boolean

再帰的なツリー一覧が省略されている場合に true となることがあります。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/git/trees/SHA' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "sha": "a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8",  "tree": [    {      "path": "src/telemetry.ts",      "mode": "100644",      "type": "blob",      "sha": "c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0",      "size": 312    }  ],  "truncated": false}

Grants

リポジトリのグラント一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/grants

Scoperepository:settings:readAuthInstallation tokenUser access token

パスパラメーター

ownerSlug string 必須

所有エンティティの一意な slug。

repoName string 必須

リポジトリ名。オーナーエンティティ内で一意です。

クエリパラメータ

pageSize integer

返す grants の最大数。未設定または 0 の場合は 30 がデフォルトです。100 を超える値は 100 に制限されます。

pageToken string

レスポンスフィールド

grants 配列

grants[].user object

ユーザー principal。user、group、teamGroup のうち、いずれか 1 つのみが存在します。

grants[].user.id string

ユーザーの公開識別子。プレフィックスはuser_です。

grants[].user.email string

ユーザーのメールアドレス。

grants[].user.displayName string

grants[].user.handle string

grants[].group オブジェクト

Cherri Code のグループのプリンシパルです。所有者のチームが所有するグループ、またはそのチームの組織内のグループを指します。

grants[].group.id string

グループの公開識別子。grp_ のプレフィックスが付きます。

grants[].teamGroup オブジェクト

所有元チームの組み込みグループの 1 つ。リポジトリ自体に対して付与されるもので、オーナーから継承されたものとは別のものです。

grants[].teamGroup.kind string

grant を保持する built-in グループ。指定可能な値: members、admins。

grants[].permission string

repository object

このレスポンス内の各grantが属するリポジトリ。Get Repo と同じフィールドを持ちます。

nextPageToken string

次のページを取得するための opaque cursor。以降のページがない場合は空になります。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/{ownerSlug}/{repoName}/grants' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "grants": [    {      "group": {        "id": "grp_01k2ja2000e0080000000000n2"      },      "permission": "admin"    },    {      "teamGroup": {        "kind": "admins"      },      "permission": "admin"    },    {      "teamGroup": {        "kind": "members"      },      "permission": "write"    },    {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      },      "permission": "read"    }  ],  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  },  "nextPageToken": ""}

リポジトリのグラントをアップサート

POST/v1/origin/repos/{ownerSlug}/{repoName}/grants

Scoperepository:settings:writeAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意の slug。

repoName string 必須

リポジトリ名。オーナーエンティティ内で一意である必要があります。

リクエストボディ

user オブジェクト

ユーザープリンシパル。user、group、または teamGroup のうち正確に1つが存在します。

user.id string

ユーザーの公開識別子。接頭辞は user_ です。

user.email string

ユーザーのメールアドレス。

user.displayName string

user.handle string

group オブジェクト

Cherri Code のグループプリンシパル: 所有者のチームが所有するグループ、またはそのチームの組織に属するグループ。

group.id string

グループの公開識別子。プレフィックスは grp_ です。

teamGroup オブジェクト

所有チームの組み込みグループのうちの1つで、リポジトリ自体に付与され、オーナーから継承されるものとは別のものです。

teamGroup.kind string

grant を保持する built-in グループ。指定可能な値: members、admins。

permission string 必須

付与する権限。指定可能な値: read、write、admin。custom は InvalidArgument (HTTP 400) を返します。カスタムポリシーはこの API の対象外です。

レスポンスフィールド

user オブジェクト

ユーザープリンシパル。user、group、teamGroup のうち、必ず 1 つだけが含まれます。

user.id string

ユーザーの公開識別子。プレフィックスは user_ です。

user.email string

ユーザーのメールアドレス。

user.displayName string

user.handle string

group オブジェクト

Cherri Code のグループ主体: 所有者のチームが所有するグループ、またはそのチームの組織内のグループ。

group.id string

グループの公開識別子。プレフィックスは grp_ です。

teamGroup オブジェクト

所有チームの組み込みグループのうちの1つで、リポジトリ自体に付与され、オーナーから継承されるグループとは別のものです。

teamGroup.kind string

grant を保持する組み込みグループ。許可される値: members、admins。

permission string

プリンシパルが現在リポジトリに対して保持している権限です。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/grants' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "user": {    "id": "user_01k2ja2000e0080000000000c3"  },  "permission": "write"}'

レスポンスの構造:

{  "user": {    "id": "user_01k2ja2000e0080000000000c3",    "email": "[email protected]"  },  "permission": "write"}

リポジトリの Grant を削除

DELETE/v1/origin/repos/{ownerSlug}/{repoName}/grants

Scoperepository:settings:writeAuthInstallation tokenUser access token

Path Parameters

ownerSlug string Required

所有エンティティの一意な slug。

repoName string Required

オーナーエンティティ内で一意な repo 名。

Request Body

user object

user の principal。user、group、teamGroup のいずれか 1 つだけが含まれます。

user.id string

user の public 識別子。user_ のプレフィックスが付きます。

user.email string

user の email アドレス。

user.displayName string

user.handle string

user が取得した profile の handle (@ プレフィックスなし) 。その profile が public に表示されている間のみ含まれ、それ以外では省略されます。

group object

Cherri Code group の principal。owner のチームが所有する group、またはそのチームの organization 内の group です。

group.id string

group の public 識別子。grp_ のプレフィックスが付きます。

teamGroup object

所有チームの built-in グループのいずれか。リポジトリ自体に付与されたもので、owner から継承されたものとは区別されます。

teamGroup.kind string

どの built-in グループが grant を保持しているか。指定可能な値: members、admins。

Response Fields

成功したリクエストは response body を返しません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/grants' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "group": {    "id": "grp_01k2ja2000e0080000000000n2"  }}'

レスポンス:

204 No Content

namespace の grants 一覧を取得

GET/v1/origin/owners/{ownerSlug}/grants

Scopenamespace:settings:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

グラントを一覧表示する対象の所有者の slug。

クエリパラメータ

pageSize integer

返すグラントの最大数。未設定または 0 の場合は 30 がデフォルトです。100 を超える値は 100 に制限されます。

pageToken string

レスポンスフィールド

grants 配列

grants[].user object

ユーザー主体。user、group、または teamGroup のうち、正確に 1 つのみが存在します。

grants[].user.id string

ユーザーの公開識別子。接頭辞は user_ です。

grants[].user.email string

ユーザーのメールアドレス。

grants[].user.displayName string

grants[].user.handle string

grants[].group オブジェクト

Cherri Code のグループプリンシパル: 所有者のチームが所有するグループ、またはそのチームの組織に所属するグループ。

grants[].group.id string

グループの公開識別子。プレフィックスはgrp_です。

grants[].teamGroup オブジェクト

所有チームの built-in グループのいずれか。チームがオーナーに対して持つデフォルトのアクセス権です。

grants[].teamGroup.kind string

grant を保持する built-in グループ。指定可能な値: members、admins。

grants[].permission string

nextPageToken string

次のページの不透明なカーソル。これ以上ページがない場合は空になります。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/owners/{ownerSlug}/grants' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "grants": [    {      "group": {        "id": "grp_01k2ja2000e0080000000000n2"      },      "permission": "PERMISSION_ADMIN"    },    {      "teamGroup": {        "kind": "admins"      },      "permission": "PERMISSION_ADMIN"    },    {      "teamGroup": {        "kind": "members"      },      "permission": "PERMISSION_CONTRIBUTOR"    },    {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      },      "permission": "PERMISSION_WRITE"    }  ],  "nextPageToken": ""}

Namespace Grant の Upsert

POST/v1/origin/owners/{ownerSlug}/grants

Scopenamespace:settings:writeAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

オーナーの slug。

リクエストボディ

user オブジェクト

ユーザーのプリンシパルです。user、group、teamGroup のうち正確に 1 つが存在します。

user.id string

ユーザーの公開識別子。プレフィックスは user_ です。

user.email string

ユーザーのメールアドレス。

user.displayName string

user.handle string

group オブジェクト

Cherri Code のグループプリンシパル：所有者のチームが所有するグループ、またはそのチームの組織に属するグループ。

group.id string

グループの公開識別子。接頭辞は grp_ です。

teamGroup オブジェクト

所有チームの組み込みグループの一つ: オーナーに対するチームのデフォルトのアクセス権。

teamGroup.kind string

grant を保持する組み込みグループ。指定可能な値: members、admins。

permission string 必須

レスポンスフィールド

user オブジェクト

ユーザープリンシパル。user、group、または teamGroup のうち正確に1つが存在します。

user.id string

ユーザーの公開識別子。プレフィックスは user_ です。

user.email string

ユーザーのメールアドレス。

user.displayName string

user.handle string

group オブジェクト

Cherri Code のグループプリンシパル: 所有者のチームが所有するグループ、またはそのチームの組織内のグループ。

group.id string

グループの公開識別子。grp_ というプレフィックスが付きます。

teamGroup オブジェクト

所有チームの built-in グループのいずれか。オーナーに対するチームのデフォルトのアクセス権です。

teamGroup.kind string

grant を保持する組み込みグループ。許可される値: members、admins。

permission string

プリンシパルがオーナー配下のすべてのリポジトリに対して現在保持している権限。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/owners/OWNER_SLUG/grants' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "user": {    "id": "user_01k2ja2000e0080000000000c3"  },  "permission": "PERMISSION_WRITE"}'

レスポンスの構造:

{  "user": {    "id": "user_01k2ja2000e0080000000000c3",    "email": "[email protected]"  },  "permission": "PERMISSION_WRITE"}

Namespace grant の削除

DELETE/v1/origin/owners/{ownerSlug}/grants

Scopenamespace:settings:writeAuthInstallation tokenUser access token

パスパラメータ

ownerSlug 文字列 Required

Owner の slug。

リクエスト本文

user オブジェクト

user principal。user、group、teamGroup のうち、いずれか 1 つのみが存在します。

user.id 文字列

user の公開識別子。プレフィックスは user_。

user.email 文字列

user の email address。

user.displayName 文字列

user.handle 文字列

user が取得した profile の handle (@ プレフィックスなし) 。その profile が公開されている間のみ存在し、それ以外では省略されます。

group オブジェクト

Cherri Code group の principal。owner のチームが所有する group、またはそのチームの organization 内の group です。

group.id 文字列

group の公開識別子。プレフィックスは grp_。

teamGroup オブジェクト

owning team の built-in グループのいずれか。owner に対するチームの default アクセスを表します。

teamGroup.kind 文字列

grant を保持している built-in グループ。指定可能な値: members、admins。

レスポンスフィールド

成功した requests はレスポンス本文を返しません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/owners/OWNER_SLUG/grants' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "group": {    "id": "grp_01k2ja2000e0080000000000n2"  }}'

レスポンス:

204 No Content

ラベル

ラベルを一覧表示

GET/v1/origin/repos/{ownerSlug}/{repoName}/labels

Scoperepository:labels:readAuthInstallation tokenUser access token

リポジトリに定義されているラベルを名前順に一覧表示します。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

クエリパラメータ

pageSize integer

返すラベルの最大数。省略時またはゼロの場合はデフォルトで30となり、100を超える値は100に制限されます。

pageToken 文字列

レスポンスフィールド

labels 配列

名前順のラベル定義のページ。

labels[].id 文字列

ラベルの公開識別子。

labels[].name 文字列

リポジトリ内で一意のラベル名。読み取りおよび書き込みエンドポイントでは、名前でラベルを指定します。

labels[].color 文字列

先頭の # を除く6桁の16進数カラーコード。

labels[].description 文字列

ラベルの説明。ラベルに説明がない場合は含まれません。

nextPageToken 文字列

次のページ用の不透明なカーソル。結果がこれ以上ない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/labels' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "labels": [    {      "id": "lbl_01k2ja2000e0080000000000m1",      "name": "bug",      "color": "d73a4a",      "description": "Something isn't working"    }  ]}

ラベルを作成

POST/v1/origin/repos/{ownerSlug}/{repoName}/labels

Scoperepository:labels:writeAuthInstallation tokenUser access token

リポジトリにラベルを作成します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

リクエスト本文

name string 必須

ラベル名。先頭と末尾の空白はトリミングされます。最大長: 50文字。

color string 必須

先頭の # を除く6文字の16進数カラーコード。大文字の入力は小文字で保存されます。

description string

ラベルの説明。最大長: 255文字。

レスポンスフィールド

id string

ラベルの公開識別子。

name string

リポジトリ内で一意のラベル名。読み取りおよび書き込みエンドポイントでは、この名前でラベルを指定します。

color string

先頭の # を除く6文字の16進数カラーコード。

description string

ラベルの説明。説明がない場合は含まれません。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/labels' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "name": "bug",  "color": "d73a4a",  "description": "Something isn'\''t working"}'

レスポンスの構造:

{  "id": "lbl_01k2ja2000e0080000000000m1",  "name": "bug",  "color": "d73a4a",  "description": "Something isn't working"}

ラベルを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/labels/{labelName}

Scoperepository:labels:readAuthInstallation tokenUser access token

名前を指定して単一のリポジトリラベルを取得します。

名前が不明な場合は 404 を返します。labelName が空の場合は InvalidArgument (HTTP 400) を返します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

所有エンティティ内で一意のリポジトリ名。

labelName string 必須

ラベル名。検索前に先頭と末尾の空白がトリミングされます。

レスポンスフィールド

id string

ラベルの公開識別子。

name string

リポジトリ内で一意のラベル名。読み取りおよび書き込みエンドポイントでは、この名前でラベルを指定します。

color string

先頭の # を除く6文字の16進数カラーコード。

description string

ラベルの説明。説明がない場合は含まれません。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/labels/LABEL_NAME' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "lbl_01k2ja2000e0080000000000m1",  "name": "bug",  "color": "d73a4a",  "description": "Something isn't working"}

ラベルを削除

DELETE/v1/origin/repos/{ownerSlug}/{repoName}/labels/{labelName}

Scoperepository:labels:writeAuthInstallation tokenUser access token

名前でリポジトリのラベルを削除します。レスポンス本文は空です。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意の slug。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

labelName string 必須

ラベル名。検索前に先頭と末尾の空白がトリミングされます。

レスポンスフィールド

成功したリクエストではレスポンス本文は返されません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/labels/LABEL_NAME' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンス:

204 No Content

ラベルを更新

PATCH/v1/origin/repos/{ownerSlug}/{repoName}/labels/{labelName}

Scoperepository:labels:writeAuthInstallation tokenUser access token

現在の名前で指定したリポジトリラベルを更新します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のslug。

repoName string 必須

所有エンティティ内で一意のリポジトリ名。

labelName string 必須

現在のラベル名。検索前に先頭と末尾の空白はトリミングされます。

リクエスト本文

name string

新しいラベル名。先頭と末尾の空白はトリミングされます。最大50文字。変更しない場合は省略します。

color string

先頭の#を除く6文字の16進数カラーコード。変更しない場合は省略します。

description string

ラベルの説明。最大255文字。変更しない場合は省略します。

レスポンスフィールド

id string

ラベルの公開識別子。

name string

リポジトリ内で一意のラベル名。読み取りおよび書き込みエンドポイントでは、この名前でラベルを指定します。

color string

先頭の#を除く6文字の16進数カラーコード。

description string

ラベルの説明。説明がないラベルでは返されません。

curl --request PATCH \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/labels/LABEL_NAME' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "color": "b60205"}'

レスポンスの構造：

{  "id": "lbl_01k2ja2000e0080000000000m1",  "name": "bug",  "color": "b60205",  "description": "Something isn't working"}

プルリクエスト

プルリクエストの一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls

Scoperepository:pull_requests:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

クエリパラメータ

head string

完全一致するブランチ (head-ref) のフィルター (任意) 。省略するとすべてのブランチを一覧表示します。

state string

pageSize 整数

返す結果の最大件数。デフォルトは30、最大は100です。

pageToken 文字列

author string

base string

direction string

since string

until 文字列

sortBy string

ソートキー。指定できる値は created (作成順、デフォルト) または updated (最終更新時刻) です。その他の値は InvalidArgument (HTTP 400) を返します。

headSha 文字列

stackId 文字列

レスポンスフィールド

pullRequests 配列

PullRequest のスナップショットのページ。レスポンス番号とバージョン番号は JSON 文字列です。

pullRequests[].id string

Stable Origin のプルリクエスト識別子。

pullRequests[].number string

JSON文字列としてエンコードされたリポジトリローカルのプルリクエスト番号。

pullRequests[].state string

プルリクエストの状態 (オープンまたはクローズ) 。マージ済みのプルリクエストはクローズ状態となり、merged は true に設定されます。

pullRequests[].draft boolean

プルリクエストがドラフトかどうか。

pullRequests[].merged boolean

プルリクエストがマージされているかどうか。

pullRequests[].title string

プルリクエストのタイトル。

pullRequests[].body string

プルリクエストの説明本文。

pullRequests[].head オブジェクト

変更元 — マージされる内容。

pullRequests[].head.ref string

Origin に記録されている、この側の ref が指す対象。

pullRequests[].head.sha string

変更の最新版におけるこの側の先端コミットのSHA。

pullRequests[].base オブジェクト

変更のターゲット側 — マージされる先。

pullRequests[].base.ref string

Origin に記録されている、この側の ref が指す対象。

pullRequests[].base.sha string

変更の最新版におけるこの側の先端コミットのSHA。

pullRequests[].author オブジェクト

プルリクエストを作成した公開アクター。

pullRequests[].author.user オブジェクト

アクターのユーザーバリアント。ユーザーがアクションを実行した場合に設定されます。

pullRequests[].author.user.id 文字列

ユーザーの公開識別子。

pullRequests[].author.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

pullRequests[].author.user.displayName string

pullRequests[].author.user.handle string

pullRequests[].author.app オブジェクト

アクターのアプリのバリアント。アプリがアクションを実行したときに設定されます。

pullRequests[].author.app.id string

アプリの公開識別子。

pullRequests[].author.app.displayName 文字列

アプリの登録表示名。アプリを解決できない場合やCherri Codeのファーストパーティ管理アクターの場合は省略されます。

pullRequests[].author.serviceAccount オブジェクト

アクターのサービスアカウントのバリアント。サービスアカウントが操作を行ったときに設定されます。

pullRequests[].author.serviceAccount.id string

サービスアカウントの公開識別子。

pullRequests[].createdAt 文字列

RFC 3339 形式のプルリクエスト作成タイムスタンプ。

pullRequests[].updatedAt string

最新のプルリクエストの更新日時 (RFC 3339形式) 。

pullRequests[].closedAt string

RFC 3339形式のクローズ時刻。クローズ済みまたはマージ済みのプルリクエストに表示される場合があります。

pullRequests[].mergedAt string

RFC 3339形式のマージタイムスタンプ。マージ済みのプルリクエストに表示されることがあります。

pullRequests[].mergeCommitSha string

pullRequests[].additions 整数

現在のプルリクエストのバージョンに追加された行。

pullRequests[].deletions integer

現在のプルリクエストのバージョンで削除された行。

pullRequests[].changedFiles integer

現在のプルリクエストのバージョンで変更されたファイル数。

pullRequests[].labels 配列

現在プルリクエストに割り当てられているラベル。名前順に並べられます。割り当てがない場合は空です。

pullRequests[].labels[].id string

ラベルの公開識別子。

pullRequests[].labels[].name string

リポジトリ内で一意のラベル名。書き込み用エンドポイントでは名前でラベルを指定します。

pullRequests[].labels[].color string

先頭に # を付けない6桁の16進数カラーコード。

pullRequests[].labels[].description 文字列

ラベルの説明。説明がない場合は含まれません。

pullRequests[].stack オブジェクト

pullRequests[].stack.id string

pullRequests[].stack.parentPullRequest オブジェクト

pullRequests[].stack.parentPullRequest.id 文字列

親プルリクエストの Stable Origin 識別子。

pullRequests[].stack.parentPullRequest.number 文字列

JSON文字列としてエンコードされた、親プルリクエストのリポジトリ内番号。

pullRequests[].stack.parentPullRequest.repository オブジェクト

pullRequests[].version オブジェクト

現在の番号付きプルリクエストのバージョンと、その head/base の SHA。

pullRequests[].version.number 文字列

JSON文字列としてエンコードされた単調増加のプルリクエストのバージョン番号。

pullRequests[].version.headSha string

このプルリクエストのこのバージョンで取得された Head SHA。

pullRequests[].version.baseSha string

このプルリクエストのバージョンで取得されたベース SHA。

pullRequests[].version.createdAt string

このプルリクエストのバージョンが作成された日時を示す RFC 3339 タイムスタンプ。

pullRequests[].version.potentialMergeCommit オブジェクト

pullRequests[].version.potentialMergeCommit.state 文字列

pullRequests[].version.potentialMergeCommit.sha 文字列

pullRequests[].version.potentialMergeCommit.baseSha 文字列

nextPageToken string

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "pullRequests": [    {      "id": "pr_01k2ja2000e0080000000000d4",      "number": "17",      "state": "open",      "draft": false,      "merged": false,      "title": "Add launch telemetry",      "body": "Adds structured launch telemetry to the ignition path.",      "head": {        "ref": "add-telemetry",        "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"      },      "base": {        "ref": "add-telemetry-schema",        "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"      },      "author": {        "user": {          "id": "user_01k2ja2000e0080000000000c3",          "email": "[email protected]"        }      },      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "additions": 128,      "deletions": 46,      "changedFiles": 5,      "labels": [        {          "id": "lbl_01k2ja2000e0080000000000m1",          "name": "bug",          "color": "d73a4a",          "description": "Something isn't working"        }      ],      "stack": {        "id": "stk_01k2ja2000e0080000000000s1",        "parentPullRequest": {          "id": "pr_01k2ja2000e0080000000000d3",          "number": "16",          "repository": {            "id": "repo_01k2ja2000e0080000000000q4",            "name": "rocket",            "owner": {              "slug": "acme",              "id": "ns_01k2ja2000e0080000000000p3",              "type": "team"            }          }        }      },      "version": {        "number": "3",        "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",        "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8",        "createdAt": "2026-08-01T09:30:00Z"      }    }  ]}

プルリクエストを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}

Scoperepository:pull_requests:readAuthInstallation tokenUser access token

割り当てられたラベルを含む単一のプルリクエストを返します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

レスポンスフィールド

id string

Stable Origin のプルリクエスト識別子。

number string

JSON文字列としてエンコードされたリポジトリ内のプルリクエスト番号。

state string

プルリクエストの状態: open または closed。マージされたプルリクエストは closed になり、merged が true に設定されます。

draft boolean

プルリクエストがドラフトかどうか。

merged boolean

プルリクエストがマージされているかどうか。

title string

プルリクエストのタイトル。

body string

プルリクエストの説明本文。

head オブジェクト

変更元 — マージされる内容です。

head.ref string

Origin が記録している、この側が指す ref。

head.sha string

変更の最新バージョンにおけるこの側の先端コミットのSHA。

base オブジェクト

変更の対象側 — マージ先。

base.ref string

Origin に記録されている、この側が指す ref。

base.sha string

変更の最新バージョンにおけるこの側の先端コミットのSHA。

author オブジェクト

プルリクエストを作成した公開アクター。

author.user オブジェクト

アクターのユーザー版。ユーザーが操作を実行したときに設定されます。

author.user.id string

ユーザーの公開識別子。

author.user.email string

ユーザーのメールアドレス。user バリアントが存在する場合は常に設定されます。

author.user.displayName string

author.user.handle string

author.app オブジェクト

アクターのアプリのバリアント。アプリが操作を実行したときに設定されます。

author.app.id string

アプリの公開識別子。

author.app.displayName string

アプリの登録表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターの場合は省略されます。

author.serviceAccount オブジェクト

アクターのサービスアカウント版です。サービスアカウントが操作を実行した場合に設定されます。

author.serviceAccount.id string

サービスアカウントの公開識別子。

createdAt 文字列

RFC 3339形式のプルリクエスト作成タイムスタンプ。

updatedAt string

プルリクエストの最終更新の RFC 3339 タイムスタンプ。

closedAt 文字列

RFC 3339形式のクローズタイムスタンプ。クローズ済みまたはマージ済みのプルリクエストに表示されることがあります。

mergedAt string

RFC 3339 形式のマージ日時。マージ済みのプルリクエストに表示されることがあります。

mergeCommitSha string

additions integer

現在のプルリクエストのバージョンで追加された行。

deletions 整数

現在のプルリクエストのバージョンで削除された行。

changedFiles 整数

現在のプルリクエストバージョンで変更されたファイル数。

labels 配列

現在プルリクエストに割り当てられているラベル (名前順) 。割り当てがない場合は空です。

labels[].id 文字列

ラベルの公開識別子。

labels[].name string

リポジトリ内で一意のラベル名。書き込み用エンドポイントでは、この名前でラベルを指定します。

labels[].color string

先頭の # を含まない6桁の16進カラーコード。

labels[].description string

ラベルの説明。ラベルに説明がない場合は表示されません。

stack オブジェクト

stack.id string

stack.parentPullRequest オブジェクト

stack.parentPullRequest.id string

親プルリクエストの Stable Origin 識別子。

stack.parentPullRequest.number string

JSON文字列としてエンコードされた、親プルリクエストのリポジトリ内番号。

stack.parentPullRequest.repository オブジェクト

version object

現在の番号付きプルリクエストのバージョンと、そのヘッド/ベースのSHA。

version.number 文字列

JSON文字列としてエンコードされた、単調増加するプルリクエストのバージョン番号。

version.headSha string

このプルリクエストのバージョンで取得されたHEAD SHA。

version.baseSha string

このプルリクエストのバージョンで取得されたベースSHA。

version.createdAt 文字列

このプルリクエストバージョンの作成日時を示す RFC 3339 タイムスタンプ。

version.potentialMergeCommit オブジェクト

version.potentialMergeCommit.state string

version.potentialMergeCommit.sha string

version.potentialMergeCommit.baseSha string

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "pr_01k2ja2000e0080000000000d4",  "number": "17",  "state": "open",  "draft": false,  "merged": false,  "title": "Add launch telemetry",  "body": "Adds structured launch telemetry to the ignition path.",  "head": {    "ref": "add-telemetry",    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"  },  "base": {    "ref": "add-telemetry-schema",    "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"  },  "author": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "additions": 128,  "deletions": 46,  "changedFiles": 5,  "labels": [    {      "id": "lbl_01k2ja2000e0080000000000m1",      "name": "bug",      "color": "d73a4a",      "description": "Something isn't working"    }  ],  "stack": {    "id": "stk_01k2ja2000e0080000000000s1",    "parentPullRequest": {      "id": "pr_01k2ja2000e0080000000000d3",      "number": "16",      "repository": {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      }    }  },  "version": {    "number": "3",    "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8",    "createdAt": "2026-08-01T09:30:00Z",    "potentialMergeCommit": {      "state": "prepared",      "sha": "c7b6a5948372615049f8e7d6c5b4a3928170605f",      "baseSha": "5e2d1c0b9a8f7e6d5c4b3a2918070605f4e3d2c1"    }  }}

プルリクエストを作成

POST/v1/origin/repos/{ownerSlug}/{repoName}/pulls

Scoperepository:pull_requests:writeAuthInstallation tokenUser access token

head から base へのプルリクエストを作成します。

オプションの parent_pull_number は、この変更を同じリポジトリ内の別のオープンまたはドラフトのプルリクエストに重ねます。

title が256文字を超えるか、body が65,536文字を超えると、InvalidArgument (HTTP 400) が返されます。どちらの制限もUnicodeコードポイント数で数えます。

パスパラメータ

ownerSlug string 必須

所有元エンティティの一意なスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

リクエスト本文

title string 必須

プルリクエストのタイトル。最大長: 256文字。

body string

プルリクエストの本文／説明。空でも可。最大長: 65,536文字。

head string 必須

ソースブランチ名 (変更の先頭) 。呼び出し時にリポジトリ内で解決できる必要があります。

base string 必須

draft boolean

true の場合は下書きとして作成します。false または省略した場合はオープン (レビュー可能) として作成します。

parentPullRequest オブジェクト

parentPullRequest.number string

リポジトリ内の親プルリクエスト番号。

parentPullRequest.id string

親プルリクエストの id (id で返される値) 。

レスポンスフィールド

id string

Stable Origin のプルリクエスト識別子。

number string

リポジトリ内のプルリクエスト番号をJSON文字列としてエンコードしたもの。

state string

プルリクエストの状態。open または closed。マージされたプルリクエストは closed となり、merged が true に設定されます。

draft boolean

プルリクエストがドラフトかどうか。

merged boolean

プルリクエストがマージされているかどうか。

title string

プルリクエストのタイトル。

body string

プルリクエストの説明本文。

head オブジェクト

変更のソース側 — マージされる内容。

head.ref string

Origin に記録されている、この側が参照する ref。

head.sha string

変更の最新バージョンにおけるこの側の先端コミットSHA。

base オブジェクト

変更の対象側 — マージ先。

base.ref string

Origin に記録されている、この側が参照する ref。

base.sha string

変更の最新バージョンにおけるこの側の先端コミット SHA。

author object

プルリクエストを作成した公開アクター。

author.user オブジェクト

アクターのユーザー・バリアント。ユーザーが操作を行った場合に設定されます。

author.user.id string

ユーザーの公開識別子。

author.user.email string

ユーザーのメールアドレス。user バリアントが存在する場合は常に設定されます。

author.user.displayName string

author.user.handle string

author.app オブジェクト

アクターのアプリのバリアント。アプリがアクションを実行したときに設定されます。

author.app.id string

アプリの公開識別子。

author.app.displayName string

アプリに登録された表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターの場合は省略されます。

author.serviceAccount オブジェクト

アクターのサービスアカウントバリアント。サービスアカウントが操作を実行したときに設定されます。

author.serviceAccount.id string

サービスアカウントの公開識別子。

createdAt string

RFC 3339形式のプルリクエスト作成日時。

updatedAt 文字列

最新のプルリクエストの更新時刻 (RFC 3339形式) 。

closedAt 文字列

RFC 3339形式のクローズ時刻。クローズ済みまたはマージ済みのプルリクエストに表示されることがあります。

mergedAt string

RFC 3339形式のマージタイムスタンプ。マージ済みのプルリクエストに表示されることがあります。

mergeCommitSha string

additions integer

現在のプルリクエストのバージョンで追加された行。

deletions integer

現在のプルリクエストのバージョンで削除された行。

changedFiles 整数

現在のプルリクエストバージョンにおける変更ファイル数。

labels array

プルリクエストに現在割り当てられているラベル。名前順に並んでいます。割り当てがない場合は空です。

labels[].id string

ラベルの公開識別子。

labels[].name string

リポジトリ内で一意のラベル名。書き込みエンドポイントではこの名前でラベルを指定します。

labels[].color string

先頭に#のない6桁の16進数カラーコード。

labels[].description string

ラベルの説明。ラベルに説明がない場合は表示されません。

stack オブジェクト

stack.id string

stack.parentPullRequest オブジェクト

stack.parentPullRequest.id 文字列

親プルリクエストの Stable Origin 識別子。

stack.parentPullRequest.number string

親プルリクエストのリポジトリ内番号 (JSON文字列としてエンコード)

stack.parentPullRequest.repository オブジェクト

version オブジェクト

現在の番号付きプルリクエストのバージョンとその head/base の SHA。

version.number string

JSON文字列としてエンコードされた単調増加のプルリクエストのバージョン番号。

version.headSha string

このプルリクエストのバージョンでキャプチャされた Head SHA。

version.baseSha string

このプルリクエストのバージョンで取得されたベースSHA。

version.createdAt 文字列

このプルリクエストバージョンの作成時刻を示す RFC 3339 タイムスタンプ。

version.potentialMergeCommit オブジェクト

version.potentialMergeCommit.state string

version.potentialMergeCommit.sha string

version.potentialMergeCommit.baseSha string

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "title": "Add launch telemetry",  "body": "Adds structured launch telemetry to the ignition path.",  "head": "add-telemetry",  "base": "main",  "draft": false}'

レスポンスの構造:

{  "id": "pr_01k2ja2000e0080000000000d4",  "number": "17",  "state": "open",  "draft": false,  "merged": false,  "title": "Add launch telemetry",  "body": "Adds structured launch telemetry to the ignition path.",  "head": {    "ref": "add-telemetry",    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"  },  "base": {    "ref": "main",    "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"  },  "author": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "additions": 128,  "deletions": 46,  "changedFiles": 5,  "labels": [    {      "id": "lbl_01k2ja2000e0080000000000m1",      "name": "bug",      "color": "d73a4a",      "description": "Something isn't working"    }  ],  "version": {    "number": "3",    "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8",    "createdAt": "2026-08-01T09:30:00Z"  }}

プルリクエストの更新

PATCH/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}

Scoperepository:pull_requests:writeAuthInstallation tokenUser access token

プルリクエストのタイトル、本文、ベースブランチ、スタックの親、ライフサイクル状態のいずれかまたはすべてを更新します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

リクエスト本文

title 文字列

新しいタイトル。省略されたフィールドは変更されません。最大長：256文字。

body string

新しい本文／説明。空の文字列を指定すると本文がクリアされます。最大長: 65,536文字。

state string

draft boolean

base string

parentPullRequest オブジェクト

parentPullRequest.number string

リポジトリ内の親プルリクエスト番号。

parentPullRequest.id 文字列

id で返される親プルリクエスト ID。

parentPullRequest.clear boolean

現在のスタックの親を削除します。true のみ許可されます。

レスポンスフィールド

id string

Stable Origin のプルリクエスト識別子。

number string

JSON文字列としてエンコードされたリポジトリ内のプルリクエスト番号。

state string

プルリクエストの状態。open または closed。マージされたプルリクエストは closed になり、merged が true に設定されます。

draft boolean

プルリクエストがドラフトかどうか。

merged boolean

プルリクエストがマージされているかどうか。

title 文字列

プルリクエストのタイトル。

body string

プルリクエストの説明本文。

head object

変更元側 — マージされる内容。

head.ref string

Origin が記録している、この側が指している ref。

head.sha string

変更の最新バージョン時点でのこの側の先端コミットのSHA。

base オブジェクト

変更の対象側 — マージ先です。

base.ref string

Origin に記録されている、この側が指している ref。

base.sha string

変更の最新バージョン時点でのこの側の先端コミットのSHA。

author object

プルリクエストを作成した公開アクター。

author.user object

アクターのユーザー種別。ユーザーが操作を行ったときに設定されます。

author.user.id string

ユーザーの公開識別子。

author.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

author.user.displayName string

author.user.handle string

author.app オブジェクト

アクターのアプリのバリアント。アプリがアクションを実行したときに設定されます。

author.app.id string

アプリの公開識別子。

author.app.displayName 文字列

アプリに登録されている表示名。アプリを解決できない場合や、Cherri Code のファーストパーティ管理アクターの場合は省略されます。

author.serviceAccount オブジェクト

アクターのサービスアカウント版です。サービスアカウントが操作を実行した場合に設定されます。

author.serviceAccount.id string

サービスアカウントの公開識別子。

createdAt 文字列

RFC 3339形式のプルリクエスト作成タイムスタンプ。

updatedAt string

プルリクエストの最新更新日時を表すRFC 3339タイムスタンプ。

closedAt string

RFC 3339形式のクローズ日時。クローズ済みまたはマージ済みのプルリクエストに表示される場合があります。

mergedAt string

RFC 3339形式のマージタイムスタンプ。マージされたプルリクエストに表示される場合があります。

mergeCommitSha string

additions integer

現在のプルリクエストのバージョンで追加された行。

deletions integer

現在のプルリクエストのバージョンで削除された行。

changedFiles 整数

現在のプルリクエストのバージョンで変更されたファイル数。

labels 配列

このプルリクエストに現在割り当てられているラベル。名前順にソートされています。割り当てがない場合は空です。

labels[].id string

ラベルの公開識別子。

labels[].name string

リポジトリ内で一意のラベル名。書き込み用エンドポイントでは名前でラベルを指定します。

labels[].color 文字列

先頭に # のない6桁の16進カラーコード。

labels[].description string

ラベルの説明。ラベルに説明がない場合は表示されません。

stack オブジェクト

stack.id 文字列

スタックの全メンバーで共有される安定したスタック識別子。他のメンバーを取得するには、これを stackId として List Pull Requests に渡します。

stack.parentPullRequest オブジェクト

stack.parentPullRequest.id 文字列

親プルリクエストの Stable Origin 識別子。

stack.parentPullRequest.number 文字列

JSON文字列としてエンコードされた、親プルリクエストのリポジトリ内番号。

stack.parentPullRequest.repository オブジェクト

version オブジェクト

現在の番号付きプルリクエストのバージョンと、その head/base SHA。

version.number 文字列

JSON文字列としてエンコードされた単調増加するプルリクエストのバージョン番号。

version.headSha string

このプルリクエストのバージョンでキャプチャされたHead SHA。

version.baseSha string

このプルリクエストのバージョンでキャプチャされたベース SHA。

version.createdAt 文字列

このプルリクエストバージョンが作成された日時の RFC 3339 タイムスタンプ。

version.potentialMergeCommit オブジェクト

version.potentialMergeCommit.state 文字列

version.potentialMergeCommit.sha 文字列

version.potentialMergeCommit.baseSha 文字列

curl --request PATCH \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "title": "Add launch telemetry",  "body": "Adds structured launch telemetry to the ignition path.",  "state": "open",  "draft": false,  "base": "main"}'

レスポンスの構造:

{  "id": "pr_01k2ja2000e0080000000000d4",  "number": "17",  "state": "open",  "draft": false,  "merged": false,  "title": "Add launch telemetry",  "body": "Adds structured launch telemetry to the ignition path.",  "head": {    "ref": "add-telemetry",    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"  },  "base": {    "ref": "main",    "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"  },  "author": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z",  "additions": 128,  "deletions": 46,  "changedFiles": 5,  "labels": [    {      "id": "lbl_01k2ja2000e0080000000000m1",      "name": "bug",      "color": "d73a4a",      "description": "Something isn't working"    }  ],  "version": {    "number": "3",    "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8",    "createdAt": "2026-08-01T09:30:00Z"  }}

プルリクエストコメントの一覧取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/comments

Scoperepository:pull_requests:reviews:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

リポジトリ名。所有者エンティティ内で一意です。

pullNumber string 必須

クエリパラメータ

pageSize 整数

返すコメントの最大数。デフォルトは30、最大は100です。

pageToken string

since string

until string

threadIds 配列

レスポンスフィールド

comments 配列

一般コメントとインラインコメントを時系列順のフラットな一覧として表示し、thread.idごとにグループ化します。

comments[].id string

安定したプルリクエストのコメント識別子。

comments[].thread object

このコメントが属するスレッド。diffアンカーと解決状態を含みます。

comments[].thread.id string

スレッドの安定した識別子。この値で同じディスカッション内のコメントをグループ化します。

comments[].thread.version object

comments[].thread.version.number string

JSON文字列としてエンコードされた単調増加するプルリクエストのバージョン番号。

comments[].thread.version.headSha string

このプルリクエストのこのバージョンで取得された HEAD SHA。

comments[].thread.version.baseSha string

このプルリクエストのバージョンで取得されたベース SHA。

comments[].thread.path string

スレッドの差分アンカーのファイルパス。一般ディスカッションのスレッドでは空です。

comments[].thread.side string

アンカーの差分の側。許容値: left、right。general-discussion スレッドでは未設定です。

comments[].thread.startLine 整数

ファイルの side バージョンでアンカーされた範囲の先頭行。ファイルレベルおよび一般ディスカッションのスレッドの場合は 0。

comments[].thread.endLine 整数

アンカー範囲に含まれる最終行。アンカーが単一行であるか行範囲がない場合は 0。

comments[].thread.resolvedAt string

スレッドが解決された時刻のRFC 3339タイムスタンプ。スレッドが未解決の間は未設定です。

comments[].thread.createdAt string

RFC 3339形式のスレッド作成タイムスタンプ。

comments[].thread.updatedAt string

スレッドの最終更新時刻を示すRFC 3339タイムスタンプ。

comments[].body string

コメントの本文。

comments[].author object

コメントを作成した公開アクター。

comments[].author.user object

アクターのユーザーバリアント。ユーザーがアクションを実行したときに設定されます。

comments[].author.user.id string

ユーザーの公開識別子。

comments[].author.user.email string

ユーザーのメールアドレス。ユーザーバリアントが存在する場合は常に設定されます。

comments[].author.user.displayName string

comments[].author.user.handle string

comments[].author.app object

アクターのアプリ版。アプリが操作を実行した場合に設定されます。

comments[].author.app.id string

アプリの公開識別子。

comments[].author.app.displayName string

アプリの登録済み表示名。アプリを解決できない場合およびCherri Codeのファーストパーティ管理アクターの場合は省略されます。

comments[].author.serviceAccount object

アクターのサービスアカウント版。サービスアカウントが操作を実行したときに設定されます。

comments[].author.serviceAccount.id string

サービスアカウントの公開識別子。

comments[].createdAt string

コメント作成時のRFC 3339形式のタイムスタンプ。

comments[].updatedAt string

コメントの最終編集時刻を示すRFC 3339タイムスタンプ。

pullRequest オブジェクト

コメントページとともに含まれるコンテナ PullRequestReference。

pullRequest.id string

安定したプルリクエスト識別子。

pullRequest.number string

JSON文字列としてエンコードされたリポジトリローカルのプルリクエスト番号。

pullRequest.repository オブジェクト

プルリクエストのリポジトリコンテナ参照。

pullRequest.repository.id 文字列

コンテナ参照内のリポジトリ識別子。

pullRequest.repository.name string

コンテナ参照内のリポジトリ名。

pullRequest.repository.owner オブジェクト

リポジトリのオーナー参照。

pullRequest.repository.owner.slug string

リポジトリの所有者を識別するために所有者IDと併用される、URL 表示用のオーナースラッグ。

pullRequest.repository.owner.id string

Origin のオーナー識別子。

pullRequest.repository.owner.type string

オーナー名前空間のタイプ。出力専用。許容値: team、user。不明な場合は省略されます。

nextPageToken string

次のページ用の不透明なカーソル。コメントがこれ以上ない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/comments' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "comments": [    {      "id": "cmt_01k2ja2000e0080000000000e5",      "thread": {        "id": "cth_01k2ja2000e0080000000000s6",        "version": {          "number": "3",          "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",          "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"        },        "path": "src/telemetry/retry.ts",        "side": "right",        "startLine": 42,        "endLine": 45,        "createdAt": "2026-08-01T09:30:00Z",        "updatedAt": "2026-08-02T14:45:00Z"      },      "body": "Should the retry budget be configurable?",      "author": {        "user": {          "id": "user_01k2ja2000e0080000000000c3",          "email": "[email protected]"        }      },      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z"    }  ],  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    }  }}

プルリクエストコメントを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls/comments/{commentId}

Scoperepository:pull_requests:reviews:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナー (所有者) エンティティ内で一意のリポジトリ名。

commentId string 必須

レスポンスフィールド

id string

安定したプルリクエストのコメント識別子。

thread object

このコメントが属するスレッド (差分アンカーと解決状態を含む) 。

thread.id string

スレッドの安定した識別子。この値で1つのディスカッション内のコメントをグループ化します。

thread.version object

thread.version.number string

JSON 文字列としてエンコードされた単調増加するプルリクエストのバージョン番号。

thread.version.headSha string

このプルリクエストのバージョンで取得された Head SHA。

thread.version.baseSha string

このプルリクエストのこのバージョンで取得されたベース SHA。

thread.path string

スレッドの差分アンカーのファイルパス。一般的なディスカッション用スレッドでは空です。

thread.side string

アンカーの差分側。許容値: left、right。一般ディスカッションのスレッドでは未設定にします。

thread.startLine integer

ファイルの side バージョンにおけるアンカー範囲の開始行。ファイル単位のスレッドおよび一般ディスカッションのスレッドでは 0 です。

thread.endLine integer

アンカー範囲に含まれる最後の行。アンカーが単一行であるか行範囲がない場合は 0。

thread.resolvedAt string

スレッドが解決された時点の RFC 3339 タイムスタンプ。スレッドがオープンな間は未設定です。

thread.createdAt string

RFC 3339によるスレッド作成時刻。

thread.updatedAt string

スレッドの最終更新時刻の RFC 3339 タイムスタンプ。

body string

コメント本文。

author object

コメントを作成した公開アクター。

author.user object

アクターのユーザー固有のバリアント。ユーザーがアクションを実行したときに設定されます。

author.user.id string

ユーザーの公開識別子。

author.user.email string

ユーザーのメールアドレス。ユーザーバリアントが存在する場合は常に設定されます。

author.user.displayName string

author.user.handle string

author.app object

アクターのアプリ版。アプリがアクションを実行した場合に設定されます。

author.app.id string

アプリの公開識別子。

author.app.displayName string

アプリに登録された表示名。アプリが解決できない場合、またはCherri Codeのファーストパーティ管理アクターの場合は省略されます。

author.serviceAccount object

アクターのサービスアカウント版。サービスアカウントが操作を実行した場合に設定されます。

author.serviceAccount.id string

サービスアカウントの公開識別子。

createdAt string

コメント作成時の RFC 3339 タイムスタンプ。

updatedAt string

コメントの最終編集時の RFC 3339 タイムスタンプ。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/comments/COMMENT_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "cmt_01k2ja2000e0080000000000e5",  "thread": {    "id": "cth_01k2ja2000e0080000000000s6",    "version": {      "number": "3",      "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"    },    "path": "src/telemetry/retry.ts",    "side": "right",    "startLine": 42,    "endLine": 45,    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z"  },  "body": "Should the retry budget be configurable?",  "author": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z"}

プルリクエストコメントの削除

DELETE/v1/origin/repos/{ownerSlug}/{repoName}/pulls/comments/{commentId}

Scoperepository:pull_requests:reviews:writeAuthInstallation tokenUser access token

安定した Origin ID を指定してプルリクエストコメントを削除します。レスポンス本文は空です。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意の slug。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

commentId string 必須

レスポンスフィールド

成功したリクエストではレスポンス本文は返されません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/comments/COMMENT_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンス:

204 No Content

プルリクエストコメントを作成

POST/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/comments

Scoperepository:pull_requests:reviews:writeAuthInstallation tokenUser access token

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

所有エンティティ内で一意のリポジトリ名。

pullNumber 文字列必須

リクエスト本文

body 文字列必須

コメント本文。最大長: 65,536文字 (Unicodeコードポイント換算)。

threadId 文字列

返信先の既存スレッドID。省略すると新しいスレッドを開きます。versionNumberと併用できません。

inline オブジェクト

新しいインラインスレッド用の差分アンカー。threadId と併用できません。

inline.path 文字列必須

プルリクエストのバージョンの差分内のファイルパス。

inline.side 文字列必須

アンカーの差分側。許可される値: ファイルのベース版はleft、ヘッド版はrightです。

inline.startLine 整数必須

side バージョンのファイルにおけるアンカー範囲の先頭行 (1始まり) 。範囲はそのファイルの末尾を超えてはなりません。

inline.endLine 整数

アンカー範囲の最終行 (この行を含む) 。startLine 以上である必要があります。アンカーが1行のみの場合は省略してください。

file オブジェクト

プルリクエスト版の差分におけるファイル全体に対する、新しいファイルレベルのスレッド用アンカー。threadIdまたはinlineとは併用できません。

file.path 文字列必須

プルリクエスト版の差分内のファイルパス: 削除の場合は削除されたパス、そうでなければ head のパス。

versionNumber 文字列

レスポンスフィールド

id 文字列

安定したプルリクエストコメント識別子。

thread オブジェクト

thread.id 文字列

スレッドの恒久的な識別子。この値で1つのディスカッション内のコメントをグループ化します。

thread.version オブジェクト

スレッドが作成されたプルリクエストのバージョン (head と base の SHA を含む)。アンカーはこのバージョンに固定され、プルリクエストに新しいバージョンが追加されても移動しません。

thread.version.number 文字列

JSON文字列としてエンコードされた単調増加するプルリクエストのバージョン番号。

thread.version.headSha 文字列

このプルリクエストのバージョンで取得されたHead SHA。

thread.version.baseSha 文字列

このプルリクエストのバージョンで取得されたベースSHA。

thread.path 文字列

スレッドの差分アンカーのファイルパス。一般ディスカッションのスレッドでは空です。

thread.side 文字列

アンカーの差分側。許可される値: left、right。一般ディスカッションスレッドでは未設定です。

thread.startLine 整数

ファイルのsideバージョンでアンカーされた範囲の先頭行。ファイルレベルおよび一般ディスカッションのスレッドでは0。

thread.endLine 整数

アンカー範囲の最終行 (含む) 。アンカーが単一行の場合、または行範囲がない場合は 0。

thread.resolvedAt 文字列

スレッドが解決された時点の RFC 3339 タイムスタンプ。スレッドが開いている間は未設定です。

thread.createdAt 文字列

RFC 3339 のスレッド作成タイムスタンプ。

thread.updatedAt 文字列

最新のスレッド更新の RFC 3339 タイムスタンプ。

body 文字列

コメント本文。

author オブジェクト

コメントを作成した公開アクター。

author.user オブジェクト

アクターのユーザー版。ユーザーが操作を行ったときに設定されます。

author.user.id 文字列

ユーザーの公開識別子。

author.user.email 文字列

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

author.user.displayName 文字列

author.user.handle 文字列

author.app オブジェクト

アクターのアプリバリアント。アプリが操作を実行した場合に設定されます。

author.app.id 文字列

アプリの公開識別子。

author.app.displayName 文字列

アプリの登録済み表示名。アプリを解決できない場合やCherri Codeのファーストパーティ管理アクター上では省略されます。

author.serviceAccount オブジェクト

アクターのサービスアカウント版。サービスアカウントが操作を実行したときに設定されます。

author.serviceAccount.id 文字列

サービスアカウントの公開識別子。

createdAt 文字列

コメント作成時のRFC 3339タイムスタンプ。

updatedAt 文字列

最新のコメント編集の RFC 3339 タイムスタンプ。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/comments' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "body": "Should the retry budget be configurable?"}'

レスポンスの構造:

{  "id": "cmt_01k2ja2000e0080000000000e5",  "thread": {    "id": "cth_01k2ja2000e0080000000000s6",    "version": {      "number": "3",      "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"    },    "path": "src/telemetry/retry.ts",    "side": "right",    "startLine": 42,    "endLine": 45,    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z"  },  "body": "Should the retry budget be configurable?",  "author": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z"}

プルリクエストコメントを更新

PATCH/v1/origin/repos/{ownerSlug}/{repoName}/pulls/comments/{commentId}

Scoperepository:pull_requests:reviews:writeAuthInstallation tokenUser access token

永続的なOrigin IDを指定して、プルリクエストコメントを更新します。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意のスラッグ。

repoName 文字列必須

所有者エンティティ内で一意のリポジトリ名。

commentId 文字列必須

リクエスト本文

body 文字列必須

置き換え後のコメント本文。最大長: 65,536文字 (Unicodeコードポイント換算) 。

レスポンスフィールド

id 文字列

安定したプルリクエストのコメント識別子。

thread オブジェクト

このコメントが属するスレッド。差分アンカーと解決状態を含みます。

thread.id 文字列

スレッドの安定した識別子。この値によりコメントを1つのディスカッションにまとめます。

thread.version オブジェクト

thread.version.number 文字列

JSON文字列としてエンコードされた単調増加するプルリクエストのバージョン番号。

thread.version.headSha 文字列

このプルリクエストのバージョンで取得されたHead SHA。

thread.version.baseSha 文字列

このプルリクエストのバージョンで取得されたベース SHA。

thread.path 文字列

スレッドの diff アンカーのファイルパス。一般ディスカッション用スレッドの場合は空です。

thread.side 文字列

アンカーの差分側。許容される値: left, right。general-discussion のスレッドでは未設定になります。

thread.startLine 整数

ファイルのsideバージョンでアンカーされた範囲の先頭行。ファイルレベルおよび一般ディスカッションのスレッドでは0。

thread.endLine 整数

アンカー範囲の最終行 (この行を含む) 。アンカーが単一行の場合、または行範囲がない場合は0。

thread.resolvedAt 文字列

スレッドが解決された日時のRFC 3339タイムスタンプ。スレッドが開いている間は未設定です。

thread.createdAt 文字列

RFC 3339 スレッド作成タイムスタンプ。

thread.updatedAt 文字列

最新のスレッド更新のRFC 3339タイムスタンプ。

body 文字列

コメント本文。

author オブジェクト

コメントを作成した公開アクター。

author.user オブジェクト

アクターのユーザー版。ユーザーがアクションを実行したときに設定されます。

author.user.id 文字列

ユーザーの公開識別子。

author.user.email 文字列

ユーザーのメールアドレス。ユーザーバリアントが存在する場合は常に設定されます。

author.user.displayName 文字列

author.user.handle 文字列

author.app オブジェクト

アプリがアクションを実行した場合に設定される、アクターのアプリバリアント。

author.app.id 文字列

アプリの公開識別子。

author.app.displayName 文字列

アプリに登録された表示名。アプリが解決できない場合や、Cherri Code のファーストパーティ管理アクターでは省略されます。

author.serviceAccount オブジェクト

アクターがサービスアカウントの場合のバリアントです。サービスアカウントが操作を実行した場合に設定されます。

author.serviceAccount.id 文字列

サービスアカウントの公開識別子。

createdAt 文字列

コメント作成時のRFC 3339タイムスタンプ。

updatedAt 文字列

最新のコメント編集のRFC 3339タイムスタンプ。

curl --request PATCH \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/comments/COMMENT_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "body": "Should the retry budget be configurable?"}'

レスポンスの構造:

{  "id": "cmt_01k2ja2000e0080000000000e5",  "thread": {    "id": "cth_01k2ja2000e0080000000000s6",    "version": {      "number": "3",      "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"    },    "path": "src/telemetry/retry.ts",    "side": "right",    "startLine": 42,    "endLine": 45,    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z"  },  "body": "Should the retry budget be configurable?",  "author": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-02T14:45:00Z"}

プルリクエストのスレッドを更新

PATCH/v1/origin/repos/{ownerSlug}/{repoName}/pulls/threads/{threadId}

Scoperepository:pull_requests:reviews:writeAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意なスラッグ。

repoName string 必須

所有者エンティティに固有のリポジトリ名。

threadId string 必須

安定した Origin のスレッド ID。

リクエストボディ

resolved boolean 必須

対象の解決状態。true はスレッドを解決し、false は再度開きます。

レスポンスフィールド

id string

スレッドの安定した ID。この値でコメントを 1 つのディスカッションにまとめます。

version object

version.number string

JSON 文字列としてエンコードされた単調増加のプルリクエストのバージョン番号。

version.headSha string

このプルリクエストのバージョンで取得されたHEAD SHA。

version.baseSha string

このプルリクエストのバージョンで取得されたベース SHA。

path string

スレッドの差分アンカーのファイルパス。一般ディスカッションのスレッドでは空です。

side string

アンカーの差分側。指定可能な値: left、right。一般的な議論のスレッドでは未設定です。

startLine 整数

ファイルの side バージョンにおけるアンカー範囲の先頭行。ファイルレベルおよび一般的なディスカッションのスレッドでは 0 です。

endLine integer

アンカー範囲の最終行 (包含) 。アンカーが単一行の場合、または行範囲がない場合は 0。

resolvedAt string

スレッドが解決された日時のRFC 3339形式タイムスタンプ。スレッドがオープンの間は未設定です。

createdAt string

RFC 3339 形式のスレッド作成タイムスタンプ。

updatedAt string

スレッドの最終更新を示す RFC 3339 形式のタイムスタンプ。

curl --request PATCH \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/threads/THREAD_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "resolved": true}'

レスポンスの構造:

{  "id": "cth_01k2ja2000e0080000000000s6",  "version": {    "number": "3",    "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"  },  "path": "src/telemetry/retry.ts",  "side": "right",  "startLine": 42,  "endLine": 45,  "resolvedAt": "2026-08-03T10:00:00Z",  "createdAt": "2026-08-01T09:30:00Z",  "updatedAt": "2026-08-03T10:00:00Z"}

プルリクエストのコミット一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/commits

Scoperepository:pull_requests:readAuthInstallation tokenUser access token

プルリクエスト内のコミットを一覧表示します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

クエリパラメータ

pageSize integer

返されるコミットの最大数。未設定または0の場合のデフォルトは30です。100を超える値は100に制限されます。

pageToken string

レスポンスフィールド

commits 配列

統計情報のないスパースコミット。全体で表示されるコミットは最大250件です。

commits[].sha string

コミットの完全な SHA。

commits[].commit オブジェクト

トップレベルのリポジトリ関係とは別にネストされた Git オブジェクトのメタデータ。

commits[].commit.author object

コミットに記録された Git の作成者識別情報であり、Origin のユーザーオブジェクトではありません。

commits[].commit.author.name string

Git 作成者の ID に記録された名前。

commits[].commit.author.email string

Git の作成者 ID に記録されているメールアドレス。

commits[].commit.author.date string

Git 作成者 ID に記録された RFC 3339 形式の日付。

commits[].commit.committer オブジェクト

コミットに記録された Git コミッターの識別情報であり、Origin のユーザーオブジェクトではありません。

commits[].commit.committer.name string

Gitの識別情報に記録された名前。

commits[].commit.committer.email string

GitのIDに登録されているメールアドレス。

commits[].commit.committer.date string

git署名の元のタイムゾーンオフセットを保持するISO-8601タイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

commits[].commit.message string

コミットメッセージ。

commits[].commit.tree オブジェクト

コミットが参照するツリー。

commits[].commit.tree.sha string

コミットが参照するツリーの SHA。

commits[].parents array

親コミットへの参照。それぞれ SHA を含みます。

commits[].parents[].sha string

親コミットのSHA。

nextPageToken string

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/commits' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "commits": [    {      "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "commit": {        "author": {          "name": "Jane Doe",          "email": "[email protected]",          "date": "2026-08-01T09:30:00Z"        },        "committer": {          "name": "Jane Doe",          "email": "[email protected]",          "date": "2026-08-01T09:30:00Z"        },        "message": "Add launch telemetry",        "tree": {          "sha": "a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8"        }      },      "parents": [        {          "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"        }      ],      "stats": {        "additions": 128,        "deletions": 46,        "total": 174      }    }  ]}

プルリクエストの変更ファイル一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/files

Scoperepository:pull_requests:readAuthInstallation tokenUser access token

プルリクエストで変更されたファイルを一覧で取得します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

クエリパラメータ

pageSize integer

返却する変更ファイルの最大数。未設定または0の場合のデフォルトは30です。100を超える値は100に制限されます。

pageToken string

レスポンスフィールド

files 配列

現在のプルリクエストのバージョンにおける変更ファイルの記録。

files[].filename string

変更されたプルリクエストファイルのパス。

files[].status string

変更ステータス: 追加、削除、変更、名前変更、またはコピー。

files[].additions integer

ファイルの追加行数。

files[].deletions integer

ファイルの削除行数。

files[].changes integer

ファイルの変更行数の合計。

files[].patch string

ファイルの統合パッチ。

files[].previousFilename string

ファイルがリネームまたはコピーされたときの以前のパス。

nextPageToken string

トークンはプルリクエストのバージョンとファイルカーソルを固定します。トークンが現在の head または base に対して古い場合は 400 を返します。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/files' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造：

{  "files": [    {      "filename": "src/telemetry.ts",      "status": "modified",      "additions": 6,      "deletions": 3,      "changes": 9,      "patch": "@@ -12,6 +12,9 @@\n import { ignite } from \"./ignition\";\n+import { emitLaunchTelemetry } from \"./telemetry\";\n"    }  ]}

プルリクエストのラベル一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/labels

Scoperepository:pull_requests:readAuthInstallation tokenUser access token

プルリクエストに付与されたすべてのラベルを名前順に一覧表示します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のslug。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

レスポンスフィールド

labels array

現在プルリクエストに付与されているすべてのラベル。名前順です。

labels[].id string

ラベルの公開識別子。

labels[].name string

リポジトリ内で一意のラベル名。書き込みエンドポイントでは、名前でラベルを指定します。

labels[].color string

先頭の # を含まない6文字の16進カラーコード。

labels[].description string

ラベルの説明。説明がないラベルでは存在しません。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/labels' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "labels": [    {      "id": "lbl_01k2ja2000e0080000000000m1",      "name": "bug",      "color": "d73a4a",      "description": "Something isn't working"    }  ]}

プルリクエストのラベルを設定

PUT/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/labels

Scoperepository:pull_requests:writeAuthInstallation tokenUser access token

プルリクエストに割り当てられているすべてのラベルを、指定したラベルに置き換えます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のslug。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

リクエスト本文

labels array

割り当てるラベル名。最大100件。空のリストを指定すると、割り当てられているすべてのラベルが削除されます。重複した名前は無視されます。

レスポンスフィールド

labels array

置き換え後に割り当てられたラベル。名前順で返されます。各エントリには id、name、color、description が含まれます。

curl --request PUT \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/labels' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "labels": [    "bug"  ]}'

レスポンスの構造:

{  "labels": [    {      "id": "lbl_01k2ja2000e0080000000000m1",      "name": "bug",      "color": "d73a4a",      "description": "Something isn't working"    }  ]}

プルリクエストにラベルを追加

POST/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/labels

Scoperepository:pull_requests:writeAuthInstallation tokenUser access token

既存のリポジトリラベルをプルリクエストに追加します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のslug。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

リクエスト本文

labels array 必須

追加するラベル名。最大100個。重複した名前は無視されます。

レスポンスフィールド

labels array

リクエストで指定したラベル。各エントリには id、name、color、description が含まれます。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/labels' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "labels": [    "bug"  ]}'

レスポンスの構造:

{  "labels": [    {      "id": "lbl_01k2ja2000e0080000000000m1",      "name": "bug",      "color": "d73a4a",      "description": "Something isn't working"    }  ]}

プルリクエストのすべてのラベルを削除

DELETE/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/labels

Scoperepository:pull_requests:writeAuthInstallation tokenUser access token

プルリクエストからすべてのラベルを削除します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意の slug。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

レスポンスフィールド

成功時、レスポンス本文は返されません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/labels' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンス:

204 No Content

プルリクエストのラベルを削除

DELETE/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/labels/{labelName}

Scoperepository:pull_requests:writeAuthInstallation tokenUser access token

プルリクエストからラベルを1つ削除します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のslug。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

labelName string 必須

削除するラベルの名前。

レスポンスフィールド

labels array

プルリクエストに残っているラベル。名前順に並び、各エントリには id、name、color、description が含まれます。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/labels/LABEL_NAME' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "labels": [    {      "id": "lbl_01k2ja2000e0080000000000m1",      "name": "bug",      "color": "d73a4a",      "description": "Something isn't working"    }  ]}

プルリクエストのマージ

POST/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/merge

Scoperepository:contents:writeAuthInstallation tokenUser access token

プルリクエストをベースブランチにマージします。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

マージするプル番号。このプルがスタックされている場合、スタックのルートからこの番号までのすべてのプルがマージされます。

リクエスト本文

expectedHeadSha string

mergeMethod string

レスポンスフィールド

mergeCommitSha string

mergedPullNumbers 配列

スタックのルートからターゲットまでの間でマージされたプルリクエスト番号のJSON文字列。

pullRequest オブジェクト

マージ後のターゲットPullRequest。例は省略されていますが、宣言されたレスポンスタイプは完全なリソースです。

pullRequest.id string

Stable Origin プルリクエスト識別子。

pullRequest.number 文字列

JSON文字列としてエンコードされたリポジトリローカルのプルリクエスト番号。

pullRequest.state string

プルリクエストの状態：open または closed。マージされたプルリクエストは closed で、merged が true に設定されます。

pullRequest.draft boolean

プルリクエストがドラフトかどうか。

pullRequest.merged boolean

プルリクエストがマージされたかどうか。

pullRequest.title 文字列

プルリクエストのタイトル。

pullRequest.body 文字列

プルリクエストの説明本文。

pullRequest.head object

変更のソース側 — マージされる内容。

pullRequest.head.ref string

Originが記録する、この側が指しているref。

pullRequest.head.sha string

変更の最新バージョンにおけるこの側の先端コミット SHA。

pullRequest.base オブジェクト

変更のターゲット側 — マージ先。

pullRequest.base.ref string

Origin の記録上、この側が指している ref。

pullRequest.base.sha string

変更の最新バージョンにおけるこの側の先端コミット SHA。

pullRequest.author オブジェクト

プルリクエストを作成した公開アクター。

pullRequest.author.user オブジェクト

ユーザーがアクションを実行したときに設定される、アクターのユーザー版。

pullRequest.author.user.id 文字列

ユーザーの公開識別子。

pullRequest.author.user.email string

ユーザーのメールアドレス。ユーザーバリアントが存在する場合は常に設定されます。

pullRequest.author.user.displayName string

pullRequest.author.user.handle string

pullRequest.author.app オブジェクト

アクターのアプリ版。アプリがアクションを実行した場合に設定されます。

pullRequest.author.app.id string

アプリの公開識別子。

pullRequest.author.app.displayName string

アプリに登録されている表示名。アプリを解決できない場合、およびCherri Codeのファーストパーティ管理アクターの場合は省略されます。

pullRequest.author.serviceAccount オブジェクト

アクターのサービスアカウント版です。サービスアカウントが操作を実行した場合に設定されます。

pullRequest.author.serviceAccount.id string

サービスアカウントの公開識別子。

pullRequest.createdAt string

RFC 3339形式のプルリクエスト作成タイムスタンプ。

pullRequest.updatedAt string

最新のプルリクエスト更新のRFC 3339タイムスタンプ。

pullRequest.closedAt string

RFC 3339形式のクローズタイムスタンプ。クローズ済みまたはマージ済みのプルリクエストに表示されることがあります。

pullRequest.mergedAt 文字列

RFC 3339形式のマージタイムスタンプ。マージ済みのプルリクエストに表示されることがあります。

pullRequest.mergeCommitSha string

pullRequest.additions 整数

現在のプルリクエストのバージョンで追加された行。

pullRequest.deletions 整数

現在のプルリクエストのバージョンで削除された行。

pullRequest.changedFiles 整数

現在のプルリクエストのバージョンで変更されたファイル数。

pullRequest.labels 配列

現在プルリクエストに割り当てられているラベル。名前順に並べられます。割り当てがない場合は空です。

pullRequest.labels[].id string

ラベルの公開識別子。

pullRequest.labels[].name string

リポジトリ内で一意のラベル名。書き込み用エンドポイントではこの名前でラベルを指定します。

pullRequest.labels[].color 文字列

先頭の # を除く6文字の16進数カラーコード。

pullRequest.labels[].description 文字列

ラベルの説明。説明がない場合は含まれません。

pullRequest.stack オブジェクト

pullRequest.stack.id string

pullRequest.stack.parentPullRequest オブジェクト

pullRequest.stack.parentPullRequest.id string

親プルリクエストのStable Origin識別子。

pullRequest.stack.parentPullRequest.number 文字列

親プルリクエストのリポジトリ内での番号 (JSON文字列としてエンコード) 。

pullRequest.stack.parentPullRequest.repository オブジェクト

pullRequest.version オブジェクト

現在の番号付きプルリクエストのバージョンとそのヘッド/ベースのSHA。

pullRequest.version.number 文字列

JSON文字列としてエンコードされた単調増加のプルリクエストのバージョン番号。

pullRequest.version.headSha string

このプルリクエストのバージョンで取得されたヘッド SHA。

pullRequest.version.baseSha string

このプルリクエストのバージョンで取得されたベースSHA。

pullRequest.version.createdAt 文字列

このプルリクエストバージョンの作成日時を表す RFC 3339 タイムスタンプ。

pullRequest.version.potentialMergeCommit オブジェクト

pullRequest.version.potentialMergeCommit.state string

pullRequest.version.potentialMergeCommit.sha string

pullRequest.version.potentialMergeCommit.baseSha string

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/merge' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "expectedHeadSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "mergeMethod": "squash"}'

レスポンスの構造:

{  "mergeCommitSha": "5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9a8b7c6d",  "mergedPullNumbers": [    "17"  ],  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "state": "closed",    "draft": false,    "merged": true,    "title": "Add launch telemetry",    "body": "Adds structured launch telemetry to the ignition path.",    "head": {      "ref": "add-telemetry",      "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"    },    "base": {      "ref": "main",      "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"    },    "author": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    },    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z",    "closedAt": "2026-08-03T10:15:00Z",    "mergedAt": "2026-08-03T10:15:00Z",    "mergeCommitSha": "5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9a8b7c6d",    "additions": 128,    "deletions": 46,    "changedFiles": 5,    "labels": [      {        "id": "lbl_01k2ja2000e0080000000000m1",        "name": "bug",        "color": "d73a4a",        "description": "Something isn't working"      }    ],    "version": {      "number": "3",      "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8",      "createdAt": "2026-08-01T09:30:00Z"    }  }}

プルリクエストのマージ可否を取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/mergeability

Scoperepository:pull_requests:readAuthInstallation tokenUser access token

PreviewThis endpoint is in preview and may change before it is generally available.

マージ済みの祖先を含めて合計200件を超えるプルリクエストからなるスタックの場合は FailedPrecondition (HTTP 400) が返されます。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意の slug。

repoName 文字列必須

リポジトリ名。オーナーエンティティ内で一意です。

pullNumber 文字列必須

リポジトリ内で一意のプルリクエスト番号。

クエリパラメータ

expectedHeadSha 文字列

レスポンスフィールド

pullRequest オブジェクト

判定の対象となるプルリクエスト。

pullRequest.id 文字列

変更されないプルリクエスト識別子。

pullRequest.number 文字列

リポジトリ内で一意のプルリクエスト番号。JSON 文字列としてエンコードされます。

pullRequest.repository オブジェクト

プルリクエストのリポジトリコンテナリファレンス。

pullRequest.repository.id 文字列

コンテナリファレンス内のリポジトリ識別子。

pullRequest.repository.name 文字列

コンテナリファレンス内のリポジトリ名。

pullRequest.repository.owner オブジェクト

リポジトリの所有者リファレンス。

pullRequest.repository.owner.slug 文字列

リポジトリの所有者を識別するために所有者IDと組み合わせて使用する、URL向けの所有者slugです。

pullRequest.repository.owner.id 文字列

オリジンの所有者識別子。

pullRequest.repository.owner.type 文字列

オーナーの namespace の種類。出力専用。指定可能な値: team、user。不明な場合は省略されます。

verdict 文字列

blockers 配列

blockers[].pullRequest オブジェクト

このブロッカーが属する evaluatedPullRequests 内のプルリクエスト。pullRequest と同じフィールドを持ちます。

blockers[].kind 文字列

blockers[].message 文字列

blockers[].requiredChecks オブジェクト

required_checks ブロッカーに設定されます。

blockers[].requiredChecks.state 文字列

このブロッカー内のすべてのチェックで共有される状態。指定可能な値: missing、pending、failing、action_required。

blockers[].requiredChecks.checks 配列

その状態にある必須チェック。

blockers[].requiredChecks.checks[].name 文字列

リポジトリルールで必要となる名前。

blockers[].requiredChecks.checks[].owner オブジェクト

チェックを報告すると想定されるプリンシパル。チェック実行の actor と同じ actor バリアントを持ちます。

blockers[].requiredChecks.checks[].checkRun オブジェクト

blockers[].requiredApprovals オブジェクト

required_approvals ブロッカーに設定されます。

blockers[].requiredApprovals.requiredCount integer

リポジトリルールが要求する承認済みの確認。

blockers[].requiredApprovals.approvedCount 整数

現時点で要件のカウント対象となっている承認レビュー。

blockers[].codeownerApproval オブジェクト

codeowner_approval ブロッカーに設定されます。

blockers[].codeownerApproval.requirements 配列

承認がまだ必要な所有者セット。

blockers[].codeownerApproval.requirements[].owners 配列

コード所有者。いずれか 1 人が承認すれば要件を満たします。

blockers[].codeownerApproval.requirements[].paths 配列

この所有者セットが対象とする変更済みパス。

blockers[].mergeConflict オブジェクト

merge_conflict ブロッカーに設定されます。

blockers[].mergeConflict.conflictedPaths 配列

base ブランチと競合するパス。最大 100 件まで表示されます。

blockers[].mergeConflict.truncated boolean

リストに含まれていない競合パスがさらに存在するかどうか。

blockers[].mergeConflict.inheritedFromDownstack boolean

blockers[].stackShape オブジェクト

invalid_stack ブロッカーで設定されます。

blockers[].stackShape.reason 文字列

stack を評価できない理由。指定可能な値: partially_merged、cycle、missing_parent、cross_repository_parent、base_branch_missing。

blockers[].stackShape.relatedPullRequests 配列

理由に記載がある場合、関連するその他のプルリクエスト。いずれも pullRequest と同じフィールドを持ちます。

evaluatedPullRequests 配列

headSha 文字列

評価対象となった pullRequest の head commit。

baseRef 文字列

baseSha 文字列

evaluatedAt 文字列

この結果が評価された日時を示す RFC 3339 形式のタイムスタンプ。これ以降の変更は反映されません。反映するには再度クエリしてください。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/mergeability' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

{  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "repository": {      "id": "repo_01k2ja2000e0080000000000a1",      "name": "launch-control",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000b2"      }    }  },  "verdict": "blocked",  "blockers": [    {      "pullRequest": {        "id": "pr_01k2ja2000e0080000000000d4",        "number": "17",        "repository": {          "id": "repo_01k2ja2000e0080000000000a1",          "name": "launch-control",          "owner": {            "slug": "acme",            "id": "ns_01k2ja2000e0080000000000b2"          }        }      },      "kind": "required_approvals",      "message": "Approving review count is 0; 1 required. Request reviews and wait for the required approvals.",      "requiredApprovals": {        "requiredCount": 1,        "approvedCount": 0      }    },    {      "pullRequest": {        "id": "pr_01k2ja2000e0080000000000d4",        "number": "17",        "repository": {          "id": "repo_01k2ja2000e0080000000000a1",          "name": "launch-control",          "owner": {            "slug": "acme",            "id": "ns_01k2ja2000e0080000000000b2"          }        }      },      "kind": "required_checks",      "message": "Required status checks are pending. Wait for checks to finish or fix the failing checks.",      "requiredChecks": {        "state": "pending",        "checks": [          {            "name": "ci / build",            "owner": {              "app": {                "id": "app_01k2ja2000e0080000000000e5",                "displayName": "Launch CI"              }            },            "checkRun": {              "id": "cr_01k2ja2000e0080000000000f6",              "name": "ci / build",              "checkSuite": {                "id": "crg_01k2ja2000e0080000000000f7"              }            }          }        ]      }    }  ],  "evaluatedPullRequests": [    {      "id": "pr_01k2ja2000e0080000000000d4",      "number": "17",      "repository": {        "id": "repo_01k2ja2000e0080000000000a1",        "name": "launch-control",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000b2"        }      }    }  ],  "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "baseRef": "main",  "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8",  "evaluatedAt": "2026-08-02T14:45:00Z"}

プルリクエストの確認依頼先の一覧取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/requested_reviewers

Scoperepository:pull_requests:reviews:readAuthInstallation tokenUser access token

プルリクエストで現在確認が依頼されているユーザーとグループを一覧表示します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のslug。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

リポジトリローカルのプルリクエスト番号。

レスポンスフィールド

users array

確認が依頼されているユーザー。保留中のものがない場合は空です。

users[].id string

エンコードされたユーザー識別子 (user_…)。organization API が使用する形式と同じです。

users[].email string

ユーザーのメールアドレス。アカウントに設定がない場合は空です。

users[].displayName string

users[].handle string

groups array

確認が依頼されているグループ。保留中のものがない場合は空です。

groups[].id string

グループの公開識別子 (grp_…)。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/requested_reviewers' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "users": [    {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  ],  "groups": [    {      "id": "grp_01k2ja2000e0080000000000n2"    }  ]}

Request Pull Request Reviewers

POST/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/requested_reviewers

Scoperepository:pull_requests:reviews:writeAuthInstallation tokenUser access token

指定したユーザーとグループにプルリクエストのレビューを依頼し、この呼び出しで依頼したレビュー担当者を返します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意な slug。

repoName string 必須

リポジトリ名。オーナーエンティティ内で一意です。

pullNumber string 必須

リポジトリ内で一意なプルリクエスト番号。

リクエストボディ

users array

groups array

レスポンスフィールド

users array

この呼び出しで依頼したユーザー。

users[].id string

エンコードされたユーザー識別子 (user_…) 。Organization API で使用されるものと同じ形式です。

users[].email string

ユーザーのメールアドレス。アカウントに設定がない場合は空になります。

users[].displayName string

users[].handle string

groups array

この呼び出しで要求されたグループ。

groups[].id string

グループの public 識別子 (grp_…) 。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/requested_reviewers' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "users": [    "user_01k2ja2000e0080000000000c3"  ],  "groups": [    "grp_01k2ja2000e0080000000000n2"  ]}'

レスポンスの構造:

{  "users": [    {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  ],  "groups": [    {      "id": "grp_01k2ja2000e0080000000000n2"    }  ]}

プルリクエストの確認依頼先の削除

DELETE/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/requested_reviewers

Scoperepository:pull_requests:reviews:writeAuthInstallation tokenUser access token

プルリクエストに対する、指定したユーザーおよびグループへの確認依頼を削除します。レスポンス本文は空です。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のslug。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

リポジトリローカルのプルリクエスト番号。

リクエスト本文

users array

groups array

レスポンスフィールド

リクエストが成功した場合、レスポンス本文は返されません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/requested_reviewers' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "users": [    "user_01k2ja2000e0080000000000c3"  ],  "groups": [    "grp_01k2ja2000e0080000000000n2"  ]}'

レスポンス:

204 No Content

プルリクエストレビューを一覧表示

GET/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/reviews

Scoperepository:pull_requests:reviews:readAuthInstallation tokenUser access token

プルリクエストに提出されたレビューをsubmitted_atの昇順で一覧表示します。保留中のレビューは含まれません。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

クエリパラメータ

pageSize 整数

返すレビューの最大数。デフォルトは30、最大は100。

pageToken string

レスポンスフィールド

reviews 配列

送信済みレビューは submittedAt の昇順で並べられ、未送信のドラフトレビューは除外されます。

reviews[].id string

安定したレビュー識別子。

reviews[].author オブジェクト

レビューを作成した公開アクター。

reviews[].author.user オブジェクト

アクターのユーザー別バリアント。ユーザーが操作を行ったときに設定されます。

reviews[].author.user.id string

ユーザーの公開識別子。

reviews[].author.user.email string

ユーザーのメールアドレス。userバリアントが存在する場合は常に設定されます。

reviews[].author.user.displayName string

ユーザーの表示名: アカウントの名と姓をスペースで結合した、製品に表示される名前。アカウントに名前がない場合は省略されます。

reviews[].author.user.handle string

reviews[].author.app オブジェクト

アクターのアプリ版。アプリがアクションを実行した場合に設定されます。

reviews[].author.app.id string

アプリの公開識別子。

reviews[].author.app.displayName string

アプリの登録済み表示名。アプリを解決できない場合、またはCherri Codeのファーストパーティ管理アクターの場合は省略されます。

reviews[].author.serviceAccount オブジェクト

アクターのサービスアカウント版。サービスアカウントが操作を行ったときに設定されます。

reviews[].author.serviceAccount.id string

サービスアカウントの公開識別子。

reviews[].verdict string

レビュー結果: 承認、変更要求、またはコメント。

reviews[].body string

レビュー要約のテキスト。

reviews[].submittedAt string

RFC 3339形式の送信タイムスタンプ。未提出のドラフトレビューでは存在しません。

reviews[].pullRequestVersion オブジェクト

レビューの対象となるプルリクエストのバージョン。

reviews[].pullRequestVersion.number string

JSON文字列としてエンコードされた単調増加のプルリクエストのバージョン番号。

reviews[].pullRequestVersion.headSha string

このプルリクエストのバージョンで取得されたHead SHA。

reviews[].pullRequestVersion.baseSha string

このプルリクエストバージョンで取得されたベースSHA。

reviews[].dismissal オブジェクト

レビューが却下された後に表示されます。却下されたレビューは一覧に引き続き表示されます。

reviews[].dismissal.dismissedBy object

公開されたときにレビューを却下したパブリックアクター。

reviews[].dismissal.dismissedBy.user object

アクターのユーザー別バリアント。ユーザーが操作を行ったときに設定されます。

reviews[].dismissal.dismissedBy.user.id string

ユーザーの公開識別子。

reviews[].dismissal.dismissedBy.user.email string

ユーザーのメールアドレス。userバリアントが存在する場合は常に設定されます。

reviews[].dismissal.dismissedBy.user.displayName string

ユーザーの表示名: アカウントの名と姓をスペースで結合した、製品に表示される名前。アカウントに名前がない場合は省略されます。

reviews[].dismissal.dismissedBy.user.handle string

reviews[].dismissal.dismissedBy.app object

アクターのアプリ版。アプリがアクションを実行した場合に設定されます。

reviews[].dismissal.dismissedBy.app.id string

アプリの公開識別子。

reviews[].dismissal.dismissedBy.app.displayName string

アプリの登録済み表示名。アプリを解決できない場合、またはCherri Codeのファーストパーティ管理アクターの場合は省略されます。

reviews[].dismissal.dismissedBy.serviceAccount オブジェクト

アクターのサービスアカウント版。サービスアカウントが操作を行ったときに設定されます。

reviews[].dismissal.dismissedBy.serviceAccount.id string

サービスアカウントの公開識別子。

reviews[].dismissal.dismissedAt 文字列

RFC 3339形式の却下タイムスタンプ。

reviews[].dismissal.message string

却下理由。自動的に置き換えられた場合はサーバー生成のメッセージが使用されます。

pullRequest オブジェクト

レビュー画面と併せて含まれる PullRequestReference コンテナ。

pullRequest.id string

安定したプルリクエスト識別子。

pullRequest.number 文字列

JSON文字列としてエンコードされたリポジトリ内のプルリクエスト番号。

pullRequest.repository object

プルリクエストのリポジトリコンテナ参照。

pullRequest.repository.id 文字列

コンテナ参照内のリポジトリ識別子。

pullRequest.repository.name string

コンテナ参照内のリポジトリ名。

pullRequest.repository.owner オブジェクト

リポジトリのオーナー参照。

pullRequest.repository.owner.slug 文字列

リポジトリの所有者を識別するために、所有者IDとともに使用されるURL用のオーナースラッグ。

pullRequest.repository.owner.id string

オリジン所有者の識別子。

pullRequest.repository.owner.type string

所有者の名前空間のタイプ。出力専用。許可されている値: team, user。不明な場合は省略されます。

nextPageToken 文字列

次のページ用の不透明なカーソル。レビューがこれ以上ない場合は空です。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/reviews' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "reviews": [    {      "id": "rev_01k2ja2000e0080000000000f6",      "author": {        "user": {          "id": "user_01k2ja2000e0080000000000c3",          "email": "[email protected]"        }      },      "verdict": "approve",      "body": "Approving. The telemetry schema matches the spec.",      "submittedAt": "2026-08-02T15:00:00Z",      "pullRequestVersion": {        "number": "3",        "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",        "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"      }    }  ],  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    }  }}

プルリクエストレビューを作成

POST/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/reviews

Scoperepository:pull_requests:reviews:writeAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

リクエスト本文

verdict string 必須

レビューの判定。許容される値: PULL_REQUEST_REVIEW_VERDICT_UNSPECIFIED、approve、request_changes、comment。

body string

自由記述のレビュー要約。空でもかまいません。

versionNumber 文字列

comments 配列

レビューと同時に一括で公開されるコメント。リクエストごとに最大50件。

comments[].body string 必須

コメント本文。空白以外の文字を少なくとも1文字含める必要があります。

comments[].inline オブジェクト

comments[].inline.path string 必須

レビュー対象バージョンの差分内のファイルパス。

comments[].inline.side string 必須

アンカーの差分側。許容値: ファイルのベース版は left、ヘッド版は right。

comments[].inline.startLine 整数必須

ファイルの side バージョンにおけるアンカー範囲の先頭行 (1始まり) 。範囲はファイルの末尾を超えてはなりません。

comments[].inline.endLine 整数

アンカー範囲に含まれる最終行。startLine 以上である必要があります。単一行のアンカーの場合は省略してください。

comments[].threadId string

comments[].file オブジェクト

comments[].file.path string 必須

レビュー対象バージョンの差分内のファイルパス: 削除の場合は削除されたパス、それ以外の場合はヘッドのパス。

レスポンスフィールド

id string

安定したレビュー識別子。

author オブジェクト

レビューを作成した公開アクター。

author.user オブジェクト

アクターのユーザー版。ユーザーが操作を行った場合に設定されます。

author.user.id string

ユーザーの公開識別子。

author.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

author.user.displayName string

ユーザーの表示名: アカウントの名と姓をスペースでつないだ、製品に表示される名前です。アカウントに名前がない場合は省略されます。

author.user.handle string

author.app オブジェクト

アクターのアプリのバリアント。アプリがアクションを実行したときに設定されます。

author.app.id 文字列

アプリの公開識別子。

author.app.displayName 文字列

アプリの登録済み表示名。アプリを解決できない場合、およびCherri Codeのファーストパーティ管理アクターの場合は省略されます。

author.serviceAccount オブジェクト

アクターのサービスアカウント版。サービスアカウントが操作を実行した場合に設定されます。

author.serviceAccount.id string

サービスアカウントの公開識別子。

verdict string

レビューの判定：承認、変更を要求、またはコメント。

body string

レビューの要約。

submittedAt 文字列

RFC 3339 形式の送信タイムスタンプ。未送信の下書きレビューの場合は存在しません。

pullRequestVersion オブジェクト

レビューが適用されるプルリクエストのバージョン。

pullRequestVersion.number string

JSON文字列としてエンコードされた単調増加するプルリクエストのバージョン番号。

pullRequestVersion.headSha string

このプルリクエストのこのバージョンで取得された Head SHA。

pullRequestVersion.baseSha string

このプルリクエストのバージョンでキャプチャされたベース SHA。

dismissal オブジェクト

レビューが却下された後に表示されます。却下されたレビューは一覧に引き続き表示されます。

dismissal.dismissedBy オブジェクト

公開時にレビューを却下した公開アクター。

dismissal.dismissedBy.user オブジェクト

ユーザーが操作を行った場合に設定される、アクターのユーザー版。

dismissal.dismissedBy.user.id string

ユーザーの公開識別子。

dismissal.dismissedBy.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

dismissal.dismissedBy.user.displayName string

ユーザーの表示名: アカウントの名と姓をスペースでつないだ、製品に表示される名前です。アカウントに名前がない場合は省略されます。

dismissal.dismissedBy.user.handle string

dismissal.dismissedBy.app オブジェクト

アクターのアプリのバリアント。アプリがアクションを実行したときに設定されます。

dismissal.dismissedBy.app.id 文字列

アプリの公開識別子。

dismissal.dismissedBy.app.displayName string

アプリの登録済み表示名。アプリを解決できない場合、およびCherri Codeのファーストパーティ管理アクターの場合は省略されます。

dismissal.dismissedBy.serviceAccount オブジェクト

アクターのサービスアカウント版です。サービスアカウントが操作を実行した場合に設定されます。

dismissal.dismissedBy.serviceAccount.id string

サービスアカウントの公開識別子。

dismissal.dismissedAt string

RFC 3339の破棄タイムスタンプ。

dismissal.message 文字列

却下理由。自動的な置き換えには、サーバーで生成されたメッセージが使用されます。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/reviews' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "verdict": "approve",  "body": "Approving. The telemetry schema matches the spec.",  "versionNumber": "3"}'

レスポンスの構造:

{  "id": "rev_01k2ja2000e0080000000000f6",  "author": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "verdict": "approve",  "body": "Approving. The telemetry schema matches the spec.",  "submittedAt": "2026-08-02T15:00:00Z",  "pullRequestVersion": {    "number": "3",    "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"  }}

プルリクエストレビューを更新

PATCH/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/reviews/{reviewId}

Scoperepository:pull_requests:reviews:writeAuthInstallation tokenUser access token

未送信の下書きレビューも更新できます。下書きのレスポンスには submitted_at がありません。

パスパラメータ

ownerSlug string 必須

所有するエンティティの一意のスラッグ。

repoName string 必須

所有者エンティティに固有のリポジトリ名。

pullNumber string 必須

reviewId string 必須

リクエスト本文

body string 必須

レスポンスフィールド

id string

安定したレビュー識別子。

author オブジェクト

レビューを作成した公開アクター。

author.user オブジェクト

アクターのユーザー版。ユーザーが操作を行ったときに設定されます。

author.user.id string

ユーザーの公開識別子。

author.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

author.user.displayName string

author.user.handle string

author.app オブジェクト

アクターのアプリバリアント。アプリがアクションを実行した際に設定されます。

author.app.id string

アプリの公開識別子。

author.app.displayName string

アプリに登録された表示名。アプリを特定できない場合や、Cherri Code のファーストパーティ管理アクターでは省略されます。

author.serviceAccount オブジェクト

アクターのサービスアカウントのバリアント。サービスアカウントが操作を実行したときに設定されます。

author.serviceAccount.id string

サービスアカウントの公開識別子。

verdict string

レビューの判定：approve、request_changes、または comment。

body string

レビューの要約テキスト。

submittedAt string

RFC 3339形式の送信タイムスタンプ。未送信のドラフトレビューでは存在しません。

pullRequestVersion オブジェクト

レビューが適用されるプルリクエストのバージョン。

pullRequestVersion.number string

JSON文字列としてエンコードされた単調増加するプルリクエストのバージョン番号。

pullRequestVersion.headSha string

このプルリクエストのバージョンで取得された Head SHA。

pullRequestVersion.baseSha string

このプルリクエストのバージョンで取得されたベース SHA。

dismissal オブジェクト

レビューが却下された後に表示されます。却下されたレビューは一覧に引き続き表示されます。

dismissal.dismissedBy オブジェクト

発覚した際にレビューを退けた公人。

dismissal.dismissedBy.user オブジェクト

アクターのユーザー版。ユーザーが操作を行ったときに設定されます。

dismissal.dismissedBy.user.id string

ユーザーの公開識別子。

dismissal.dismissedBy.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

dismissal.dismissedBy.user.displayName string

dismissal.dismissedBy.user.handle string

dismissal.dismissedBy.app オブジェクト

アクターのアプリバリアント。アプリがアクションを実行した際に設定されます。

dismissal.dismissedBy.app.id string

アプリの公開識別子。

dismissal.dismissedBy.app.displayName string

アプリに登録された表示名。アプリを特定できない場合や、Cherri Code のファーストパーティ管理アクターでは省略されます。

dismissal.dismissedBy.serviceAccount オブジェクト

アクターのサービスアカウントのバリアント。サービスアカウントが操作を実行したときに設定されます。

dismissal.dismissedBy.serviceAccount.id string

サービスアカウントの公開識別子。

dismissal.dismissedAt 文字列

RFC 3339 形式の却下タイムスタンプ。

dismissal.message string

却下理由。自動的に置き換えられる場合はサーバー生成のメッセージが使用されます。

curl --request PATCH \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/reviews/REVIEW_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "body": "Approving. The telemetry schema matches the spec."}'

レスポンスの構造:

{  "id": "rev_01k2ja2000e0080000000000f6",  "author": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "verdict": "approve",  "body": "Approving. The telemetry schema matches the spec.",  "submittedAt": "2026-08-02T15:00:00Z",  "pullRequestVersion": {    "number": "3",    "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"  }}

プルリクエストのレビューを却下

PUT/v1/origin/repos/{ownerSlug}/{repoName}/pulls/{pullNumber}/reviews/{reviewId}/dismissals

Scoperepository:pull_requests:reviews:writeAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

pullNumber string 必須

reviewId string 必須

ListPullRequestReviews が返す安定した Origin レビュー識別子。

リクエスト本文

message string 必須

却下時に記録する理由。空白以外の文字を含める必要があります。含まれない場合はINVALID_ARGUMENTになります。

レスポンスフィールド

id string

安定したレビュー識別子。

author オブジェクト

レビューを書いた公開アクター。

author.user オブジェクト

ユーザーがアクションを実行した場合に設定される、アクターのユーザー変種。

author.user.id string

ユーザーの公開識別子。

author.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

author.user.displayName string

author.user.handle string

author.app オブジェクト

アクターのアプリのバリアント。アプリがアクションを実行したときに設定されます。

author.app.id string

アプリの公開識別子。

author.app.displayName string

アプリに登録されている表示名。アプリを解決できない場合およびCherri Codeのファーストパーティ管理アクターでは省略されます。

author.serviceAccount オブジェクト

アクターのサービスアカウントのバリアント。サービスアカウントが操作を実行した場合に設定されます。

author.serviceAccount.id string

サービスアカウントの公開識別子。

verdict string

確認結果：承認 (approve)、変更を要求 (request_changes)、またはコメント (comment)。

body string

レビューの要約。

submittedAt 文字列

RFC 3339形式の送信タイムスタンプ。未送信のドラフトレビューの場合は存在しません。

pullRequestVersion オブジェクト

レビューが適用されるプルリクエストのバージョン。

pullRequestVersion.number string

JSON文字列としてエンコードされた単調増加するプルリクエストのバージョン番号。

pullRequestVersion.headSha 文字列

このプルリクエストのバージョンで取得されたヘッドSHA。

pullRequestVersion.baseSha string

このプルリクエストのバージョンで取得されたベースSHA。

dismissal object

レビューが却下された後に表示されます。却下されたレビューは一覧に引き続き表示されます。

dismissal.dismissedBy オブジェクト

公開される場合にレビューを却下した公開アクター。

dismissal.dismissedBy.user オブジェクト

ユーザーがアクションを実行した場合に設定される、アクターのユーザー変種。

dismissal.dismissedBy.user.id string

ユーザーの公開識別子。

dismissal.dismissedBy.user.email string

ユーザーのメールアドレス。ユーザーのバリアントが存在する場合は常に設定されます。

dismissal.dismissedBy.user.displayName string

dismissal.dismissedBy.user.handle string

dismissal.dismissedBy.app オブジェクト

アクターのアプリのバリアント。アプリがアクションを実行したときに設定されます。

dismissal.dismissedBy.app.id string

アプリの公開識別子。

dismissal.dismissedBy.app.displayName string

アプリに登録されている表示名。アプリを解決できない場合およびCherri Codeのファーストパーティ管理アクターでは省略されます。

dismissal.dismissedBy.serviceAccount オブジェクト

アクターのサービスアカウントのバリアント。サービスアカウントが操作を実行した場合に設定されます。

dismissal.dismissedBy.serviceAccount.id string

サービスアカウントの公開識別子。

dismissal.dismissedAt 文字列

RFC 3339 形式の却下タイムスタンプ。

dismissal.message 文字列

却下理由。自動的に置き換えられる場合はサーバー生成のメッセージが使用されます。

curl --request PUT \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/pulls/PULL_NUMBER/reviews/REVIEW_ID/dismissals' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "message": "Superseded by a newer review."}'

レスポンスの構造:

{  "id": "rev_01k2ja2000e0080000000000f6",  "author": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "verdict": "approve",  "body": "Approving. The telemetry schema matches the spec.",  "submittedAt": "2026-08-02T15:00:00Z",  "pullRequestVersion": {    "number": "3",    "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"  },  "dismissal": {    "dismissedBy": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    },    "dismissedAt": "2026-08-02T15:00:00Z",    "message": "Superseded by a newer review."  }}

ルールセット

ルールセットの一覧

GET/v1/origin/repos/{ownerSlug}/{repoName}/rulesets

Scoperepository:rulesets:readAuthInstallation tokenUser access token

リポジトリに設定されているすべてのルールセットを一覧表示します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

レスポンスフィールド

rulesets array

リポジトリに設定されているルールセット。

rulesets[].id string

Stable Origin ルールセット ID。

rulesets[].name string

ルールセット名。

rulesets[].description 文字列

ルールセットの説明。

rulesets[].enforcement string

Origin がルールセットを適用する方法。指定可能な値: active、evaluate、disabled。

rulesets[].kind string

ルールセットが保護する操作。指定できる値：merge_branch、push_branch、push_tag、push_repository。

rulesets[].includedRefNames 配列

このルールセットに含める ref 名のパターン。glob とトークン ~ALL、~DEFAULT_BRANCH をサポートします。

rulesets[].excludedRefNames 配列

このルールセットが除外するリファレンス名のパターン。rulesets[].includedRefNames と同じパターン言語です。

rulesets[].rules 配列

このルールセット内の保護ルール。

rulesets[].rules[].id string

このルールの安定したオリジン ID。

rulesets[].rules[].ruleType 文字列

ルールの種類。例：pull_request、require_status_checks、require_branch_up_to_date、deletion、non_fast_forward。

rulesets[].rules[].parameters オブジェクト

タイプ固有のパラメータをJSONオブジェクトとして指定します。構造はrulesets[].rules[].ruleTypeによって異なります。

rulesets[].bypassActors 配列

このルールセットをバイパスできる主体。保存された識別情報を読み取れないバイパス実行者はレスポンスから省かれます。

rulesets[].bypassActors[].id string

このバイパスアクターの安定したオリジンID。

rulesets[].bypassActors[].bypassMode string

バイパスを適用するタイミング。指定できる値: always、pull_request_only。

rulesets[].bypassActors[].user オブジェクト

ユーザープリンシパル。user、team、app、originRole のうち正確に1つが存在します。

rulesets[].bypassActors[].user.id string

10進数の文字列としてエンコードされたカーソルの数値ユーザーID。

rulesets[].bypassActors[].team オブジェクト

チーム代表。

rulesets[].bypassActors[].team.organizationPublicId string

不変の組織公開 ID。

rulesets[].bypassActors[].team.groupPublicId string

変更不可能なグループ公開ID。

rulesets[].bypassActors[].app オブジェクト

アプリケーションのプリンシパル。

rulesets[].bypassActors[].app.id string

app_で始まるApp ID。

rulesets[].bypassActors[].originRole オブジェクト

Origin ロールを持つプリンシパル。

rulesets[].bypassActors[].originRole.role string

使用できる値: namespace_admin、repository_admin、repository_write。

repository オブジェクト

このレスポンス内のすべてのルールセットで共有されるリポジトリ。

repository.id string

コンテナ参照内のリポジトリ識別子。

repository.name string

コンテナ参照内のリポジトリ名。

repository.owner オブジェクト

リポジトリの所有者参照。

repository.owner.slug string

オーナーIDと組み合わせてリポジトリの所有者を識別する、URL 表示用のオーナースラグ。

repository.owner.id string

Origin の所有者識別子。

repository.owner.type 文字列

所有者の名前空間の種類。出力専用。許容値: team、user。不明な場合は省略されます。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/rulesets' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "rulesets": [    {      "id": "rs_01k2ja2000e0080000000000t7",      "name": "require-review",      "description": "Require an approving review before merging to main.",      "enforcement": "active",      "kind": "merge_branch",      "includedRefNames": [        "refs/heads/main"      ],      "rules": [        {          "id": "rsr_01k2ja2000e0080000000000v8",          "ruleType": "pull_request",          "parameters": {            "requiredApprovingReviewCount": 1          }        }      ],      "bypassActors": [        {          "id": "rsba_01k2ja2000e0080000000000w9",          "bypassMode": "always",          "user": {            "id": "act_01k2ja2000e0080000000000x0"          }        }      ]    }  ],  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  }}

ルールセットを作成

POST/v1/origin/repos/{ownerSlug}/{repoName}/rulesets

Scoperepository:rulesets:writeAuthInstallation tokenUser access token

リポジトリのルールセットを作成します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

リクエスト本文

name string 必須

ルールセット名。

description 文字列

ルールセットの説明。

enforcement string 必須

Origin によるルールセットの適用方法。指定可能な値: active、evaluate、disabled。

kind string 必須

ルールセットが保護する操作。指定可能な値: merge_branch、push_branch、push_tag、push_repository。

includedRefNames 配列

excludedRefNames 配列

このルールセットが除外する参照名のパターン。パターン言語と上限 (64件) は includedRefNames と同じです。

rules array

bypassActors 配列

レスポンスフィールド

id string

Stable Origin ルールセット ID。

name string

ルールセット名。

description 文字列

ルールセットの説明。

enforcement 文字列

Origin によるルールセットの適用方法。指定可能な値: active、evaluate、disabled。

kind string

ルールセットが保護する操作。指定可能な値: merge_branch、push_branch、push_tag、push_repository。

includedRefNames 配列

このルールセットが対象とする ref 名のパターン。glob と ~ALL、~DEFAULT_BRANCH トークンをサポートします。

excludedRefNames 配列

このルールセットが除外する参照名のパターン。includedRefNamesと同じパターン言語です。

rules 配列

このルールセットの保護ルール。

rules[].id string

このルールの安定オリジンID。

rules[].ruleType string

ルールタイプ。例: pull_request、require_status_checks、require_branch_up_to_date、deletion、non_fast_forward。

rules[].parameters オブジェクト

タイプ固有のパラメータをJSONオブジェクトとして指定します。形式はrules[].ruleTypeに依存します。

bypassActors 配列

このルールセットをバイパスできるプリンシパル。保存された識別情報を読み取れないバイパス対象はレスポンスから省かれます。

bypassActors[].id string

このバイパスアクターの安定したオリジンID。

bypassActors[].bypassMode string

バイパスが適用される場合。指定可能な値: always、pull_request_only。

bypassActors[].user オブジェクト

ユーザープリンシパル。user、team、app、またはoriginRoleのうち正確に1つが存在します。

bypassActors[].user.id string

10進数文字列としてエンコードされた Cherri Code の数値ユーザー ID。

bypassActors[].team オブジェクト

チーム代表。

bypassActors[].team.organizationPublicId string

不変の組織公開ID。

bypassActors[].team.groupPublicId string

不変のグループ公開ID。

bypassActors[].app オブジェクト

アプリのプリンシパル。

bypassActors[].app.id string

アプリ ID。app_ のプレフィックスが付きます。

bypassActors[].originRole オブジェクト

Originロールを持つプリンシパル。

bypassActors[].originRole.role string

指定可能な値: namespace_admin、repository_admin、repository_write。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/rulesets' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "name": "require-review",  "description": "Require an approving review before merging to main.",  "enforcement": "active",  "kind": "merge_branch",  "includedRefNames": [    "refs/heads/main"  ],  "rules": [    {      "ruleType": "pull_request",      "parameters": {        "requiredApprovingReviewCount": 1      }    }  ],  "bypassActors": [    {      "bypassMode": "always",      "user": {        "id": "act_01k2ja2000e0080000000000x0"      }    }  ]}'

レスポンスの構造:

{  "id": "rs_01k2ja2000e0080000000000t7",  "name": "require-review",  "description": "Require an approving review before merging to main.",  "enforcement": "active",  "kind": "merge_branch",  "includedRefNames": [    "refs/heads/main"  ],  "rules": [    {      "id": "rsr_01k2ja2000e0080000000000v8",      "ruleType": "pull_request",      "parameters": {        "requiredApprovingReviewCount": 1      }    }  ],  "bypassActors": [    {      "id": "rsba_01k2ja2000e0080000000000w9",      "bypassMode": "always",      "user": {        "id": "act_01k2ja2000e0080000000000x0"      }    }  ]}

ルールセットを取得

GET/v1/origin/repos/{ownerSlug}/{repoName}/rulesets/{rulesetId}

Scoperepository:rulesets:readAuthInstallation tokenUser access token

安定したOrigin IDによって単一のリポジトリルールセットを返します。

不明なリポジトリと不明なルールセットはどちらも 404 を返しますが、メッセージで区別できます。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名。

rulesetId string 必須

Stable Origin のルールセット ID。

レスポンスフィールド

id string

Stable Origin のルールセット ID。

name string

ルールセット名。

description string

ルールセットの説明。

enforcement string

Origin によるルールセットの適用方法。指定可能な値: active、evaluate、disabled。

kind string

ルールセットが保護する操作。指定可能な値:merge_branch、push_branch、push_tag、push_repository。

includedRefNames 配列

このルールセットに含める参照名のパターン。グロブとトークン ~ALL、~DEFAULT_BRANCH をサポートします。

excludedRefNames 配列

このルールセットが除外する ref 名のパターン。includedRefNames と同じパターン言語です。

rules 配列

このルールセット内の保護ルール。

rules[].id string

このルールの Stable Origin ID。

rules[].ruleType 文字列

ルールの種類。例: pull_request、require_status_checks、require_branch_up_to_date、deletion、non_fast_forward。

rules[].parameters オブジェクト

型固有のパラメータをJSONオブジェクトとして指定します。形式はrules[].ruleTypeによって異なります。

bypassActors 配列

このルールセットをバイパスできる主体。保存された識別情報を読み取れないバイパス実行者は応答から省略されます。

bypassActors[].id string

このバイパスアクターの安定したオリジンID。

bypassActors[].bypassMode string

バイパスが適用される場合。指定可能な値: always、pull_request_only。

bypassActors[].user オブジェクト

ユーザープリンシパル。user、team、app、または originRole のうち正確に1つが存在します。

bypassActors[].user.id 文字列

10進数の文字列としてエンコードされた数値のカーソルユーザーID。

bypassActors[].team オブジェクト

チーム代表。

bypassActors[].team.organizationPublicId 文字列

変更不可の組織公開IDです。

bypassActors[].team.groupPublicId string

不変のグループ公開 ID。

bypassActors[].app オブジェクト

アプリケーションのプリンシパル。

bypassActors[].app.id string

app_ プレフィックス付きの App ID。

bypassActors[].originRole オブジェクト

Origin ロールを持つプリンシパル。

bypassActors[].originRole.role string

指定可能な値: namespace_admin、repository_admin、repository_write。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/rulesets/RULESET_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造:

{  "id": "rs_01k2ja2000e0080000000000t7",  "name": "require-review",  "description": "Require an approving review before merging to main.",  "enforcement": "active",  "kind": "merge_branch",  "includedRefNames": [    "refs/heads/main"  ],  "rules": [    {      "id": "rsr_01k2ja2000e0080000000000v8",      "ruleType": "pull_request",      "parameters": {        "requiredApprovingReviewCount": 1      }    }  ],  "bypassActors": [    {      "id": "rsba_01k2ja2000e0080000000000w9",      "bypassMode": "always",      "user": {        "id": "act_01k2ja2000e0080000000000x0"      }    }  ]}

ルールセットの更新

PUT/v1/origin/repos/{ownerSlug}/{repoName}/rulesets/{rulesetId}

Scoperepository:rulesets:writeAuthInstallation tokenUser access token

既存のリポジトリルールセットを更新します。

パスパラメータ

ownerSlug string 必須

所有エンティティの一意のスラッグ。

repoName string 必須

オーナーエンティティ内で一意のリポジトリ名です。

rulesetId string 必須

Stable Origin のルールセットID。

リクエスト本文

name string 必須

ルールセット名。

description 文字列

ルールセットの説明。

enforcement string 必須

Origin によるルールセットの適用方法。指定可能な値: active、evaluate、disabled。

kind string 必須

ルールセットが保護する操作。許容される値: merge_branch, push_branch, push_tag, push_repository。

includedRefNames 配列

excludedRefNames 配列

このルールセットが除外するリファレンス名のパターン。includedRefNames と同じパターン言語を使用し、上限は64件です。

rules array

bypassActors 配列

レスポンスフィールド

id string

Stable Origin のルールセット ID。

name string

ルールセット名。

description 文字列

ルールセットの説明。

enforcement 文字列

Origin によるルールセットの適用方法。指定可能な値: active、evaluate、disabled。

kind string

ルールセットが保護する操作。許容される値: merge_branch, push_branch, push_tag, push_repository。

includedRefNames 配列

このルールセットに含まれる ref 名のパターン。glob とトークン ~ALL、~DEFAULT_BRANCH をサポートします。

excludedRefNames 配列

このルールセットで除外する ref 名のパターン。includedRefNames と同じパターン言語です。

rules array

このルールセットの保護ルール。

rules[].id string

このルールの安定したオリジン ID。

rules[].ruleType string

ルールの種類。例: pull_request、require_status_checks、require_branch_up_to_date、deletion、non_fast_forward。

rules[].parameters オブジェクト

タイプ別のパラメータを JSON オブジェクトとして指定します。構造は rules[].ruleType によって異なります。

bypassActors 配列

このルールセットを回避できる主体。保存された識別情報を読み取れないバイパス対象はレスポンスから除外されます。

bypassActors[].id string

このバイパスアクターの安定したオリジンID。

bypassActors[].bypassMode string

バイパスが適用されるタイミング。指定可能な値: always、pull_request_only。

bypassActors[].user オブジェクト

ユーザープリンシパル。user、team、app、originRole のうち、存在するのは 1 つだけです。

bypassActors[].user.id string

10進数の文字列としてエンコードされた数値のCherri CodeユーザーID。

bypassActors[].team オブジェクト

チーム代表。

bypassActors[].team.organizationPublicId string

変更不可能な組織の公開ID。

bypassActors[].team.groupPublicId string

変更不可能なグループの公開ID。

bypassActors[].app オブジェクト

アプリケーションプリンシパル。

bypassActors[].app.id string

アプリ ID。app_ のプレフィックスが付きます。

bypassActors[].originRole オブジェクト

Origin ロールを持つプリンシパル。

bypassActors[].originRole.role 文字列

指定可能な値: namespace_admin、repository_admin、repository_write。

curl --request PUT \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/rulesets/RULESET_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "name": "require-review",  "description": "Require an approving review before merging to main.",  "enforcement": "active",  "kind": "merge_branch",  "includedRefNames": [    "refs/heads/main"  ],  "rules": [    {      "ruleType": "pull_request",      "parameters": {        "requiredApprovingReviewCount": 1      }    }  ],  "bypassActors": [    {      "bypassMode": "always",      "user": {        "id": "act_01k2ja2000e0080000000000x0"      }    }  ]}'

レスポンスの構造:

{  "id": "rs_01k2ja2000e0080000000000t7",  "name": "require-review",  "description": "Require an approving review before merging to main.",  "enforcement": "active",  "kind": "merge_branch",  "includedRefNames": [    "refs/heads/main"  ],  "rules": [    {      "id": "rsr_01k2ja2000e0080000000000v8",      "ruleType": "pull_request",      "parameters": {        "requiredApprovingReviewCount": 1      }    }  ],  "bypassActors": [    {      "id": "rsba_01k2ja2000e0080000000000w9",      "bypassMode": "always",      "user": {        "id": "act_01k2ja2000e0080000000000x0"      }    }  ]}

ルールセットを削除

DELETE/v1/origin/repos/{ownerSlug}/{repoName}/rulesets/{rulesetId}

Scoperepository:rulesets:writeAuthInstallation tokenUser access token

安定したオリジン ID を指定してリポジトリルールセットを削除します。レスポンス本文は空です。

パスパラメータ

ownerSlug 文字列必須

所有エンティティの一意の slug。

repoName 文字列必須

オーナーエンティティ内で一意のリポジトリ名。

rulesetId 文字列必須

安定したオリジンルールセット ID。

レスポンスフィールド

成功したリクエストでは、レスポンス本文は返されません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/rulesets/RULESET_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンス:

204 No Content

SSH 認証局

SSH 認証局の一覧を取得

GET/v1/origin/owners/{ownerSlug}/ssh-certificate-authorities

Scopenamespace:settings:readAuthInstallation tokenUser access token

パスパラメータ

ownerSlug string 必須

認証局の一覧を取得する所有者の slug。

レスポンスフィールド

certificateAuthorities array

所有者が信頼するすべての認証局 (新しい順) 。

certificateAuthorities[].id string

認証局の識別子。SSH 認証局を削除で certificateAuthorityId として指定します。

certificateAuthorities[].name string

認証局の追加時に付けたラベル。

certificateAuthorities[].keyType string

認証局の公開鍵の OpenSSH キータイプ (例: ssh-ed25519) 。

certificateAuthorities[].fingerprint string

公開鍵の SHA-256 フィンガープリント。ssh-keygen -l が出力するのと同じ SHA256:<base64> 形式です。

certificateAuthorities[].publicKey string

認証局の公開鍵。コメントを含まない <key_type> <base64> 形式です。

certificateAuthorities[].createdAt string

認証局が追加された日時 (RFC 3339 形式のタイムスタンプ) 。

requireCertificates boolean

所有者が SSH 証明書を必須としているかどうか。詳しくは SSH 証明書の要件を設定を参照してください。

curl --request GET \  --url 'https://api.cursor.com/v1/origin/owners/OWNER_SLUG/ssh-certificate-authorities' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンスの構造：

{  "certificateAuthorities": [    {      "id": "nsca_01k2ja2000e0080000000000s5",      "name": "Acme production CA",      "keyType": "ssh-ed25519",      "fingerprint": "SHA256:D5vlIclvaSZlwq4gmckavfLE7n7F542Eyhk/PvXkRq0",      "publicKey": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIPwoQNzBuiWhDF4EKwRyt8h48XRY7Bc4yWbQ9s3Tnj7Q",      "createdAt": "2026-08-02T14:45:00Z"    }  ],  "requireCertificates": true}

SSH 認証局を追加する

POST/v1/origin/owners/{ownerSlug}/ssh-certificate-authorities

Scopenamespace:settings:writeAuthUser access token

パスパラメータ

ownerSlug string 必須

所有者の slug。

リクエスト本文

publicKey string 必須

name string 必須

認証局のラベル (最大 255 文字) 。

レスポンスフィールド

id string

認証局の識別子。SSH 認証局を削除するで certificateAuthorityId として指定します。

name string

認証局の追加時に指定したラベル。

keyType string

認証局の公開鍵の OpenSSH キータイプ (例: ssh-ed25519) 。

fingerprint string

公開鍵の SHA-256 フィンガープリント。ssh-keygen -l が出力するのと同じ SHA256:<base64> 形式です。

publicKey string

認証局の公開鍵。コメントを含まない <key_type> <base64> 形式です。

createdAt string

認証局が追加された日時 (RFC 3339 形式のタイムスタンプ) 。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/owners/OWNER_SLUG/ssh-certificate-authorities' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "publicKey": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIPwoQNzBuiWhDF4EKwRyt8h48XRY7Bc4yWbQ9s3Tnj7Q acme-ssh-ca",  "name": "Acme production CA"}'

レスポンスの構造:

{  "id": "nsca_01k2ja2000e0080000000000s5",  "name": "Acme production CA",  "keyType": "ssh-ed25519",  "fingerprint": "SHA256:D5vlIclvaSZlwq4gmckavfLE7n7F542Eyhk/PvXkRq0",  "publicKey": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIPwoQNzBuiWhDF4EKwRyt8h48XRY7Bc4yWbQ9s3Tnj7Q",  "createdAt": "2026-08-02T14:45:00Z"}

SSH 認証局を削除

DELETE/v1/origin/owners/{ownerSlug}/ssh-certificate-authorities/{certificateAuthorityId}

Scopenamespace:settings:writeAuthUser access token

パスパラメータ

ownerSlug 文字列必須

所有者の slug。

certificateAuthorityId 文字列必須

削除する認証局の id。

レスポンスフィールド

リクエストが成功した場合、レスポンス本文は返されません。

curl --request DELETE \  --url 'https://api.cursor.com/v1/origin/owners/OWNER_SLUG/ssh-certificate-authorities/CERTIFICATE_AUTHORITY_ID' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

レスポンス:

204 No Content

SSH 証明書の必須設定を指定

POST/v1/origin/owners/{ownerSlug}/ssh-certificate-authorities:setRequirement

Scopenamespace:settings:writeAuthUser access token

パスパラメータ

ownerSlug 文字列必須

所有者の slug。

リクエスト本文

requireCertificates boolean 必須

true の場合、所有者のリポジトリで SSH 証明書を必須にします。false の場合、必須設定を解除します。

レスポンスフィールド

requireCertificates boolean

所有者が SSH 経由の git アクセスに SSH 証明書を必須としているかどうか。

curl --request POST \  --url 'https://api.cursor.com/v1/origin/owners/OWNER_SLUG/ssh-certificate-authorities:setRequirement' \  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN' \  --header 'Content-Type: application/json' \  --data '{  "requireCertificates": true}'

レスポンスの構造:

{  "requireCertificates": true}

Webhooks

Origin は、署名付き HTTP POST リクエストを、アプリに登録された HTTPS Webhook URL に content-type: application/json として送信します。

実際のイベントが到達する前に受信側が動作することを確認するには、Ping Webhook を呼び出してください。

ヘッダー

ヘッダー	説明
`content-type`	`application/json`
`user-agent`	`Cherri Code-Origin-Webhook/1.0`
`webhook-id`	配信ごとに一定のIDおよび冪等性キー。
`webhook-timestamp`	署名に含まれるUnixタイムスタンプ。
`webhook-signature`	`v1ed,BASE64_SIGNATURE`
`webhook-event-type`	ルーティング用のイベントスラッグ。
`webhook-event-id`	署名付き本文に含まれる元のOriginイベントID。
`webhook-app-id`	ターゲットアプリID。
`webhook-installation-id`	ターゲットインストールID。

ルーティングヘッダーは補助的な情報です。署名検証後は、本文を正とします。

署名の検証

解析前の生のリクエスト本文を使用します。次のように構築します。

lowercaseHex(SHA-256("<webhook-id>.<webhook-timestamp>.<raw-request-body>"))

import {  createHash,  createPublicKey,  verify,  type JsonWebKeyInput,} from "node:crypto";export async function verifyOriginWebhook(  body: Buffer,  headers: Record<string, string | undefined>): Promise<boolean> {  const id = headers["webhook-id"];  const timestamp = Number(headers["webhook-timestamp"]);  const signature = headers["webhook-signature"]    ?.split(/\s+/)    .find((value) => value.startsWith("v1ed,"));  const now = Math.floor(Date.now() / 1000);  if (    !id ||    !signature ||    !Number.isInteger(timestamp) ||    Math.abs(now - timestamp) > 300  ) {    return false;  }  const digest = createHash("sha256")    .update(`${id}.${timestamp}.`)    .update(body)    .digest("hex");  // 本番環境ではこのレスポンスをキャッシュしてください。  const { keys } = await fetch(    "https://api.cursor.com/v1/origin/keys"  ).then((response) => response.json()) as {    keys: JsonWebKeyInput[];  };  return keys.some((jwk) => {    try {      return verify(        null,        Buffer.from(digest),        createPublicKey({ key: jwk, format: "jwk" }),        Buffer.from(signature.slice(5), "base64")      );    } catch {      return false;    }  });}

配信エンベロープ

各リクエストでは、イベントペイロードが配信、アプリ、インストール ID の情報とともにラップされます。

{  "deliveryId": "whd_01...",  "appId": "app_01...",  "installationId": "i_01...",  "event": {    "id": "evt_01...",    "type": "pull_request.comment.created",    "eventTime": "2026-07-01T10:03:00Z",    "payload": {}  }}

deliveryId は再試行しても変わりません。event.id は基となるドメインイベントを識別します。

イベント	配信されるタイミング
`repository.created`	リポジトリが作成されたとき。
`repository.deleted`	リポジトリが削除されたとき。
`repository.pushed`	プッシュにより1つ以上のリファレンスが変更されたとき。
`repository.metadata.updated`	リポジトリのデフォルトブランチが変更されたとき。
`pull_request.created`	プルリクエストが作成されたとき。
`pull_request.head_ref.pushed`	プルリクエストのヘッドが進んだとき。
`pull_request.base_ref.updated`	ベースリファレンスまたは解決済みのベースコミットが変更されたとき。
`pull_request.metadata.updated`	タイトルまたは説明が変更されたとき。
`pull_request.closed`	プルリクエストがマージされずにクローズされたとき。プッシュによりヘッドとベースに共通の履歴がなくなり、オリジンがクローズした場合を含みます。
`pull_request.merged`	プルリクエストがマージされたとき。
`pull_request.reopened`	クローズされたプルリクエストが再オープンされたとき。
`pull_request.published`	下書きのプルリクエストがオープンになったとき。
`pull_request.label.added`	プルリクエストにラベルが付与されたとき。
`pull_request.label.removed`	プルリクエストからラベルが解除されたとき。ラベル定義が削除された場合を含みます。
`pull_request.comment.created`	表示可能なプルリクエストコメントが作成されたとき。
`pull_request.comment.reaction.added`	プルリクエストコメントにリアクションが付けられたとき。リアクションを行ったユーザーがすでに付けているリアクションを再度付けると、このイベントが再度配信されます。
`pull_request.comment.reaction.removed`	プルリクエストコメントからリアクションが削除されたとき。リアクションを行ったユーザーが付けていないリアクションを削除しても、何も配信されません。
`pull_request.review.submitted`	任意の判定で確認が送信されたとき。
`pull_request.review.dismissed`	送信済み確認が明示的に、または後続のレビューにより無効化されたとき。
`pull_request.reviewer.added`	レビュアーがリクエストされたとき。
`pull_request.reviewer.removed`	レビュアーが削除されたとき。
`pull_request.reviewer.rerequested`	レビュアーが再度リクエストされたとき。
`repository.check_run.created`	チェック実行が作成されたとき。
`repository.check_run.completed`	チェック実行が完了したとき。
`repository.check_run.rerequested`	完了したチェック実行が再リクエストされたとき。その実行を所有するアプリにのみ配信されます。
`installation.created`	アプリがインストールされたとき。
`installation.updated`	スコープ、リポジトリの選択、またはオーナーの namespace スラッグが変更されたとき。
`installation.suspended`	インストールが一時停止されたとき。
`installation.unsuspended`	一時停止されたインストールが復元されたとき。
`installation.deleted`	アプリがアンインストールされたとき。

各イベントのペイロードの構造は、イベントペイロードでフィールドごとに記載されています。

repository.id string

repository.name string 必須

repo 名。owner 内で一意である必要があります。create 時は必須です。

repository.fullName string

"{owner.login}/{name}"。自動生成されます。

repository.owner object

所有エンティティ。作成時に parent から決定され、直接設定することはできません。

repository.owner.slug string

オーナーの一意な、URL に使用できる名前。

repository.owner.id string

オーナー namespace の一意な ID。

repository.owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

repository.defaultBranch string

repository.createdAt string

RFC 3339 形式のタイムスタンプ。

repository.updatedAt string

RFC 3339 形式のタイムスタンプ。

repository.pushedAt string

いずれかのブランチへの最新プッシュのタイムスタンプ。最初のプッシュが行われるまでは含まれません。RFC 3339 形式のタイムスタンプ。

repository.cloneUrl string

リポジトリをクローンするための HTTPS URL。

repository.mirror object

ミラーのメタデータ。ネイティブリポジトリの場合、およびミラーの初回同期が完了するまでは含まれません。

repository.mirror.source string

github のいずれか。

repository.mirror.sourceId string

ソースが付与する不透明なリポジトリ識別子。

repository.mirror.status string

移行中、カットオーバー完了までの実効的な方向。inbound、outbound のいずれか。

repository.visibility string

リポジトリの可視性。internal または private。internal、private のいずれか。

repository.allowMergeCommit boolean

プルリクエストをマージコミットとして取り込めるかどうか。

repository.allowSquashMerge boolean

プルリクエストを squash merge でマージできるかどうか。

repository.deleteBranchOnMerge boolean

マージ時にヘッドブランチを自動的に削除するかどうか。

event.payload の例:

{  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "fullName": "acme/rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    },    "defaultBranch": "main",    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-01T09:30:00Z",    "cloneUrl": "https://origin.cursor.com/git/acme/rocket.git"  }}

リポジトリ削除

EVENTrepository.deleted

ペイロードのフィールド

repository object

削除されたリポジトリ。参照用のみです。削除後は、API 経由でこのリポジトリを解決できなくなります。

repository.id string

repository.name string

repository.owner object

リポジトリの所有者。

repository.owner.slug string

所有者の一意で URL に適した名前。

repository.owner.id string

所有者の namespace の一意な ID。

repository.owner.type string

team または user。output-only で、不明な場合は未設定です。team、user のいずれか。

deletedAt string

リポジトリが削除された日時。RFC 3339 形式の timestamp。

event.payload のサンプル:

{  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  },  "deletedAt": "2026-08-03T08:15:00Z"}

リポジトリへのプッシュ

EVENTrepository.pushed

ペイロードのフィールド

repository object

プッシュ先のリポジトリ。

repository.id string

repository.name string

repository.owner object

repo の owner。

repository.owner.slug string

オーナーの一意な、URL に使用できる名前。

repository.owner.id string

所有者の名前空間の一意な ID。

repository.owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

refUpdates 配列

このプッシュに含まれるリファレンス (最大100件) 。

refUpdates[].ref string

プッシュされた完全な git ref。例: refs/heads/main、refs/tags/v3.14.1。

refUpdates[].before string

プッシュ前の ref 上の最新コミットの SHA。ref が作成された直後の場合はすべてゼロ (0000000000000000000000000000000000000000) になります。

refUpdates[].after string

プッシュ後の ref における最新コミットの SHA。ref が削除された場合はすべてゼロ (0000000000000000000000000000000000000000) になります。

refUpdates[].created boolean

このプッシュで ref が作成されたかどうか。

refUpdates[].deleted boolean

このプッシュで ref が削除されたかどうか。

refUpdates[].forced boolean

refUpdates[].headCommit object

refUpdates[].headCommit.sha string

refUpdates[].headCommit.author オブジェクト

refUpdates[].headCommit.author.name string

refUpdates[].headCommit.author.email string

refUpdates[].headCommit.author.date string

git署名の元のタイムゾーンオフセットを保持するISO-8601形式のタイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

refUpdates[].headCommit.committer object

refUpdates[].headCommit.committer.name string

refUpdates[].headCommit.committer.email string

refUpdates[].headCommit.committer.date string

git signature の元のタイムゾーンオフセットを保持する ISO-8601 形式のタイムスタンプ (例: "2014-11-07T22:01:45+01:00") 。

refUpdates[].headCommit.message string

pushedAt string

Origin がプッシュを検知した時刻。RFC 3339 形式のタイムスタンプ。

pusher オブジェクト

pusher.user オブジェクト

pusher.user.id string

pusher.user.email string 必須

pusher.user.displayName string

pusher.user.handle string

pusher.user.performedVia オブジェクト

pusher.user.performedVia.app object

ユーザーに代わって操作を行ったアプリ。

pusher.user.performedVia.app.id string

pusher.user.performedVia.app.displayName string

pusher.app object

pusher.app.id string

pusher.app.displayName string

pusher.serviceAccount オブジェクト

pusher.serviceAccount.id string

refUpdatesCount integer

アトミックなプッシュに含まれる ref の更新数。プロデューサーがリストを制限した場合、ref_updates はこれより短くなることがあります。

event.payload の例:

{  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  },  "refUpdates": [    {      "ref": "refs/heads/add-telemetry",      "before": "5c8d7e6f5a4b3c2d1e0f9a8b7c6d5e4f3a2b1c0d",      "after": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "created": false,      "deleted": false,      "forced": false,      "headCommit": {        "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",        "author": {          "name": "Jane Doe",          "email": "[email protected]",          "date": "2026-08-01T09:30:00Z"        },        "committer": {          "name": "Jane Doe",          "email": "[email protected]",          "date": "2026-08-01T09:30:00Z"        },        "message": "Add launch telemetry"      }    }  ],  "pushedAt": "2026-08-02T14:45:00Z",  "pusher": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "refUpdatesCount": 1}

リポジトリのメタデータが更新されました

EVENTrepository.metadata.updated

ペイロードのフィールド

repository object

更新後のリポジトリ全体のスナップショット。

repository.id string

repository.name string 必須

リポジトリ名。owner 内で一意である必要があります。create 時は必須です。

repository.fullName string

"{owner.login}/{name}"。自動生成されます。

repository.owner object

所有エンティティ。作成時に parent から決定されるため、直接設定することはできません。

repository.owner.slug string

owner の一意な URL セーフな名前。

repository.owner.id string

オーナー namespace の一意な ID。

repository.owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

repository.defaultBranch string

repository.createdAt string

RFC 3339 形式の timestamp。

repository.updatedAt string

RFC 3339 形式の timestamp。

repository.pushedAt string

いずれかのブランチへの最新プッシュのタイムスタンプ。最初のプッシュが行われるまでは含まれません。RFC 3339 形式のタイムスタンプ。

repository.cloneUrl string

リポジトリをクローンするための HTTPS URL。

repository.mirror object

ミラーのメタデータ。ネイティブリポジトリの場合、およびミラーの初回同期が完了する前は存在しません。

repository.mirror.source string

github のいずれか。

repository.mirror.sourceId string

ソースによって付与される、不透明なリポジトリ識別子。

repository.mirror.status string

移行中、カットオーバーが完了するまでの実効的な方向。inbound、outbound のいずれか。

repository.visibility string

リポジトリの可視性。internal または private。internal、private のいずれか。

repository.allowMergeCommit boolean

プルリクエストをマージコミットとして取り込めるかどうか。

repository.allowSquashMerge boolean

プルリクエストを squash merge でマージできるかどうか。

repository.deleteBranchOnMerge boolean

マージ時にヘッドブランチを自動的に削除するかどうか。

event.payload のサンプル:

{  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "fullName": "acme/rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    },    "defaultBranch": "release",    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-03T08:15:00Z",    "cloneUrl": "https://origin.cursor.com/git/acme/rocket.git",    "pushedAt": "2026-08-02T14:45:00Z"  }}

プルリクエストイベント

プルリクエストのライフサイクルの変更です。ライフサイクルのアクションはエンベロープの event.type で、別個の action フィールドはありません。

ペイロードのフィールド

pullRequest オブジェクト

プルリクエストのスナップショット。付与されたラベルは含まれないため、GetPullRequest で取得してください。

pullRequest.id string

Stable Origin のプルリクエスト識別子。

pullRequest.number string

リポジトリ内でのプルリクエスト番号。

pullRequest.state string

"open"または"closed"。ドラフトは"open"で、マージ済みおよびクローズ済みのプルリクエストはいずれも"closed"です。

pullRequest.draft boolean

プルリクエストがまだドラフトかどうか。

pullRequest.merged boolean

プルリクエストがマージされているかどうか。

pullRequest.title string

プルリクエストのタイトル。

pullRequest.body string

プルリクエストの説明。

pullRequest.head object

プルリクエストのソース側 — マージされる内容です。

pullRequest.head.ref string

この側が参照している ref (Origin の記録上) 。

pullRequest.head.sha string

pullRequest.base object

プルリクエストのターゲット側 — マージ先のブランチです。

pullRequest.base.ref string

Originの記録上、この側が参照しているref。

pullRequest.base.sha string

pullRequest.author object

プルリクエストを作成したプリンシパル。

pullRequest.author.user オブジェクト

pullRequest.author.user.id string

pullRequest.author.user.email string 必須

pullRequest.author.user.displayName string

pullRequest.author.user.handle string

pullRequest.author.user.performedVia オブジェクト

pullRequest.author.user.performedVia.app オブジェクト

ユーザーの代理で操作を行ったアプリ。

pullRequest.author.user.performedVia.app.id 文字列

pullRequest.author.user.performedVia.app.displayName string

pullRequest.author.app オブジェクト

pullRequest.author.app.id string

pullRequest.author.app.displayName string

pullRequest.author.serviceAccount object

pullRequest.author.serviceAccount.id string

pullRequest.createdAt string

プルリクエストが作成された時点。RFC 3339形式のタイムスタンプ。

pullRequest.updatedAt string

プルリクエストが最後に更新された日時。RFC 3339 形式のタイムスタンプ。

pullRequest.closedAt string

プルリクエストがクローズまたはマージされた日時。オープン中は未設定。RFC 3339 形式のタイムスタンプ。

pullRequest.mergedAt string

プルリクエストがマージされた日時。マージされていない場合は未設定。RFC 3339 形式のタイムスタンプ。

pullRequest.mergeCommitSha string

pullRequest.additions integer

プルリクエストの最新バージョンで追加された行。

pullRequest.deletions integer

プルリクエストの最新バージョンで削除された行。

pullRequest.changedFiles integer

プルリクエストの最新バージョンで変更されたファイル。

pullRequest.stack オブジェクト

スタックのメンバーシップ。プルリクエストがスタックの一部でない場合は未設定。

pullRequest.stack.id 文字列

スタックの安定した識別子。stack_id として ListPullRequests に渡すと、そのスタックのメンバーを一覧表示できます。

pullRequest.stack.parentPullRequest オブジェクト

pullRequest.stack.parentPullRequest.id 文字列

不変のオリジン変更 ID。

pullRequest.stack.parentPullRequest.number 文字列

pullRequest.stack.parentPullRequest.repository オブジェクト

このプルリクエストのリポジトリへの参照。

pullRequest.stack.parentPullRequest.repository.id 文字列

pullRequest.stack.parentPullRequest.repository.name string

pullRequest.stack.parentPullRequest.repository.owner オブジェクト

リポジトリの所有者。

pullRequest.stack.parentPullRequest.repository.owner.slug string

所有者の URL フレンドリーな一意の名前。

pullRequest.stack.parentPullRequest.repository.owner.id string

オーナーの namespace の一意な ID。

pullRequest.stack.parentPullRequest.repository.owner.type 文字列

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

pullRequest.version object

プルリクエストの最新バージョン。

pullRequest.version.number string

変更内の単調増加するバージョン番号 (1始まり) 。

pullRequest.version.headSha string

このバージョンのヘッドコミットのSHA。

pullRequest.version.baseSha string

pullRequest.version.createdAt string

このバージョンが作成された日時。RFC 3339 形式のタイムスタンプ。

pullRequest.version.potentialMergeCommit オブジェクト

pullRequest.version.potentialMergeCommit.state string

pullRequest.version.potentialMergeCommit.sha 文字列

pullRequest.version.potentialMergeCommit.baseSha 文字列

repository オブジェクト

プルリクエストが属するリポジトリ。

repository.id string

repository.name string

repository.owner object

リポジトリの所有者。

repository.owner.slug string

所有者の URL フレンドリーな一意の名前。

repository.owner.id string

オーナーの namespace の一意な ID。

repository.owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

event.payload のサンプル:

{  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "state": "open",    "draft": false,    "merged": false,    "title": "Add launch telemetry",    "body": "Adds structured launch telemetry to the ignition path.",    "head": {      "ref": "add-telemetry",      "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4"    },    "base": {      "ref": "add-telemetry-schema",      "sha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"    },    "author": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    },    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z",    "additions": 128,    "deletions": 46,    "changedFiles": 5,    "stack": {      "id": "stk_01k2ja2000e0080000000000s1",      "parentPullRequest": {        "id": "pr_01k2ja2000e0080000000000d3",        "number": "16",        "repository": {          "id": "repo_01k2ja2000e0080000000000q4",          "name": "rocket",          "owner": {            "slug": "acme",            "id": "ns_01k2ja2000e0080000000000p3",            "type": "team"          }        }      }    },    "version": {      "number": "3",      "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8",      "createdAt": "2026-08-01T09:30:00Z"    }  },  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  }}

プルリクエストのラベルイベント

EVENTpull_request.label.addedpull_request.label.removed

プルリクエストに付与されたラベルの変更です。現在のラベルは ListPullRequestLabels で取得できます。

ペイロードのフィールド

pullRequest オブジェクト

付与されたラベルが変更されたプルリクエスト。

pullRequest.id 文字列

不変のオリジン変更ID。

pullRequest.number 文字列

pullRequest.repository オブジェクト

このプルリクエストのリポジトリ参照先。

pullRequest.repository.id 文字列

pullRequest.repository.name 文字列

pullRequest.repository.owner オブジェクト

リポジトリの所有者。

pullRequest.repository.owner.slug 文字列

所有者を識別する、URL向けの一意な名前。

pullRequest.repository.owner.id 文字列

オーナーの namespace の一意な ID。

pullRequest.repository.owner.type 文字列

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

label オブジェクト

イベントの対象となるラベル。

label.id 文字列

label.name 文字列

label.color string

先頭の # を除く6文字の16進数カラーコード。

label.description 文字列

actor オブジェクト

ラベルを付与または削除したプリンシパル (判明している場合) 。

actor.user オブジェクト

actor.user.id 文字列

actor.user.email 文字列必須

actor.user.displayName 文字列

actor.user.handle 文字列

actor.user.performedVia オブジェクト

actor.user.performedVia.app オブジェクト

ユーザーに代わって操作を行ったアプリ。

actor.user.performedVia.app.id 文字列

actor.user.performedVia.app.displayName 文字列

actor.app オブジェクト

actor.app.id 文字列

actor.app.displayName 文字列

actor.serviceAccount オブジェクト

actor.serviceAccount.id 文字列

event.payload のサンプル:

{  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    }  },  "label": {    "id": "lbl_01k2ja2000e0080000000000m1",    "name": "bug",    "color": "d73a4a",    "description": "Something isn't working"  },  "actor": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  }}

プルリクエストコメント

EVENTpull_request.comment.created

ペイロードのフィールド

pullRequest オブジェクト

コメントが投稿されたプルリクエスト。

pullRequest.id string

変更不可の Origin の変更 ID。

pullRequest.number string

pullRequest.repository object

このプルリクエストのリポジトリ参照先。

pullRequest.repository.id string

pullRequest.repository.name string

pullRequest.repository.owner object

リポジトリの所有者。

pullRequest.repository.owner.slug string

所有者の URL に適した一意の名前。

pullRequest.repository.owner.id string

オーナー名前空間の一意の ID。

pullRequest.repository.owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

comment object

comment.id string

comment.thread オブジェクト

このコメントが属するスレッド。diffアンカーと解決状態を含みます。

comment.thread.id string

comment.thread.version object

スレッドが紐づけられたプルリクエストのバージョン。head と base の SHA を含みます (PullRequestReview.pull_request_version を参照) 。

comment.thread.version.number string

プルリクエスト内で単調増加するバージョン番号 (1始まり) 。

comment.thread.version.headSha string

このバージョンのHEADコミットのSHA。

comment.thread.version.baseSha string

このバージョンの差分比較に使用するベースコミットのSHA。

comment.thread.path string

スレッドの差分アンカーのファイルパス。一般的なディスカッションのスレッドでは空です。

comment.thread.side string

アンカーの差分側。全般的な議論スレッドでは未設定。left、right のいずれか。

comment.thread.startLine integer

ファイルの side バージョンにおけるアンカー範囲の最初の行。ファイル全体および一般的なディスカッションのスレッドでは 0。

comment.thread.endLine integer

アンカー範囲に含まれる最終行。アンカーが単一行の場合、または行範囲がない場合は 0。

comment.thread.resolvedAt string

スレッドが解決された日時。スレッドがオープンの間は未設定です。RFC 3339 形式のタイムスタンプ。

comment.thread.createdAt string

RFC 3339 形式のタイムスタンプ。

comment.thread.updatedAt string

RFC 3339 形式のタイムスタンプ。

comment.body string

comment.author オブジェクト

外部から確認できるアクションを実行したユーザー、アプリ、またはサービスアカウント。

comment.author.user オブジェクト

comment.author.user.id string

comment.author.user.email string 必須

comment.author.user.displayName string

comment.author.user.handle string

comment.author.user.performedVia オブジェクト

comment.author.user.performedVia.app オブジェクト

ユーザーに代わって操作を行ったアプリ。

comment.author.user.performedVia.app.id string

comment.author.user.performedVia.app.displayName string

comment.author.app オブジェクト

comment.author.app.id string

comment.author.app.displayName string

comment.author.serviceAccount オブジェクト

comment.author.serviceAccount.id string

comment.createdAt string

RFC 3339 形式のタイムスタンプ。

comment.updatedAt string

RFC 3339 形式のタイムスタンプ。

event.payload の例:

{  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    }  },  "comment": {    "id": "cmt_01k2ja2000e0080000000000e5",    "thread": {      "id": "cth_01k2ja2000e0080000000000s6",      "version": {        "number": "3",        "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",        "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"      },      "path": "src/telemetry/retry.ts",      "side": "right",      "startLine": 42,      "endLine": 45,      "createdAt": "2026-08-01T09:30:00Z",      "updatedAt": "2026-08-02T14:45:00Z"    },    "body": "Should the retry budget be configurable?",    "author": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    },    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z"  }}

プルリクエストコメントのリアクションイベント

EVENTpull_request.comment.reaction.addedpull_request.comment.reaction.removed

ペイロードのフィールド

pullRequest オブジェクト

コメントが投稿されたプルリクエスト。

pullRequest.id string

不変の Origin 変更 ID。

pullRequest.number string

pullRequest.repository object

このプルリクエストのリポジトリ参照。

pullRequest.repository.id string

pullRequest.repository.name string

pullRequest.repository.owner object

リポジトリの所有者。

pullRequest.repository.owner.slug string

所有者のURLに適した一意の名前。

pullRequest.repository.owner.id string

所有者の名前空間の一意な ID。

pullRequest.repository.owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

comment object

リアクションが付いたコメント。

comment.id string

comment.thread オブジェクト

このコメントが属するスレッドです。

comment.thread.id string

reaction オブジェクト

追加または削除されたリアクション。

reaction.content 文字列

reaction.reactor オブジェクト

reaction.reactor.user オブジェクト

reaction.reactor.user.id 文字列

reaction.reactor.user.email string 必須

reaction.reactor.user.displayName string

reaction.reactor.user.handle string

reaction.reactor.user.performedVia オブジェクト

reaction.reactor.user.performedVia.app オブジェクト

ユーザーに代わって操作したアプリ。

reaction.reactor.user.performedVia.app.id 文字列

reaction.reactor.user.performedVia.app.displayName 文字列

reaction.reactor.app オブジェクト

reaction.reactor.app.id string

reaction.reactor.app.displayName string

reaction.reactor.serviceAccount オブジェクト

reaction.reactor.serviceAccount.id string

event.payload の例:

{  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    }  },  "comment": {    "id": "cmt_01k2ja2000e0080000000000e5",    "thread": {      "id": "cth_01k2ja2000e0080000000000s6"    }  },  "reaction": {    "content": "thumbs_up",    "reactor": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    }  }}

プルリクエストレビューイベント

EVENTpull_request.review.submittedpull_request.review.dismissed

ペイロードのフィールド

pullRequest オブジェクト

レビューが提出されたプルリクエスト。

pullRequest.id string

不変のオリジン変更 ID。

pullRequest.number string

pullRequest.repository object

このプルリクエストに関連するリポジトリ。

pullRequest.repository.id string

pullRequest.repository.name string

pullRequest.repository.owner object

リポジトリの所有者。

pullRequest.repository.owner.slug string

オーナーを識別する、URLで使用できる一意の名前。

pullRequest.repository.owner.id string

所有者ネームスペースの一意な ID。

pullRequest.repository.owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

review オブジェクト

送信されたか却下されたレビュー。却下された場合、review.dismissal が設定されます。

review.id string

Stable Origin のレビュー識別子。

review.author object

レビューを作成したプリンシパル。

review.author.user object

review.author.user.id string

review.author.user.email string 必須

review.author.user.displayName string

review.author.user.handle string

review.author.user.performedVia object

review.author.user.performedVia.app オブジェクト

ユーザーに代わって操作を行ったアプリ。

review.author.user.performedVia.app.id string

review.author.user.performedVia.app.displayName string

review.author.app object

review.author.app.id string

review.author.app.displayName string

review.author.serviceAccount object

review.author.serviceAccount.id string

review.verdict string

approve、request_changes、comment のいずれか。

review.body string

自由記述のレビュー要約。レビュー担当者が要約を残していない場合は空です。

review.submittedAt string

レビューが送信された時刻。未送信の下書きレビューの場合は未設定。RFC 3339 形式のタイムスタンプ。

review.pullRequestVersion オブジェクト

判定の対象となるプルリクエストのバージョンと HEAD SHA。

review.pullRequestVersion.number string

プルリクエスト内での単調増加バージョン番号 (1 始まり) 。

review.pullRequestVersion.headSha string

このバージョンのヘッドコミットのSHA。

review.pullRequestVersion.baseSha string

このバージョンの差分比較の基準となるベースコミットの SHA。

review.dismissal オブジェクト

レビューが却下されると設定されます。判定がプルリクエストのレビュー状態に反映されている間は表示されません。

review.dismissal.dismissedBy object

レビューを却下した主体。却下がこの API が公開していない種類のアクターによって記録されている場合は存在しません。

review.dismissal.dismissedBy.user object

review.dismissal.dismissedBy.user.id string

review.dismissal.dismissedBy.user.email string 必須

review.dismissal.dismissedBy.user.displayName string

review.dismissal.dismissedBy.user.handle string

review.dismissal.dismissedBy.user.performedVia object

review.dismissal.dismissedBy.user.performedVia.app オブジェクト

ユーザーの代理として操作したアプリ。

review.dismissal.dismissedBy.user.performedVia.app.id string

review.dismissal.dismissedBy.user.performedVia.app.displayName string

review.dismissal.dismissedBy.app object

review.dismissal.dismissedBy.app.id string

review.dismissal.dismissedBy.app.displayName string

review.dismissal.dismissedBy.serviceAccount object

review.dismissal.dismissedBy.serviceAccount.id string

review.dismissal.dismissedAt string

レビューが却下された日時。RFC 3339形式のタイムスタンプ。

review.dismissal.message string

却下時に記録された理由。作成者が新しい判定を送信したため自動的に無効化されたレビューには、サーバーが生成した理由が付与されます。

event.payload の例:

{  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    }  },  "review": {    "id": "rev_01k2ja2000e0080000000000f6",    "author": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    },    "verdict": "approve",    "body": "Approving. The telemetry schema matches the spec.",    "submittedAt": "2026-08-02T15:00:00Z",    "pullRequestVersion": {      "number": "3",      "headSha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",      "baseSha": "3b1f9c2d8a7e6f5049c8b7a6d5e4f3a2b1c0d9e8"    }  }}

プルリクエストレビュアーのイベント

EVENTpull_request.reviewer.addedpull_request.reviewer.removedpull_request.reviewer.rerequested

プルリクエストのレビュー依頼先の変更。現在保留中の一覧は ListPullRequestRequestedReviewers で取得できます。

ペイロードのフィールド

pullRequest オブジェクト

レビュー依頼先が変更されたプルリクエスト。

pullRequest.id string

変更元の変更IDは不変です。

pullRequest.number string

pullRequest.repository object

このプルリクエストのリポジトリへの参照。

pullRequest.repository.id string

pullRequest.repository.name string

pullRequest.repository.owner object

リポジトリの所有者。

pullRequest.repository.owner.slug string

オーナーの一意な、URL に使用可能な名前。

pullRequest.repository.owner.id string

所有者名前空間の一意の ID。

pullRequest.repository.owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

reviewer object

このイベントに関する、依頼されたレビュー担当者。

reviewer.user object

reviewer.user.id string

reviewer.user.email string 必須

reviewer.user.displayName string

reviewer.user.handle string

reviewer.user.performedVia オブジェクト

reviewer.user.performedVia.app オブジェクト

ユーザーに代わって操作を行ったアプリ。

reviewer.user.performedVia.app.id string

reviewer.user.performedVia.app.displayName string

reviewer.group object

公開 Origin グループの ID (grp_…) 。現在は id のみ。

reviewer.group.id string

createdVia string

確認リクエストの作成方法。manual、codeowners のいずれか。

createdBy オブジェクト

レビューリクエストを作成した主体 (判明している場合) 。

createdBy.user オブジェクト

createdBy.user.id string

createdBy.user.email string 必須

createdBy.user.displayName string

createdBy.user.handle string

createdBy.user.performedVia オブジェクト

createdBy.user.performedVia.app オブジェクト

ユーザーに代わって操作を行ったアプリ。

createdBy.user.performedVia.app.id string

createdBy.user.performedVia.app.displayName string

createdBy.app オブジェクト

createdBy.app.id string

createdBy.app.displayName string

createdBy.serviceAccount オブジェクト

createdBy.serviceAccount.id string

createdAt string

確認リクエストが作成された日時。RFC 3339 形式のタイムスタンプ。

event.payload のサンプル:

{  "pullRequest": {    "id": "pr_01k2ja2000e0080000000000d4",    "number": "17",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    }  },  "reviewer": {    "user": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "createdVia": "codeowners",  "createdAt": "2026-08-02T14:45:00Z"}

チェック実行イベント

EVENTrepository.check_run.createdrepository.check_run.updatedrepository.check_run.completed

Origin の check-run ライフサイクルイベントのコミット済みスナップショット。

ペイロードのフィールド

repository オブジェクト

チェック実行が属するリポジトリ。

repository.id string

repository.name string

repository.owner object

リポジトリの所有者。

repository.owner.slug string

所有者の一意でURLに適した名前。

repository.owner.id string

オーナーの namespace の一意の ID。

repository.owner.type string

team または user。出力専用。不明な場合は未設定。team または user のいずれか。

checkSuite オブジェクト

このチェック実行が属するスイート。

checkSuite.id string

サーバーによって割り当てられたスイートの一意のID。

checkSuite.repository object

スイートが属するリポジトリ。

checkSuite.repository.id string

checkSuite.repository.name string

checkSuite.repository.owner object

リポジトリの所有者。

checkSuite.repository.owner.slug string

所有者の一意でURLに適した名前。

checkSuite.repository.owner.id string

所有者の名前空間の一意の ID。

checkSuite.repository.owner.type string

team または user。出力専用。不明な場合は未設定。team または user のいずれか。

checkSuite.sha string

スイートが紐付けられている解決済みヘッドコミットのSHA (小文字の16進数) 。

checkSuite.key string

スイート用にアプリが選択した冪等性キー。

checkSuite.name string

ユーザー向けのスイート名。

checkSuite.detailsUrl string

設定されている場合、スイート全体の詳細へのリンク。

checkSuite.createdAt string

RFC 3339 形式のタイムスタンプ。

checkSuite.updatedAt string

RFC 3339 形式のタイムスタンプ。

checkSuite.externalId string

このスイート試行に対してプロバイダーが割り当てた不変の識別子。

checkSuite.actor オブジェクト

スイートを生成したプリンシパル。

checkSuite.actor.user オブジェクト

checkSuite.actor.user.id string

checkSuite.actor.user.email string 必須

checkSuite.actor.user.displayName string

checkSuite.actor.user.handle string

checkSuite.actor.user.performedVia オブジェクト

checkSuite.actor.user.performedVia.app オブジェクト

ユーザーに代わって操作したアプリ。

checkSuite.actor.user.performedVia.app.id string

checkSuite.actor.user.performedVia.app.displayName string

checkSuite.actor.app オブジェクト

checkSuite.actor.app.id string

checkSuite.actor.app.displayName string

checkSuite.actor.serviceAccount オブジェクト

checkSuite.actor.serviceAccount.id string

checkRun object

このライフサイクル時点におけるチェック実行のスナップショット。

checkRun.id string

サーバーによって割り当てられたチェック実行の一意のID。

checkRun.repository object

チェック実行が属するリポジトリ。

checkRun.repository.id string

checkRun.repository.name string

checkRun.repository.owner オブジェクト

リポジトリの所有者。

checkRun.repository.owner.slug string

所有者の一意でURLに適した名前。

checkRun.repository.owner.id string

所有者の名前空間の一意の ID。

checkRun.repository.owner.type string

team または user。出力専用。不明な場合は未設定。team または user のいずれか。

checkRun.checkSuite オブジェクト

このチェック実行が属するスイート。

checkRun.checkSuite.id string

checkRun.sha string

チェック実行が紐付けられている解決済みの head コミット SHA (小文字の16進数) 。

checkRun.key string

チェック実行に対してアプリが指定した冪等性キー。

checkRun.name string

ユーザー向けのチェックラン名。

checkRun.status string

checkRun.conclusion string

checkRun.detailsUrl string

設定されている場合、この特定のチェック実行に関する詳細情報へのリンク。

checkRun.externalUpdatedAt string

順序付けに使用する外部システムの最終更新時刻。RFC 3339形式のタイムスタンプ。

checkRun.startedAt string

チェック実行が開始された時刻 (報告されている場合) 。RFC 3339 形式のタイムスタンプ。

checkRun.completedAt string

チェックの実行が完了した時刻 (報告されている場合) 。RFC 3339形式のタイムスタンプ。

checkRun.createdAt string

RFC 3339 形式のタイムスタンプ。

checkRun.updatedAt string

checkRun.externalId string

このチェック試行に対してプロバイダーが割り当てる不変の識別子 (CheckRunInput.external_id を参照。実行ごとに1つ割り当てることを推奨します) 。

checkRun.actor オブジェクト

チェック実行を生成したプリンシパル。常に所有するスイートのactorです。

checkRun.actor.user object

checkRun.actor.user.id string

checkRun.actor.user.email string 必須

checkRun.actor.user.displayName string

checkRun.actor.user.handle string

checkRun.actor.user.performedVia オブジェクト

checkRun.actor.user.performedVia.app オブジェクト

ユーザーに代わって操作したアプリ。

checkRun.actor.user.performedVia.app.id string

checkRun.actor.user.performedVia.app.displayName string

アプリの登録済み表示名。存在する場合は空ではありません。アプリを解決できなかったペイロード、およびファーストパーティのCherri Codeファサードアクターでは省略されます。

checkRun.actor.app オブジェクト

checkRun.actor.app.id string

checkRun.actor.app.displayName string

アプリの登録済み表示名。存在する場合は空ではありません。アプリを解決できなかったペイロード、およびファーストパーティのCherri Codeファサードアクターでは省略されます。

checkRun.actor.serviceAccount object

checkRun.actor.serviceAccount.id string

checkRun.output object

設定されている場合、このチェック実行の人間が読める形式の出力。

checkRun.output.title string

出力用の短い見出し。最大文字数: 255文字。

checkRun.output.summary string

出力の要約。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRun.output.text string

詳細な出力。Markdownを含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRun.deadlineAt string

checkRun.isRerequestable boolean

報告元のアプリがこの実行を再リクエスト可能と宣言したかどうか (CheckRunInput.is_rerequestable)。

checkRun.rerequestedAt string

checkRun.rerequestedBy オブジェクト

この実行を再リクエストした主体。rerequested_at が設定されている場合にのみ存在し、所有アプリが応答した際にそれとともにクリアされます。

checkRun.rerequestedBy.user オブジェクト

checkRun.rerequestedBy.user.id string

checkRun.rerequestedBy.user.email string 必須

checkRun.rerequestedBy.user.displayName string

checkRun.rerequestedBy.user.handle string

checkRun.rerequestedBy.user.performedVia オブジェクト

checkRun.rerequestedBy.user.performedVia.app オブジェクト

ユーザーに代わって操作を行ったアプリ。

checkRun.rerequestedBy.user.performedVia.app.id string

checkRun.rerequestedBy.user.performedVia.app.displayName string

アプリの登録済み表示名。存在する場合は空ではありません。アプリを解決できなかったペイロード、およびファーストパーティのCherri Codeファサードアクターでは省略されます。

checkRun.rerequestedBy.app オブジェクト

checkRun.rerequestedBy.app.id string

checkRun.rerequestedBy.app.displayName string

アプリの登録済み表示名。存在する場合は空ではありません。アプリを解決できなかったペイロード、およびファーストパーティのCherri Codeファサードアクターでは省略されます。

checkRun.rerequestedBy.serviceAccount オブジェクト

checkRun.rerequestedBy.serviceAccount.id string

event.payload のサンプル:

{  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  },  "checkSuite": {    "id": "crg_01k2ja2000e0080000000000h8",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    },    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "key": "ci-8842",    "name": "CI",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z",    "externalId": "build-8842",    "actor": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    }  },  "checkRun": {    "id": "cr_01k2ja2000e0080000000000g7",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    },    "checkSuite": {      "id": "crg_01k2ja2000e0080000000000h8"    },    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "key": "ci-8842-unit-tests",    "name": "unit-tests",    "status": "completed",    "conclusion": "success",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "externalUpdatedAt": "2026-08-02T14:44:30Z",    "startedAt": "2026-08-02T14:40:00Z",    "completedAt": "2026-08-02T14:44:30Z",    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z",    "externalId": "run-8842",    "actor": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    },    "output": {      "title": "Unit tests",      "summary": "128 tests passed.",      "text": "All suites green."    }  }}

チェック実行の再リクエスト

EVENTrepository.check_run.rerequested

ペイロードのフィールド

repository オブジェクト

チェック実行が属するリポジトリです。

repository.id string

repository.name string

repository.owner オブジェクト

リポジトリの所有者。

repository.owner.slug string

オーナーの一意で URL に使える名前。

repository.owner.id string

所有者ネームスペースの一意のID。

repository.owner.type string

team または user。出力専用。不明な場合は未設定。team または user のいずれか。

checkSuite オブジェクト

このチェック実行が属するスイート。

checkSuite.id string

サーバーにより割り当てられたスイートの一意の ID。

checkSuite.repository object

スイートが属しているリポジトリ。

checkSuite.repository.id string

checkSuite.repository.name string

checkSuite.repository.owner object

リポジトリの所有者。

checkSuite.repository.owner.slug string

オーナーのURL向けの固有名。

checkSuite.repository.owner.id string

所有者ネームスペースの一意のID。

checkSuite.repository.owner.type string

team または user。出力専用。不明な場合は未設定。team または user のいずれか。

checkSuite.sha string

スイートが紐づけられている解決済みの head コミット SHA (小文字の16進数) 。

checkSuite.key string

スイート用にアプリが選択した冪等キー。

checkSuite.name string

ユーザー向けのスイート名。

checkSuite.detailsUrl string

設定されている場合、スイート全体の詳細へのリンク。

checkSuite.createdAt string

RFC 3339 形式のタイムスタンプ。

checkSuite.updatedAt string

RFC 3339 形式のタイムスタンプ。

checkSuite.externalId string

このスイート試行に対してプロバイダーが割り当てた不変の識別子。

checkSuite.actor オブジェクト

スイートを生成した主体。

checkSuite.actor.user オブジェクト

checkSuite.actor.user.id string

checkSuite.actor.user.email string 必須

checkSuite.actor.user.displayName string

checkSuite.actor.user.handle string

checkSuite.actor.user.performedVia オブジェクト

checkSuite.actor.user.performedVia.app オブジェクト

ユーザーに代わって操作したアプリ。

checkSuite.actor.user.performedVia.app.id string

checkSuite.actor.user.performedVia.app.displayName string

checkSuite.actor.app オブジェクト

checkSuite.actor.app.id string

checkSuite.actor.app.displayName string

checkSuite.actor.serviceAccount オブジェクト

checkSuite.actor.serviceAccount.id string

checkRun オブジェクト

checkRun.id 文字列

チェック実行にサーバーによって割り当てられた一意のID。

checkRun.repository object

チェック実行が属するリポジトリ。

checkRun.repository.id string

checkRun.repository.name string

checkRun.repository.owner オブジェクト

リポジトリの所有者。

checkRun.repository.owner.slug string

オーナーの一意で URL に使える名前。

checkRun.repository.owner.id string

所有者ネームスペースの一意のID。

checkRun.repository.owner.type string

team または user。出力専用。不明な場合は未設定。team または user のいずれか。

checkRun.checkSuite オブジェクト

このチェック実行が属するスイート。

checkRun.checkSuite.id string

checkRun.sha 文字列

チェック実行が紐づけられている解決済みのヘッドコミット SHA (小文字の16進数) 。

checkRun.key string

チェック実行に対してアプリが指定した冪等性キー。

checkRun.name 文字列

ユーザー向けに表示されるチェックランの名前。

checkRun.status string

checkRun.conclusion string

checkRun.detailsUrl string

設定されている場合、この特定のチェック実行の詳細へのリンク。

checkRun.externalUpdatedAt string

順序付けに使用する外部システムの最終更新時刻。RFC 3339 形式のタイムスタンプ。

checkRun.startedAt string

チェック実行が開始された時刻 (報告されている場合) 。RFC 3339形式のタイムスタンプ。

checkRun.completedAt string

チェック実行が完了した日時 (報告されている場合) 。RFC 3339形式のタイムスタンプ。

checkRun.createdAt string

RFC 3339 形式のタイムスタンプ。

checkRun.updatedAt string

checkRun.externalId string

checkRun.actor オブジェクト

チェック実行を生成した主体。常に所有スイートの actor と一致します。

checkRun.actor.user オブジェクト

checkRun.actor.user.id string

checkRun.actor.user.email string 必須

checkRun.actor.user.displayName string

checkRun.actor.user.handle string

checkRun.actor.user.performedVia object

checkRun.actor.user.performedVia.app オブジェクト

ユーザーに代わって操作したアプリ。

checkRun.actor.user.performedVia.app.id string

checkRun.actor.user.performedVia.app.displayName 文字列

checkRun.actor.app オブジェクト

checkRun.actor.app.id string

checkRun.actor.app.displayName string

checkRun.actor.serviceAccount オブジェクト

checkRun.actor.serviceAccount.id string

checkRun.output オブジェクト

設定されている場合に表示される、このチェック実行の人間が読める形式の出力。

checkRun.output.title string

出力用の短い見出し。最大文字数: 255文字。

checkRun.output.summary string

出力の要約。Markdown を含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRun.output.text string

詳細な出力。Markdownを含む場合があります。最大 UTF-8 サイズ: 65535 バイト。

checkRun.deadlineAt 文字列

checkRun.isRerequestable boolean

レポートアプリがこの実行を再リクエスト可能と宣言したかどうか (CheckRunInput.is_rerequestable) 。

checkRun.rerequestedAt string

checkRun.rerequestedBy オブジェクト

実行を再リクエストした主体。rerequested_at が設定されている場合にのみ存在し、所有アプリが応答すると同時にクリアされます。

checkRun.rerequestedBy.user オブジェクト

checkRun.rerequestedBy.user.id string

checkRun.rerequestedBy.user.email string 必須

checkRun.rerequestedBy.user.displayName string

checkRun.rerequestedBy.user.handle string

checkRun.rerequestedBy.user.performedVia オブジェクト

checkRun.rerequestedBy.user.performedVia.app オブジェクト

ユーザーに代わって操作したアプリ。

checkRun.rerequestedBy.user.performedVia.app.id string

checkRun.rerequestedBy.user.performedVia.app.displayName string

checkRun.rerequestedBy.app オブジェクト

checkRun.rerequestedBy.app.id string

checkRun.rerequestedBy.app.displayName string

checkRun.rerequestedBy.serviceAccount オブジェクト

checkRun.rerequestedBy.serviceAccount.id string

event.payload のサンプル:

{  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  },  "checkSuite": {    "id": "crg_01k2ja2000e0080000000000h8",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    },    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "key": "ci-8842",    "name": "CI",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T15:10:00Z",    "externalId": "build-8842",    "actor": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    }  },  "checkRun": {    "id": "cr_01k2ja2000e0080000000000g7",    "repository": {      "id": "repo_01k2ja2000e0080000000000q4",      "name": "rocket",      "owner": {        "slug": "acme",        "id": "ns_01k2ja2000e0080000000000p3",        "type": "team"      }    },    "checkSuite": {      "id": "crg_01k2ja2000e0080000000000h8"    },    "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",    "key": "ci-8842-unit-tests",    "name": "unit-tests",    "status": "rerequested",    "conclusion": "failure",    "detailsUrl": "https://ci.acme.dev/runs/8842",    "externalUpdatedAt": "2026-08-02T14:44:30Z",    "startedAt": "2026-08-02T14:40:00Z",    "completedAt": "2026-08-02T14:44:30Z",    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T15:10:00Z",    "externalId": "run-8842",    "actor": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    },    "output": {      "title": "Unit tests",      "summary": "1 of 129 tests failed.",      "text": "FAIL telemetry.spec.ts > flushes queued events on shutdown"    },    "isRerequestable": true,    "rerequestedAt": "2026-08-02T15:10:00Z",    "rerequestedBy": {      "user": {        "id": "user_01k2ja2000e0080000000000c3",        "email": "[email protected]"      }    }  }}

インストールが作成されました

EVENTinstallation.created

ペイロードのフィールド

installation オブジェクト

イベント発生時点のインストールスナップショット。

installation.id string

installation.appId string

インストールされたアプリの識別子。ペイロードの app.id と同じ値です。

installation.target オブジェクト

リポジトリの所有者。

installation.target.slug string

オーナーの一意な URL セーフ名。

installation.target.id string

オーナー名前空間の一意な ID。

installation.target.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.repoSelectionMode string

all、selected のいずれか。

installation.repositories array

repository_selection が "all" の場合は空になります。最大 5,000 件までに制限されます。実際の合計は repositories_count を参照してください。

installation.repositories[].id string

installation.repositories[].name string

installation.repositories[].owner object

リポジトリの所有者。

installation.repositories[].owner.slug string

オーナーの一意な URL セーフ名。

installation.repositories[].owner.id string

オーナーの namespace の一意な ID。

installation.repositories[].owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.scopes array

installation.repositoriesCount integer

実際の合計数。repository_selection が "all" の場合は 0 になります。

installation.createdAt string

RFC 3339 形式のタイムスタンプ。

installation.updatedAt string

RFC 3339 形式のタイムスタンプ。

installation.deletedAt string

RFC 3339 形式のタイムスタンプ。

installation.suspendedAt string

インストールが一時停止中に設定され、アクティブな間は解除されます。RFC 3339形式のタイムスタンプ。

installation.installedBy object

アプリを最初にインストールしたユーザー。

installation.installedBy.id string

installation.installedBy.email string 必須

installation.installedBy.displayName string

installation.installedBy.handle string

installation.installedBy.performedVia オブジェクト

installation.installedBy.performedVia.app オブジェクト

ユーザーに代わって操作したアプリ。

installation.installedBy.performedVia.app.id string

installation.installedBy.performedVia.app.displayName string

app オブジェクト

このインストールが属するアプリ。

app.id string

app.displayName string

event.payload のサンプル:

{  "installation": {    "id": "inst_01k2ja2000e0080000000000b2",    "appId": "app_01k2ja2000e0080000000000a1",    "target": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    },    "repoSelectionMode": "selected",    "repositories": [      {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      }    ],    "scopes": [      "repository:contents:read",      "repository:pull_requests:read"    ],    "repositoriesCount": 1,    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-01T09:30:00Z",    "installedBy": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "app": {    "id": "app_01k2ja2000e0080000000000a1",    "displayName": "CI Status Bot"  }}

インストールの更新

EVENTinstallation.updated

ペイロードのフィールド

installation オブジェクト

イベント発生時点のインストールのスナップショット。

installation.id string

installation.appId string

インストール済みアプリの識別子。ペイロード上の app.id と同じ値です。

installation.target オブジェクト

リポジトリの所有者。

installation.target.slug string

オーナーを識別する、URLで使いやすい一意の名前。

installation.target.id string

オーナーの namespace の一意な ID。

installation.target.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.repoSelectionMode string

all、selected のいずれか。

installation.repositories array

repository_selection が "all" の場合は空になります。最大 5,000 件までに制限されます。実際の合計は repositories_count を参照してください。

installation.repositories[].id string

installation.repositories[].name string

installation.repositories[].owner object

リポジトリの所有者。

installation.repositories[].owner.slug string

オーナーのURL向けの一意な名前。

installation.repositories[].owner.id string

オーナーの namespace の一意な ID。

installation.repositories[].owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.scopes array

installation.repositoriesCount integer

実際の合計数。repository_selection が "all" の場合は 0 になります。

installation.createdAt string

RFC 3339 形式のタイムスタンプ。

installation.updatedAt string

RFC 3339 形式のタイムスタンプ。

installation.deletedAt string

RFC 3339 形式のタイムスタンプ。

installation.suspendedAt string

インストールが一時停止中の場合に設定され、有効な場合は設定されません。RFC 3339 形式のタイムスタンプです。

installation.installedBy object

アプリを最初にインストールしたユーザー。

installation.installedBy.id string

installation.installedBy.email string 必須

installation.installedBy.displayName string

installation.installedBy.handle string

installation.installedBy.performedVia オブジェクト

installation.installedBy.performedVia.app オブジェクト

ユーザーに代わって操作を行ったアプリ。

installation.installedBy.performedVia.app.id string

installation.installedBy.performedVia.app.displayName string

app オブジェクト

このインストールが属するアプリ。

app.id string

app.displayName string

アプリの登録済み表示名。存在する場合は空にはなりません。エンキュー時のハイドレーションでアプリを解決できなかった場合は省略されます。

event.payload のサンプル:

{  "installation": {    "id": "inst_01k2ja2000e0080000000000b2",    "appId": "app_01k2ja2000e0080000000000a1",    "target": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    },    "repoSelectionMode": "selected",    "repositories": [      {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      }    ],    "scopes": [      "repository:contents:read",      "repository:pull_requests:read"    ],    "repositoriesCount": 1,    "createdAt": "2026-08-01T09:30:00Z",    "updatedAt": "2026-08-02T14:45:00Z",    "installedBy": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "app": {    "id": "app_01k2ja2000e0080000000000a1",    "displayName": "CI Status Bot"  }}

インストールの一時停止

EVENTinstallation.suspended

ペイロードのフィールド

installation オブジェクト

イベント発生時点のインストールのスナップショット。

installation.id string

installation.appId string

インストールされたアプリの識別子。ペイロードの app.id と同じ値です。

installation.target オブジェクト

リポジトリの所有者。

installation.target.slug string

オーナーの一意な URL セーフ名。

installation.target.id string

オーナーの namespace の一意な ID。

installation.target.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.repoSelectionMode string

all、selected のいずれか。

installation.repositories array

repository_selection が "all" の場合は空になります。最大 5,000 件までに制限されます。実際の合計は repositories_count を参照してください。

installation.repositories[].id string

installation.repositories[].name string

installation.repositories[].owner object

リポジトリの所有者。

installation.repositories[].owner.slug string

オーナーの一意なURL向けの名前。

installation.repositories[].owner.id string

オーナーの名前空間の一意なID。

installation.repositories[].owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.scopes array

installation.repositoriesCount integer

実際の合計数。repository_selection が "all" の場合は 0 になります。

installation.createdAt string

RFC 3339 形式のタイムスタンプ。

installation.updatedAt string

RFC 3339 形式のタイムスタンプ。

installation.deletedAt string

RFC 3339 形式のタイムスタンプ。

installation.suspendedAt string

インストールが一時停止されている間に設定され、アクティブな間は解除されます。RFC 3339形式のタイムスタンプ。

installation.installedBy object

アプリを最初にインストールしたユーザー。

installation.installedBy.id string

installation.installedBy.email string 必須

installation.installedBy.displayName string

installation.installedBy.handle string

installation.installedBy.performedVia オブジェクト

installation.installedBy.performedVia.app オブジェクト

ユーザーに代わって操作を行ったアプリ。

installation.installedBy.performedVia.app.id string

installation.installedBy.performedVia.app.displayName string

app オブジェクト

このインストールが属するアプリ。

app.id string

app.displayName string

event.payload のサンプル:

{  "installation": {    "id": "inst_01k2ja2000e0080000000000b2",    "appId": "app_01k2ja2000e0080000000000a1",    "target": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    },    "repoSelectionMode": "selected",    "repositories": [      {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      }    ],    "scopes": [      "repository:contents:read",      "repository:pull_requests:read"    ],    "repositoriesCount": 1,    "createdAt": "2026-08-01T09:30:00Z",    "installedBy": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    },    "suspendedAt": "2026-08-03T08:15:00Z"  },  "app": {    "id": "app_01k2ja2000e0080000000000a1",    "displayName": "CI Status Bot"  }}

インストールの一時停止解除

EVENTinstallation.unsuspended

ペイロードのフィールド

installation オブジェクト

イベント発生時点のインストールのスナップショット。

installation.id string

installation.appId string

インストール済みアプリの識別子。ペイロードの app.id と同じ値です。

installation.target オブジェクト

リポジトリの所有者。

installation.target.slug string

オーナーの一意な URL セーフ名。

installation.target.id string

オーナーの namespace の一意な ID。

installation.target.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.repoSelectionMode string

all、selected のいずれか。

installation.repositories array

repository_selection が "all" の場合は空になります。最大 5,000 件までに制限されます。実際の合計は repositories_count を参照してください。

installation.repositories[].id string

installation.repositories[].name string

installation.repositories[].owner object

リポジトリの所有者。

installation.repositories[].owner.slug string

オーナーの一意なURL向けの名前。

installation.repositories[].owner.id string

オーナーの namespace の一意な ID。

installation.repositories[].owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.scopes array

installation.repositoriesCount integer

実際の合計数。repository_selection が "all" の場合は 0 になります。

installation.createdAt string

RFC 3339 形式のタイムスタンプ。

installation.updatedAt string

RFC 3339 形式のタイムスタンプ。

installation.deletedAt string

RFC 3339 形式のタイムスタンプ。

installation.suspendedAt string

インストールが一時停止中は設定され、有効な場合は設定解除されます。RFC 3339形式のタイムスタンプです。

installation.installedBy object

アプリを最初にインストールしたユーザー。

installation.installedBy.id string

installation.installedBy.email string 必須

installation.installedBy.displayName string

installation.installedBy.handle string

installation.installedBy.performedVia オブジェクト

installation.installedBy.performedVia.app オブジェクト

ユーザーの代わりに操作を実行したアプリ。

installation.installedBy.performedVia.app.id string

installation.installedBy.performedVia.app.displayName string

app オブジェクト

このインストールが属するアプリ。

app.id string

app.displayName string

event.payload のサンプル:

{  "installation": {    "id": "inst_01k2ja2000e0080000000000b2",    "appId": "app_01k2ja2000e0080000000000a1",    "target": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    },    "repoSelectionMode": "selected",    "repositories": [      {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      }    ],    "scopes": [      "repository:contents:read",      "repository:pull_requests:read"    ],    "repositoriesCount": 1,    "createdAt": "2026-08-01T09:30:00Z",    "installedBy": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    }  },  "app": {    "id": "app_01k2ja2000e0080000000000a1",    "displayName": "CI Status Bot"  }}

インストールが削除されました

EVENTinstallation.deleted

ペイロードのフィールド

installation オブジェクト

イベント発生時点のインストールのスナップショット。

installation.id string

installation.appId string

インストールされたアプリの識別子。ペイロードの app.id と同じ値です。

installation.target オブジェクト

repo の owner。

installation.target.slug string

オーナーを識別する、URLで使いやすい一意の名前。

installation.target.id string

所有者の名前空間の一意な ID。

installation.target.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.repoSelectionMode string

all、selected のいずれか。

installation.repositories array

repository_selection が "all" の場合は空になります。最大 5,000 件までに制限されます。実際の合計は repositories_count を参照してください。

installation.repositories[].id string

installation.repositories[].name string

installation.repositories[].owner object

リポジトリの所有者。

installation.repositories[].owner.slug string

オーナーの一意な URL セーフ名。

installation.repositories[].owner.id string

オーナーの namespace の一意な ID。

installation.repositories[].owner.type string

team または user。出力専用。不明な場合は未設定。team、user のいずれか。

installation.scopes array

installation.repositoriesCount integer

実際の合計数。repository_selection が "all" の場合は 0 になります。

installation.createdAt string

RFC 3339 形式のタイムスタンプ。

installation.updatedAt string

RFC 3339 形式のタイムスタンプ。

installation.deletedAt string

RFC 3339 形式のタイムスタンプ。

installation.suspendedAt string

インストールが一時停止されている間は設定し、有効な場合は解除します。RFC 3339形式のタイムスタンプ。

installation.installedBy object

アプリを最初にインストールしたユーザー。

installation.installedBy.id string

installation.installedBy.email string 必須

installation.installedBy.displayName string

installation.installedBy.handle string

installation.installedBy.performedVia オブジェクト

installation.installedBy.performedVia.app オブジェクト

ユーザーに代わって操作を行ったアプリ。

installation.installedBy.performedVia.app.id string

installation.installedBy.performedVia.app.displayName string

app オブジェクト

このインストールが属するアプリ。

app.id string

app.displayName string

アプリに登録された表示名。存在する場合は空になりません。キュー登録時のハイドレーションでアプリを特定できなかった場合は省略されます。

event.payload のサンプル:

{  "installation": {    "id": "inst_01k2ja2000e0080000000000b2",    "appId": "app_01k2ja2000e0080000000000a1",    "target": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    },    "repoSelectionMode": "selected",    "repositories": [      {        "id": "repo_01k2ja2000e0080000000000q4",        "name": "rocket",        "owner": {          "slug": "acme",          "id": "ns_01k2ja2000e0080000000000p3",          "type": "team"        }      }    ],    "scopes": [      "repository:contents:read",      "repository:pull_requests:read"    ],    "repositoriesCount": 1,    "createdAt": "2026-08-01T09:30:00Z",    "installedBy": {      "id": "user_01k2ja2000e0080000000000c3",      "email": "[email protected]"    },    "deletedAt": "2026-08-03T08:15:00Z"  },  "app": {    "id": "app_01k2ja2000e0080000000000a1",    "displayName": "CI Status Bot"  }}

チェック実行の注釈

EVENTrepository.check_run.annotations.created

ペイロードのフィールド

repository オブジェクト

チェック実行が属するリポジトリ。

repository.id string

repository.name string

repository.owner object

リポジトリの所有者。

repository.owner.slug string

所有者の一意でURLに適した名前。

repository.owner.id string

所有者の名前空間の一意の ID。

repository.owner.type string

team または user。出力専用。不明な場合は未設定。team または user のいずれか。

checkRun オブジェクト

注釈が追加されたチェック実行と、それが属するスイート。

checkRun.id 文字列

checkRun.name 文字列

checkRun.checkSuite オブジェクト

このチェック実行が属するスイート。

checkRun.checkSuite.id string

sha 文字列

チェック実行が関連付けられている解決済みの head コミット SHA (小文字の16進数) 。

annotations 配列

追加された注釈 (リクエスト順) 。Originがリストの件数を制限した場合、annotations_count より少なくなることがあります。

annotations[].id 文字列

annotations[].checkRunId 文字列

annotations[].annotationLevel 文字列

notice、warning、failure のいずれか。

annotations[].message string

annotations[].title 文字列

annotations[].rawDetails 文字列

annotations[].createdAt 文字列

RFC 3339 形式のタイムスタンプ。

annotations[].updatedAt 文字列

RFC 3339 形式のタイムスタンプ。

annotations[].location オブジェクト

annotations[].location.path 文字列必須

最大 UTF-8 サイズ: 4096 バイト。

annotations[].location.startLine integer 必須

annotations[].location.endLine integer 必須

annotations[].location.columns オブジェクト

1行の注釈範囲を指定する、任意の列位置の組。

annotations[].location.columns.startColumn integer

annotations[].location.columns.endColumn integer

annotationsCount integer

リクエストによって追加された注釈の数。

createdAt 文字列

バッチが追加された時刻。RFC 3339 形式のタイムスタンプ。

event.payload のサンプル:

{  "repository": {    "id": "repo_01k2ja2000e0080000000000q4",    "name": "rocket",    "owner": {      "slug": "acme",      "id": "ns_01k2ja2000e0080000000000p3",      "type": "team"    }  },  "checkRun": {    "id": "cr_01k2ja2000e0080000000000g7",    "name": "unit-tests",    "checkSuite": {      "id": "crg_01k2ja2000e0080000000000h8"    }  },  "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",  "annotations": [    {      "id": "cra_01k2ja2000e0080000000000v1",      "checkRunId": "cr_01k2ja2000e0080000000000g7",      "annotationLevel": "warning",      "message": "Deprecated API usage; migrate to the v2 client.",      "title": "Deprecated API",      "createdAt": "2026-08-02T14:45:00Z",      "updatedAt": "2026-08-02T14:45:00Z",      "location": {        "path": "src/telemetry.ts",        "startLine": 42,        "endLine": 42,        "columns": {          "startColumn": 5,          "endColumn": 31        }      }    },    {      "id": "cra_01k2ja2000e0080000000000v2",      "checkRunId": "cr_01k2ja2000e0080000000000g7",      "annotationLevel": "failure",      "message": "Three tests failed in telemetry.test.ts.",      "title": "Test failures",      "rawDetails": "FAIL telemetry.test.ts flushes on shutdown (expected 1 call, received 0)",      "createdAt": "2026-08-02T14:45:00Z",      "updatedAt": "2026-08-02T14:45:00Z"    }  ],  "annotationsCount": 2,  "createdAt": "2026-08-02T14:45:00Z"}

Command Palette

API の概要

Cloud Agents API

管理者 API

Analytics API

AI コード追跡 API

オリジン移行 API

オリジン API

Origin API