Конечные точки REST API для Copilot Spaces
Используйте REST API для управления пространствами Copilot и сопутствующими ресурсами.
List organization Copilot Spaces
Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.
Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.
OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in a space; spaces with inaccessible resources are omitted from the response.
Детализированные токены доступа для «List organization Copilot Spaces»
Эта конечная точка работает со следующими точными типами маркеров:
- Жетоны доступа пользователей приложения GitHub
- Токены доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Copilot Spaces" organization permissions (read)
Параметры для «List organization Copilot Spaces»
| Имя., Тип, Description |
|---|
accept string Setting to |
| Имя., Тип, Description |
|---|
org string Обязательное полеThe organization name. The name is not case sensitive. |
| Имя., Тип, Description |
|---|
per_page integer The number of results per page (max 100). По умолчанию.: |
before string A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. |
after string A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. |
HTTP-коды статуса ответа для «List organization Copilot Spaces»
| Код состояния | Description |
|---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Примеры кода для «List organization Copilot Spaces»
Если вы получаете доступ к GitHub на GHE.com, замените api.github.com на выделенный поддомен вашего предприятия в api.SUBDOMAIN.ghe.com.
Пример запроса
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-spacesExample response for listing organization copilot spaces
Status: 200{
"spaces": [
{
"id": 84,
"number": 3,
"name": "Team Planning Space",
"description": "Organization space for team planning and coordination",
"owner": {
"login": "octo-org",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/octo-org",
"repos_url": "https://api.github.com/orgs/octo-org/repos",
"events_url": "https://api.github.com/orgs/octo-org/events",
"hooks_url": "https://api.github.com/orgs/octo-org/hooks",
"issues_url": "https://api.github.com/orgs/octo-org/issues",
"members_url": "https://api.github.com/orgs/octo-org/members{/member}",
"public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization",
"gravatar_id": "",
"name": "octo-org",
"company": "GitHub",
"blog": "https://github.com/blog",
"location": "San Francisco",
"email": "octocat@github.com",
"twitter_username": "octo-org",
"html_url": "https://github.com/octo-org",
"created_at": "2008-01-14T04:33:35Z",
"updated_at": "2017-08-17T12:37:15Z",
"type": "Organization"
},
"creator": {
"login": "defunkt",
"id": 2,
"node_id": "MDQ6VXNlcjI=",
"avatar_url": "https://github.com/images/error/defunkt_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/defunkt",
"html_url": "https://github.com/defunkt",
"followers_url": "https://api.github.com/users/defunkt/followers",
"following_url": "https://api.github.com/users/defunkt/following{/other_user}",
"gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}",
"starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/defunkt/subscriptions",
"organizations_url": "https://api.github.com/users/defunkt/orgs",
"repos_url": "https://api.github.com/users/defunkt/repos",
"events_url": "https://api.github.com/users/defunkt/events{/privacy}",
"received_events_url": "https://api.github.com/users/defunkt/received_events",
"type": "User",
"site_admin": true
},
"created_at": "2023-02-15T08:30:00Z",
"updated_at": "2023-02-15T14:45:00Z",
"html_url": "https://github.com/copilot/spaces/octo-org/3",
"api_url": "https://api.github.com/organizations/1/copilot-spaces/3"
},
{
"id": 85,
"number": 4,
"name": "Development Resources",
"description": "Shared development documentation and resources",
"owner": {
"login": "octo-org",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/octo-org",
"repos_url": "https://api.github.com/orgs/octo-org/repos",
"events_url": "https://api.github.com/orgs/octo-org/events",
"hooks_url": "https://api.github.com/orgs/octo-org/hooks",
"issues_url": "https://api.github.com/orgs/octo-org/issues",
"members_url": "https://api.github.com/orgs/octo-org/members{/member}",
"public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization",
"gravatar_id": "",
"name": "octo-org",
"company": "GitHub",
"blog": "https://github.com/blog",
"location": "San Francisco",
"email": "octocat@github.com",
"twitter_username": "octo-org",
"html_url": "https://github.com/octo-org",
"created_at": "2008-01-14T04:33:35Z",
"updated_at": "2017-08-17T12:37:15Z",
"type": "Organization"
},
"creator": {
"login": "octocat",
"id": 3,
"node_id": "MDQ6VXNlcjM=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"created_at": "2023-02-16T10:15:00Z",
"updated_at": "2023-02-16T16:30:00Z",
"html_url": "https://github.com/copilot/spaces/octo-org/4",
"api_url": "https://api.github.com/organizations/1/copilot-spaces/4"
}
]
}Create an organization Copilot Space
Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.
Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization.
OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by the submitted resources.
Детализированные токены доступа для «Create an organization Copilot Space»
Эта конечная точка работает со следующими точными типами маркеров:
- Жетоны доступа пользователей приложения GitHub
- Токены доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Copilot Spaces" organization permissions (write)
Параметры для «Create an organization Copilot Space»
| Имя., Тип, Description |
|---|
accept string Setting to |
| Имя., Тип, Description |
|---|
org string Обязательное полеThe organization name. The name is not case sensitive. |
| Имя., Тип, Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
name string Обязательное полеThe name of the Copilot Space. | ||||||||||
description string A description of the Copilot Space. | ||||||||||
general_instructions string General instructions for the Copilot Space. | ||||||||||
base_role string The base role that determines default permissions for organization members.
По умолчанию.: Возможные значения: | ||||||||||
resources_attributes array of objects Resources to attach to the space. | ||||||||||
Properties of |
| Имя., Тип, Description | ||||||
|---|---|---|---|---|---|---|
resource_type string The type of resource. Возможные значения: | ||||||
metadata object Metadata specific to the resource type. | ||||||
Properties of |
| Имя., Тип, Description |
|---|
repository_id integer Repository ID for repository or file resources. |
file_path string File path for file resources. |
text string Text content for free text resources. |
name string Name for the resource. |
number integer Issue or PR number. |
HTTP-коды статуса ответа для «Create an organization Copilot Space»
| Код состояния | Description |
|---|---|
201 | Created |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Примеры кода для «Create an organization Copilot Space»
Если вы получаете доступ к GitHub на GHE.com, замените api.github.com на выделенный поддомен вашего предприятия в api.SUBDOMAIN.ghe.com.
Пример запроса
curl -L \
-X POST \
-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 \
-d '{"name":"Team Planning Space","description":"Organization space for team planning and coordination","general_instructions":"Help the team with planning and coordination tasks","resources_attributes":[{"resource_type":"github_file","metadata":{"repository_id":123456,"file_path":"docs/planning.md"}},{"resource_type":"free_text","metadata":{"name":"Team Guidelines","text":"Our team follows agile methodology and holds daily standups"}}]}'Example response for an organization copilot space
Status: 201{
"id": 84,
"number": 3,
"name": "Team Planning Space",
"description": "Organization space for team planning and coordination",
"general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices",
"owner": {
"login": "octo-org",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/octo-org",
"repos_url": "https://api.github.com/orgs/octo-org/repos",
"events_url": "https://api.github.com/orgs/octo-org/events",
"hooks_url": "https://api.github.com/orgs/octo-org/hooks",
"issues_url": "https://api.github.com/orgs/octo-org/issues",
"members_url": "https://api.github.com/orgs/octo-org/members{/member}",
"public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization",
"gravatar_id": "",
"name": "octo-org",
"company": "GitHub",
"blog": "https://github.com/blog",
"location": "San Francisco",
"email": "octocat@github.com",
"twitter_username": "octo-org",
"html_url": "https://github.com/octo-org",
"created_at": "2008-01-14T04:33:35Z",
"updated_at": "2017-08-17T12:37:15Z",
"type": "Organization"
},
"creator": {
"login": "defunkt",
"id": 2,
"node_id": "MDQ6VXNlcjI=",
"avatar_url": "https://github.com/images/error/defunkt_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/defunkt",
"html_url": "https://github.com/defunkt",
"followers_url": "https://api.github.com/users/defunkt/followers",
"following_url": "https://api.github.com/users/defunkt/following{/other_user}",
"gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}",
"starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/defunkt/subscriptions",
"organizations_url": "https://api.github.com/users/defunkt/orgs",
"repos_url": "https://api.github.com/users/defunkt/repos",
"events_url": "https://api.github.com/users/defunkt/events{/privacy}",
"received_events_url": "https://api.github.com/users/defunkt/received_events",
"type": "User",
"site_admin": true
},
"created_at": "2023-02-15T08:30:00Z",
"updated_at": "2023-02-15T14:45:00Z",
"html_url": "https://github.com/copilot/spaces/octo-org/3",
"api_url": "https://api.github.com/organizations/1/copilot-spaces/3",
"base_role": "no_access",
"resources_attributes": [
{
"id": 123,
"resource_type": "github_file",
"metadata": {
"repository_id": 456,
"file_path": "docs/planning.md"
}
},
{
"id": 124,
"resource_type": "free_text",
"metadata": {
"name": "Team Guidelines",
"text": "Our team follows agile methodology"
}
}
]
}Get an organization Copilot Space
Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.
Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.
OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.
Детализированные токены доступа для «Get an organization Copilot Space»
Эта конечная точка работает со следующими точными типами маркеров:
- Жетоны доступа пользователей приложения GitHub
- Токены доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Copilot Spaces" organization permissions (read)
Параметры для «Get an organization Copilot Space»
| Имя., Тип, Description |
|---|
accept string Setting to |
| Имя., Тип, Description |
|---|
org string Обязательное полеThe organization name. The name is not case sensitive. |
space_number integer Обязательное полеThe unique identifier of the Copilot Space. |
HTTP-коды статуса ответа для «Get an organization Copilot Space»
| Код состояния | Description |
|---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Примеры кода для «Get an organization Copilot Space»
Если вы получаете доступ к GitHub на GHE.com, замените api.github.com на выделенный поддомен вашего предприятия в api.SUBDOMAIN.ghe.com.
Пример запроса
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_NUMBERExample response for an organization copilot space
Status: 200{
"id": 84,
"number": 3,
"name": "Team Planning Space",
"description": "Organization space for team planning and coordination",
"general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices",
"owner": {
"login": "octo-org",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/octo-org",
"repos_url": "https://api.github.com/orgs/octo-org/repos",
"events_url": "https://api.github.com/orgs/octo-org/events",
"hooks_url": "https://api.github.com/orgs/octo-org/hooks",
"issues_url": "https://api.github.com/orgs/octo-org/issues",
"members_url": "https://api.github.com/orgs/octo-org/members{/member}",
"public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization",
"gravatar_id": "",
"name": "octo-org",
"company": "GitHub",
"blog": "https://github.com/blog",
"location": "San Francisco",
"email": "octocat@github.com",
"twitter_username": "octo-org",
"html_url": "https://github.com/octo-org",
"created_at": "2008-01-14T04:33:35Z",
"updated_at": "2017-08-17T12:37:15Z",
"type": "Organization"
},
"creator": {
"login": "defunkt",
"id": 2,
"node_id": "MDQ6VXNlcjI=",
"avatar_url": "https://github.com/images/error/defunkt_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/defunkt",
"html_url": "https://github.com/defunkt",
"followers_url": "https://api.github.com/users/defunkt/followers",
"following_url": "https://api.github.com/users/defunkt/following{/other_user}",
"gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}",
"starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/defunkt/subscriptions",
"organizations_url": "https://api.github.com/users/defunkt/orgs",
"repos_url": "https://api.github.com/users/defunkt/repos",
"events_url": "https://api.github.com/users/defunkt/events{/privacy}",
"received_events_url": "https://api.github.com/users/defunkt/received_events",
"type": "User",
"site_admin": true
},
"created_at": "2023-02-15T08:30:00Z",
"updated_at": "2023-02-15T14:45:00Z",
"html_url": "https://github.com/copilot/spaces/octo-org/3",
"api_url": "https://api.github.com/organizations/1/copilot-spaces/3",
"base_role": "no_access",
"resources_attributes": [
{
"id": 123,
"resource_type": "github_file",
"metadata": {
"repository_id": 456,
"file_path": "docs/planning.md"
}
},
{
"id": 124,
"resource_type": "free_text",
"metadata": {
"name": "Team Guidelines",
"text": "Our team follows agile methodology"
}
}
]
}Set an organization Copilot Space
Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.
Organization members with appropriate permissions can update Copilot Spaces owned by their organization.
OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including any being added or updated.
Детализированные токены доступа для «Set an organization Copilot Space»
Эта конечная точка работает со следующими точными типами маркеров:
- Жетоны доступа пользователей приложения GitHub
- Токены доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Copilot Spaces" organization permissions (write)
Параметры для «Set an organization Copilot Space»
| Имя., Тип, Description |
|---|
accept string Setting to |
| Имя., Тип, Description |
|---|
org string Обязательное полеThe organization name. The name is not case sensitive. |
space_number integer Обязательное полеThe unique identifier of the Copilot Space. |
| Имя., Тип, Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
name string The name of the Copilot Space. | ||||||||||
description string A description of the Copilot Space. | ||||||||||
general_instructions string General instructions for the Copilot Space. | ||||||||||
base_role string The base role that determines default permissions for organization members. Changing this field requires admin permissions.
Возможные значения: | ||||||||||
resources_attributes array of objects Resources to attach to the space. | ||||||||||
Properties of |
| Имя., Тип, Description | ||||||
|---|---|---|---|---|---|---|
resource_type string The type of resource. Возможные значения: | ||||||
metadata object Metadata specific to the resource type. | ||||||
Properties of |
| Имя., Тип, Description |
|---|
repository_id integer Repository ID for repository or file resources. |
file_path string File path for file resources. |
text string Text content for free text resources. |
name string Name for the resource. |
number integer Issue or PR number. |
HTTP-коды статуса ответа для «Set an organization Copilot Space»
| Код состояния | Description |
|---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Примеры кода для «Set an organization Copilot Space»
Если вы получаете доступ к GitHub на GHE.com, замените api.github.com на выделенный поддомен вашего предприятия в api.SUBDOMAIN.ghe.com.
Пример запроса
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 \
-d '{"name":"Updated Team Planning Space","description":"Updated organization space for team planning and coordination","general_instructions":"Updated instructions to help the team with planning and coordination tasks","resources_attributes":[{"resource_type":"github_file","metadata":{"repository_id":123456,"file_path":"docs/updated-planning.md"}},{"id":789,"_destroy":true},{"id":456,"resource_type":"free_text","metadata":{"name":"Updated Team Guidelines","text":"Our updated team follows agile methodology and holds daily standups"}}]}'Example response for an organization copilot space
Status: 200{
"id": 84,
"number": 3,
"name": "Team Planning Space",
"description": "Organization space for team planning and coordination",
"general_instructions": "Help the team with agile planning, sprint coordination, and project management best practices",
"owner": {
"login": "octo-org",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/octo-org",
"repos_url": "https://api.github.com/orgs/octo-org/repos",
"events_url": "https://api.github.com/orgs/octo-org/events",
"hooks_url": "https://api.github.com/orgs/octo-org/hooks",
"issues_url": "https://api.github.com/orgs/octo-org/issues",
"members_url": "https://api.github.com/orgs/octo-org/members{/member}",
"public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization",
"gravatar_id": "",
"name": "octo-org",
"company": "GitHub",
"blog": "https://github.com/blog",
"location": "San Francisco",
"email": "octocat@github.com",
"twitter_username": "octo-org",
"html_url": "https://github.com/octo-org",
"created_at": "2008-01-14T04:33:35Z",
"updated_at": "2017-08-17T12:37:15Z",
"type": "Organization"
},
"creator": {
"login": "defunkt",
"id": 2,
"node_id": "MDQ6VXNlcjI=",
"avatar_url": "https://github.com/images/error/defunkt_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/defunkt",
"html_url": "https://github.com/defunkt",
"followers_url": "https://api.github.com/users/defunkt/followers",
"following_url": "https://api.github.com/users/defunkt/following{/other_user}",
"gists_url": "https://api.github.com/users/defunkt/gists{/gist_id}",
"starred_url": "https://api.github.com/users/defunkt/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/defunkt/subscriptions",
"organizations_url": "https://api.github.com/users/defunkt/orgs",
"repos_url": "https://api.github.com/users/defunkt/repos",
"events_url": "https://api.github.com/users/defunkt/events{/privacy}",
"received_events_url": "https://api.github.com/users/defunkt/received_events",
"type": "User",
"site_admin": true
},
"created_at": "2023-02-15T08:30:00Z",
"updated_at": "2023-02-15T14:45:00Z",
"html_url": "https://github.com/copilot/spaces/octo-org/3",
"api_url": "https://api.github.com/organizations/1/copilot-spaces/3",
"base_role": "no_access",
"resources_attributes": [
{
"id": 123,
"resource_type": "github_file",
"metadata": {
"repository_id": 456,
"file_path": "docs/planning.md"
}
},
{
"id": 124,
"resource_type": "free_text",
"metadata": {
"name": "Team Guidelines",
"text": "Our team follows agile methodology"
}
}
]
}Delete an organization Copilot Space
Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.
Warning: This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.
Organization members with appropriate permissions can delete Copilot Spaces owned by their organization.
OAuth app tokens and personal access tokens (classic) need both the read:org and repo scopes to use this endpoint.
Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.
Детализированные токены доступа для «Delete an organization Copilot Space»
Эта конечная точка работает со следующими точными типами маркеров:
- Жетоны доступа пользователей приложения GitHub
- Токены доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Copilot Spaces" organization permissions (write)
Параметры для «Delete an organization Copilot Space»
| Имя., Тип, Description |
|---|
accept string Setting to |
| Имя., Тип, Description |
|---|
org string Обязательное полеThe organization name. The name is not case sensitive. |
space_number integer Обязательное полеThe unique identifier of the Copilot Space. |
HTTP-коды статуса ответа для «Delete an organization Copilot Space»
| Код состояния | Description |
|---|---|
204 | The Copilot Space has been successfully deleted. |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Примеры кода для «Delete an organization Copilot Space»
Если вы получаете доступ к GitHub на GHE.com, замените api.github.com на выделенный поддомен вашего предприятия в api.SUBDOMAIN.ghe.com.
Пример запроса
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_NUMBERThe Copilot Space has been successfully deleted.
Status: 204List Copilot Spaces for a user
Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces.
Only Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces.
OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.
Детализированные токены доступа для «List Copilot Spaces for a user»
Эта конечная точка не работает с пользовательскими токенами доступа GitHub App, токенами доступа для установки GitHub App или детализированными персональными токенами доступа.
Параметры для «List Copilot Spaces for a user»
| Имя., Тип, Description |
|---|
accept string Setting to |
| Имя., Тип, Description |
|---|
username string Обязательное полеThe handle for the GitHub user account. |
| Имя., Тип, Description |
|---|
per_page integer The number of results per page (max 100). По умолчанию.: |
before string A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. |
after string A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. |
HTTP-коды статуса ответа для «List Copilot Spaces for a user»
| Код состояния | Description |
|---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Примеры кода для «List Copilot Spaces for a user»
Если вы получаете доступ к GitHub на GHE.com, замените api.github.com на выделенный поддомен вашего предприятия в api.SUBDOMAIN.ghe.com.
Пример запроса
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-spacesExample response for listing user copilot spaces
Status: 200{
"spaces": [
{
"id": 42,
"number": 1,
"name": "Personal Research Space",
"description": "My personal space for research and development",
"owner": {
"login": "octocat",
"id": 3,
"node_id": "MDQ6VXNlcjM=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"creator": {
"login": "octocat",
"id": 3,
"node_id": "MDQ6VXNlcjM=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"created_at": "2023-02-16T10:15:00Z",
"updated_at": "2023-02-16T16:30:00Z",
"html_url": "https://github.com/copilot/spaces/octocat/1",
"api_url": "https://api.github.com/user/1/copilot-spaces/1"
},
{
"id": 43,
"number": 2,
"name": "Learning Space",
"description": "Space for learning new technologies",
"owner": {
"login": "octocat",
"id": 3,
"node_id": "MDQ6VXNlcjM=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"creator": {
"login": "octocat",
"id": 3,
"node_id": "MDQ6VXNlcjM=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"created_at": "2023-02-17T08:20:00Z",
"updated_at": "2023-02-17T14:45:00Z",
"html_url": "https://github.com/copilot/spaces/octocat/2",
"api_url": "https://api.github.com/user/1/copilot-spaces/2"
}
]
}Create a Copilot Space for a user
Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account.
Users can create personal Copilot Spaces for their individual use.
OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.
Детализированные токены доступа для «Create a Copilot Space for a user»
Эта конечная точка не работает с пользовательскими токенами доступа GitHub App, токенами доступа для установки GitHub App или детализированными персональными токенами доступа.
Параметры для «Create a Copilot Space for a user»
| Имя., Тип, Description |
|---|
accept string Setting to |
| Имя., Тип, Description |
|---|
username string Обязательное полеThe handle for the GitHub user account. |
| Имя., Тип, Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
name string Обязательное полеThe name of the Copilot Space. | ||||||||||
description string A description of the Copilot Space. | ||||||||||
general_instructions string General instructions for the Copilot Space. | ||||||||||
base_role string The base role that determines default permissions for the space.
По умолчанию.: Возможные значения: | ||||||||||
resources_attributes array of objects Resources to attach to the space. | ||||||||||
Properties of |
| Имя., Тип, Description | ||||||
|---|---|---|---|---|---|---|
resource_type string The type of resource. Возможные значения: | ||||||
metadata object Metadata specific to the resource type. | ||||||
Properties of |
| Имя., Тип, Description |
|---|
repository_id integer Repository ID for repository or file resources. |
file_path string File path for file resources. |
text string Text content for free text resources. |
name string Name for the resource. |
number integer Issue or PR number. |
HTTP-коды статуса ответа для «Create a Copilot Space for a user»
| Код состояния | Description |
|---|---|
201 | Created |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Примеры кода для «Create a Copilot Space for a user»
Если вы получаете доступ к GitHub на GHE.com, замените api.github.com на выделенный поддомен вашего предприятия в api.SUBDOMAIN.ghe.com.
Пример запроса
curl -L \
-X POST \
-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 \
-d '{"name":"My Development Space","description":"Personal space for development assistance","general_instructions":"Help me with React development patterns and best practices","resources_attributes":[{"resource_type":"github_file","metadata":{"repository_id":789012,"file_path":"src/components/App.js"}},{"resource_type":"free_text","metadata":{"name":"Development Notes","text":"Focus on clean code principles and modern React patterns"}}]}'Example response for a user copilot space
Status: 201{
"id": 42,
"number": 5,
"name": "My Development Space",
"description": "Personal space for React development patterns",
"general_instructions": "Focus on React functional components, hooks, and modern development patterns",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"creator": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"created_at": "2023-02-15T08:30:00Z",
"updated_at": "2023-02-15T14:45:00Z",
"html_url": "https://github.com/copilot/spaces/octocat/5",
"api_url": "https://api.github.com/user/1/copilot-spaces/5",
"base_role": "no_access",
"resources_attributes": [
{
"id": 789,
"resource_type": "github_file",
"metadata": {
"repository_id": 1234,
"file_path": "src/components/App.tsx"
}
},
{
"id": 790,
"resource_type": "free_text",
"metadata": {
"name": "React Best Practices",
"text": "Use functional components with hooks"
}
}
]
}Get a Copilot Space for a user
Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space.
Private user spaces require the authenticated user to be the owner of the space. Public user spaces are accessible to any authenticated user.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Детализированные токены доступа для «Get a Copilot Space for a user»
Эта конечная точка не работает с пользовательскими токенами доступа GitHub App, токенами доступа для установки GitHub App или детализированными персональными токенами доступа.
Параметры для «Get a Copilot Space for a user»
| Имя., Тип, Description |
|---|
accept string Setting to |
| Имя., Тип, Description |
|---|
username string Обязательное полеThe handle for the GitHub user account. |
space_number integer Обязательное полеThe unique identifier of the Copilot Space. |
HTTP-коды статуса ответа для «Get a Copilot Space for a user»
| Код состояния | Description |
|---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Примеры кода для «Get a Copilot Space for a user»
Если вы получаете доступ к GitHub на GHE.com, замените api.github.com на выделенный поддомен вашего предприятия в api.SUBDOMAIN.ghe.com.
Пример запроса
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_NUMBERExample response for a user copilot space
Status: 200{
"id": 42,
"number": 5,
"name": "My Development Space",
"description": "Personal space for React development patterns",
"general_instructions": "Focus on React functional components, hooks, and modern development patterns",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"creator": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"created_at": "2023-02-15T08:30:00Z",
"updated_at": "2023-02-15T14:45:00Z",
"html_url": "https://github.com/copilot/spaces/octocat/5",
"api_url": "https://api.github.com/user/1/copilot-spaces/5",
"base_role": "no_access",
"resources_attributes": [
{
"id": 789,
"resource_type": "github_file",
"metadata": {
"repository_id": 1234,
"file_path": "src/components/App.tsx"
}
},
{
"id": 790,
"resource_type": "free_text",
"metadata": {
"name": "React Best Practices",
"text": "Use functional components with hooks"
}
}
]
}Set a Copilot Space for a user
Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account.
Users can update their personal Copilot Spaces.
OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.
Детализированные токены доступа для «Set a Copilot Space for a user»
Эта конечная точка не работает с пользовательскими токенами доступа GitHub App, токенами доступа для установки GitHub App или детализированными персональными токенами доступа.
Параметры для «Set a Copilot Space for a user»
| Имя., Тип, Description |
|---|
accept string Setting to |
| Имя., Тип, Description |
|---|
username string Обязательное полеThe handle for the GitHub user account. |
space_number integer Обязательное полеThe unique identifier of the Copilot Space. |
| Имя., Тип, Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
name string The name of the Copilot Space. | ||||||||||
description string A description of the Copilot Space. | ||||||||||
general_instructions string General instructions for the Copilot Space. | ||||||||||
base_role string The base role that determines default permissions for the space. Changing this field requires admin permissions.
Возможные значения: | ||||||||||
resources_attributes array of objects Resources to attach to the space. | ||||||||||
Properties of |
| Имя., Тип, Description | ||||||
|---|---|---|---|---|---|---|
resource_type string The type of resource. Возможные значения: | ||||||
metadata object Metadata specific to the resource type. | ||||||
Properties of |
| Имя., Тип, Description |
|---|
repository_id integer Repository ID for repository or file resources. |
file_path string File path for file resources. |
text string Text content for free text resources. |
name string Name for the resource. |
number integer Issue or PR number. |
HTTP-коды статуса ответа для «Set a Copilot Space for a user»
| Код состояния | Description |
|---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Примеры кода для «Set a Copilot Space for a user»
Если вы получаете доступ к GitHub на GHE.com, замените api.github.com на выделенный поддомен вашего предприятия в api.SUBDOMAIN.ghe.com.
Пример запроса
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 \
-d '{"name":"Updated Development Space","description":"Updated personal space for development assistance","general_instructions":"Updated instructions to help me with React development patterns and best practices","resources_attributes":[{"resource_type":"github_file","metadata":{"repository_id":789012,"file_path":"src/components/UpdatedApp.js"}},{"id":123,"_destroy":true},{"id":456,"resource_type":"free_text","metadata":{"name":"Updated Development Notes","text":"Updated focus on clean code principles and modern React patterns"}}]}'Example response for a user copilot space
Status: 200{
"id": 42,
"number": 5,
"name": "My Development Space",
"description": "Personal space for React development patterns",
"general_instructions": "Focus on React functional components, hooks, and modern development patterns",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"creator": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"created_at": "2023-02-15T08:30:00Z",
"updated_at": "2023-02-15T14:45:00Z",
"html_url": "https://github.com/copilot/spaces/octocat/5",
"api_url": "https://api.github.com/user/1/copilot-spaces/5",
"base_role": "no_access",
"resources_attributes": [
{
"id": 789,
"resource_type": "github_file",
"metadata": {
"repository_id": 1234,
"file_path": "src/components/App.tsx"
}
},
{
"id": 790,
"resource_type": "free_text",
"metadata": {
"name": "React Best Practices",
"text": "Use functional components with hooks"
}
}
]
}Delete a Copilot Space for a user
Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space.
Warning: This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations.
OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
Детализированные токены доступа для «Delete a Copilot Space for a user»
Эта конечная точка не работает с пользовательскими токенами доступа GitHub App, токенами доступа для установки GitHub App или детализированными персональными токенами доступа.
Параметры для «Delete a Copilot Space for a user»
| Имя., Тип, Description |
|---|
accept string Setting to |
| Имя., Тип, Description |
|---|
username string Обязательное полеThe handle for the GitHub user account. |
space_number integer Обязательное полеThe unique identifier of the Copilot Space. |
HTTP-коды статуса ответа для «Delete a Copilot Space for a user»
| Код состояния | Description |
|---|---|
204 | The Copilot Space has been successfully deleted. |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Примеры кода для «Delete a Copilot Space for a user»
Если вы получаете доступ к GitHub на GHE.com, замените api.github.com на выделенный поддомен вашего предприятия в api.SUBDOMAIN.ghe.com.
Пример запроса
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_NUMBERThe Copilot Space has been successfully deleted.
Status: 204