Skip to main content
REST API はバージョン化されました。 詳細については、「API のバージョン管理について」を参照してください。

REST API endpoints for Copilot Spaces

Use the REST API to interact with Copilot Spaces resources.

List resources for an organization Copilot Space

Lists all resources attached to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view the space.

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

"List resources for an organization Copilot Space" のきめ細かいアクセス トークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

  • "Copilot Spaces" organization permissions (read)

"List resources for an organization Copilot Space" のパラメーター

ヘッダー
名前, タイプ, 説明
accept string

Setting to application/vnd.github+json is recommended.

パスパラメーター
名前, タイプ, 説明
org string 必須

The organization name. The name is not case sensitive.

space_number integer 必須

The unique identifier of the Copilot Space.

"List resources for an organization Copilot Space" の HTTP 応答状態コード

状態コード説明
200

OK

403

Forbidden

404

Resource not found

"List resources for an organization Copilot Space" のコード サンプル

要求の例

get/orgs/{org}/copilot-spaces/{space_number}/resources
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/orgs/ORG/copilot-spaces/SPACE_NUMBER/resources

Response

Status: 200
{ "resources": [ { "id": 1, "resource_type": "repository", "copilot_chat_attachment_id": null, "metadata": { "repository_id": 42 }, "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T00:00:00Z" }, { "id": 2, "resource_type": "free_text", "copilot_chat_attachment_id": null, "metadata": { "name": "notes.txt", "text": "Some helpful notes" }, "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T00:00:00Z" } ] }

Create a resource for an organization Copilot Space

Creates a new resource in a specific Copilot Space owned by an organization. The authenticated user must have write permissions on the space.

The following resource types are supported: repository, github_file, free_text, github_issue, github_pull_request. The uploaded_text_file and media_content types are not supported via this endpoint.

For github_file resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a 200 status.

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

"Create a resource for an organization Copilot Space" のきめ細かいアクセス トークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

  • "Copilot Spaces" organization permissions (write)

"Create a resource for an organization Copilot Space" のパラメーター

ヘッダー
名前, タイプ, 説明
accept string

Setting to application/vnd.github+json is recommended.

パスパラメーター
名前, タイプ, 説明
org string 必須

The organization name. The name is not case sensitive.

space_number integer 必須

The unique identifier of the Copilot Space.

ボディパラメータ
名前, タイプ, 説明
resource_type string 必須

The type of resource to create.

次のいずれかにできます: repository, github_file, free_text, github_issue, github_pull_request

metadata object 必須

Resource-specific metadata.

"Create a resource for an organization Copilot Space" の HTTP 応答状態コード

状態コード説明
200

Duplicate github_file resource already exists

201

Resource created

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Get a resource for an organization Copilot Space

Gets a specific resource attached to a Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view the space.

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

"Get a resource for an organization Copilot Space" のきめ細かいアクセス トークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

  • "Copilot Spaces" organization permissions (read)

"Get a resource for an organization Copilot Space" のパラメーター

ヘッダー
名前, タイプ, 説明
accept string

Setting to application/vnd.github+json is recommended.

パスパラメーター
名前, タイプ, 説明
org string 必須

The organization name. The name is not case sensitive.

space_number integer 必須

The unique identifier of the Copilot Space.

space_resource_id integer 必須

The unique identifier of the resource.

"Get a resource for an organization Copilot Space" の HTTP 応答状態コード

状態コード説明
200

OK

403

Forbidden

404

Resource not found

"Get a resource for an organization Copilot Space" のコード サンプル

要求の例

get/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/orgs/ORG/copilot-spaces/SPACE_NUMBER/resources/SPACE_RESOURCE_ID

Response

Status: 200
{ "id": 1, "resource_type": "free_text", "copilot_chat_attachment_id": null, "metadata": { "name": "notes.txt", "text": "Some helpful notes" }, "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T00:00:00Z" }

Set a resource for an organization Copilot Space

Updates the metadata of a resource in a specific Copilot Space owned by an organization. The authenticated user must have write permissions on the space.

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

"Set a resource for an organization Copilot Space" のきめ細かいアクセス トークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

  • "Copilot Spaces" organization permissions (write)

"Set a resource for an organization Copilot Space" のパラメーター

ヘッダー
名前, タイプ, 説明
accept string

Setting to application/vnd.github+json is recommended.

パスパラメーター
名前, タイプ, 説明
org string 必須

The organization name. The name is not case sensitive.

space_number integer 必須

The unique identifier of the Copilot Space.

space_resource_id integer 必須

The unique identifier of the resource.

ボディパラメータ
名前, タイプ, 説明
metadata object

Updated resource-specific metadata.

"Set a resource for an organization Copilot Space" の HTTP 応答状態コード

状態コード説明
200

OK

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

"Set a resource for an organization Copilot Space" のコード サンプル

要求の例

put/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/orgs/ORG/copilot-spaces/SPACE_NUMBER/resources/SPACE_RESOURCE_ID \ -d '{"metadata":{"name":"updated-notes.txt","text":"Updated content"}}'

Response

Status: 200
{ "id": 1, "resource_type": "free_text", "copilot_chat_attachment_id": null, "metadata": { "name": "updated-notes.txt", "text": "Updated content" }, "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T12:00:00Z" }

Delete a resource from an organization Copilot Space

Deletes a resource from a specific Copilot Space owned by an organization. The authenticated user must have write permissions on the space.

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

"Delete a resource from an organization Copilot Space" のきめ細かいアクセス トークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

  • "Copilot Spaces" organization permissions (write)

"Delete a resource from an organization Copilot Space" のパラメーター

ヘッダー
名前, タイプ, 説明
accept string

Setting to application/vnd.github+json is recommended.

パスパラメーター
名前, タイプ, 説明
org string 必須

The organization name. The name is not case sensitive.

space_number integer 必須

The unique identifier of the Copilot Space.

space_resource_id integer 必須

The unique identifier of the resource.

"Delete a resource from an organization Copilot Space" の HTTP 応答状態コード

状態コード説明
204

No Content

403

Forbidden

404

Resource not found

"Delete a resource from an organization Copilot Space" のコード サンプル

要求の例

delete/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/orgs/ORG/copilot-spaces/SPACE_NUMBER/resources/SPACE_RESOURCE_ID

Response

Status: 204

List resources for a Copilot Space for a user

Lists all resources attached to a specific Copilot Space owned by a user. The authenticated user must have appropriate permissions to view the space.

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

"List resources for a Copilot Space for a user" のきめ細かいアクセス トークン

このエンドポイントは、GitHubアプリ ユーザー アクセス トークン、GitHub アプリ インストール アクセス トークン、またはきめ細かい個人用アクセス トークンでは機能しません。

"List resources for a Copilot Space for a user" のパラメーター

ヘッダー
名前, タイプ, 説明
accept string

Setting to application/vnd.github+json is recommended.

パスパラメーター
名前, タイプ, 説明
username string 必須

The handle for the GitHub user account.

space_number integer 必須

The unique identifier of the Copilot Space.

"List resources for a Copilot Space for a user" の HTTP 応答状態コード

状態コード説明
200

OK

403

Forbidden

404

Resource not found

"List resources for a Copilot Space for a user" のコード サンプル

要求の例

get/users/{username}/copilot-spaces/{space_number}/resources
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/users/USERNAME/copilot-spaces/SPACE_NUMBER/resources

Response

Status: 200
{ "resources": [ { "id": 1, "resource_type": "free_text", "copilot_chat_attachment_id": null, "metadata": { "name": "notes.txt", "text": "Some helpful notes" }, "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T00:00:00Z" } ] }

Create a resource for a Copilot Space for a user

Creates a new resource in a specific Copilot Space owned by a user. The authenticated user must have write permissions on the space.

The following resource types are supported: repository, github_file, free_text, github_issue, github_pull_request. The uploaded_text_file and media_content types are not supported via this endpoint.

For github_file resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a 200 status.

OAuth app tokens and personal access tokens (classic) need the write:user scope to use this endpoint.

"Create a resource for a Copilot Space for a user" のきめ細かいアクセス トークン

このエンドポイントは、GitHubアプリ ユーザー アクセス トークン、GitHub アプリ インストール アクセス トークン、またはきめ細かい個人用アクセス トークンでは機能しません。

"Create a resource for a Copilot Space for a user" のパラメーター

ヘッダー
名前, タイプ, 説明
accept string

Setting to application/vnd.github+json is recommended.

パスパラメーター
名前, タイプ, 説明
username string 必須

The handle for the GitHub user account.

space_number integer 必須

The unique identifier of the Copilot Space.

ボディパラメータ
名前, タイプ, 説明
resource_type string 必須

The type of resource to create.

次のいずれかにできます: repository, github_file, free_text, github_issue, github_pull_request

metadata object 必須

Resource-specific metadata.

"Create a resource for a Copilot Space for a user" の HTTP 応答状態コード

状態コード説明
200

Duplicate github_file resource already exists

201

Resource created

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Get a resource for a Copilot Space for a user

Gets a specific resource attached to a Copilot Space owned by a user. The authenticated user must have appropriate permissions to view the space.

OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

"Get a resource for a Copilot Space for a user" のきめ細かいアクセス トークン

このエンドポイントは、GitHubアプリ ユーザー アクセス トークン、GitHub アプリ インストール アクセス トークン、またはきめ細かい個人用アクセス トークンでは機能しません。

"Get a resource for a Copilot Space for a user" のパラメーター

ヘッダー
名前, タイプ, 説明
accept string

Setting to application/vnd.github+json is recommended.

パスパラメーター
名前, タイプ, 説明
username string 必須

The handle for the GitHub user account.

space_number integer 必須

The unique identifier of the Copilot Space.

space_resource_id integer 必須

The unique identifier of the resource.

"Get a resource for a Copilot Space for a user" の HTTP 応答状態コード

状態コード説明
200

OK

403

Forbidden

404

Resource not found

"Get a resource for a Copilot Space for a user" のコード サンプル

要求の例

get/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/users/USERNAME/copilot-spaces/SPACE_NUMBER/resources/SPACE_RESOURCE_ID

Response

Status: 200
{ "id": 1, "resource_type": "free_text", "copilot_chat_attachment_id": null, "metadata": { "name": "notes.txt", "text": "Some helpful notes" }, "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T00:00:00Z" }

Set a resource for a Copilot Space for a user

Updates the metadata of a resource in a specific Copilot Space owned by a user. The authenticated user must have write permissions on the space.

OAuth app tokens and personal access tokens (classic) need the write:user scope to use this endpoint.

"Set a resource for a Copilot Space for a user" のきめ細かいアクセス トークン

このエンドポイントは、GitHubアプリ ユーザー アクセス トークン、GitHub アプリ インストール アクセス トークン、またはきめ細かい個人用アクセス トークンでは機能しません。

"Set a resource for a Copilot Space for a user" のパラメーター

ヘッダー
名前, タイプ, 説明
accept string

Setting to application/vnd.github+json is recommended.

パスパラメーター
名前, タイプ, 説明
username string 必須

The handle for the GitHub user account.

space_number integer 必須

The unique identifier of the Copilot Space.

space_resource_id integer 必須

The unique identifier of the resource.

ボディパラメータ
名前, タイプ, 説明
metadata object

Updated resource-specific metadata.

"Set a resource for a Copilot Space for a user" の HTTP 応答状態コード

状態コード説明
200

OK

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

"Set a resource for a Copilot Space for a user" のコード サンプル

要求の例

put/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/users/USERNAME/copilot-spaces/SPACE_NUMBER/resources/SPACE_RESOURCE_ID \ -d '{"metadata":{"name":"updated-notes.txt","text":"Updated content"}}'

Response

Status: 200
{ "id": 1, "resource_type": "free_text", "copilot_chat_attachment_id": null, "metadata": { "name": "updated-notes.txt", "text": "Updated content" }, "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T12:00:00Z" }

Delete a resource from a Copilot Space for a user

Deletes a resource from a specific Copilot Space owned by a user. The authenticated user must have write permissions on the space.

OAuth app tokens and personal access tokens (classic) need the write:user scope to use this endpoint.

"Delete a resource from a Copilot Space for a user" のきめ細かいアクセス トークン

このエンドポイントは、GitHubアプリ ユーザー アクセス トークン、GitHub アプリ インストール アクセス トークン、またはきめ細かい個人用アクセス トークンでは機能しません。

"Delete a resource from a Copilot Space for a user" のパラメーター

ヘッダー
名前, タイプ, 説明
accept string

Setting to application/vnd.github+json is recommended.

パスパラメーター
名前, タイプ, 説明
username string 必須

The handle for the GitHub user account.

space_number integer 必須

The unique identifier of the Copilot Space.

space_resource_id integer 必須

The unique identifier of the resource.

"Delete a resource from a Copilot Space for a user" の HTTP 応答状態コード

状態コード説明
204

No Content

403

Forbidden

404

Resource not found

"Delete a resource from a Copilot Space for a user" のコード サンプル

要求の例

delete/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/users/USERNAME/copilot-spaces/SPACE_NUMBER/resources/SPACE_RESOURCE_ID

Response

Status: 204