Skip to main content
Die REST-API ist jetzt versioniert. Weitere Informationen findest du unter Informationen zur API-Versionsverwaltung.

REST API endpoints for Copilot Spaces

Use the REST API to manage Copilot Spaces and related resources.

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.

Feinkörnige Zugriffstoken für "List organization Copilot Spaces"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Copilot Spaces" organization permissions (read)

Parameter für "List organization Copilot Spaces"

Header
Name, Typ, BESCHREIBUNG
accept string

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

Pfadparameter
Name, Typ, BESCHREIBUNG
org string Erforderlich

The organization name. The name is not case sensitive.

Abfrageparameter
Name, Typ, BESCHREIBUNG
per_page integer

The number of results per page (max 100).

Standard: 30

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-Antwortstatuscodes für "List organization Copilot Spaces"

StatuscodeBESCHREIBUNG
200

OK

403

Forbidden

404

Resource not found

Codebeispiele für "List organization Copilot Spaces"

Anforderungsbeispiel

get/orgs/{org}/copilot-spaces
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

Example 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.

Feinkörnige Zugriffstoken für "Create an organization Copilot Space"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Copilot Spaces" organization permissions (write)

Parameter für "Create an organization Copilot Space"

Header
Name, Typ, BESCHREIBUNG
accept string

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

Pfadparameter
Name, Typ, BESCHREIBUNG
org string Erforderlich

The organization name. The name is not case sensitive.

Körperparameter
Name, Typ, BESCHREIBUNG
name string Erforderlich

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.

  • no_access: No default access (default)
  • reader: Organization members can read the space
  • writer: Organization members can read and edit the space
  • admin: Organization members have full admin access to the space

Standard: no_access

Kann eine der folgenden sein: reader, writer, admin, no_access

resources_attributes array of objects

Resources to attach to the space.

Name, Typ, BESCHREIBUNG
resource_type string

The type of resource.

Kann eine der folgenden sein: repository, github_file, free_text, github_issue, github_pull_request, media_content, uploaded_text_file

metadata object

Metadata specific to the resource type.

Name, Typ, BESCHREIBUNG
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-Antwortstatuscodes für "Create an organization Copilot Space"

StatuscodeBESCHREIBUNG
201

Created

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für "Create an organization Copilot Space"

Anforderungsbeispiel

post/orgs/{org}/copilot-spaces
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.

Feinkörnige Zugriffstoken für "Get an organization Copilot Space"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Copilot Spaces" organization permissions (read)

Parameter für "Get an organization Copilot Space"

Header
Name, Typ, BESCHREIBUNG
accept string

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

Pfadparameter
Name, Typ, BESCHREIBUNG
org string Erforderlich

The organization name. The name is not case sensitive.

space_number integer Erforderlich

The unique identifier of the Copilot Space.

HTTP-Antwortstatuscodes für "Get an organization Copilot Space"

StatuscodeBESCHREIBUNG
200

OK

403

Forbidden

404

Resource not found

Codebeispiele für "Get an organization Copilot Space"

Anforderungsbeispiel

get/orgs/{org}/copilot-spaces/{space_number}
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

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

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.

Feinkörnige Zugriffstoken für "Set an organization Copilot Space"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Copilot Spaces" organization permissions (write)

Parameter für "Set an organization Copilot Space"

Header
Name, Typ, BESCHREIBUNG
accept string

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

Pfadparameter
Name, Typ, BESCHREIBUNG
org string Erforderlich

The organization name. The name is not case sensitive.

space_number integer Erforderlich

The unique identifier of the Copilot Space.

Körperparameter
Name, Typ, BESCHREIBUNG
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.

  • no_access: No default access (default)
  • reader: Organization members can read the space
  • writer: Organization members can read and edit the space
  • admin: Organization members have full admin access to the space

Kann eine der folgenden sein: reader, writer, admin, no_access

resources_attributes array of objects

Resources to attach to the space.

Name, Typ, BESCHREIBUNG
resource_type string

The type of resource.

Kann eine der folgenden sein: repository, github_file, free_text, github_issue, github_pull_request, media_content, uploaded_text_file

metadata object

Metadata specific to the resource type.

Name, Typ, BESCHREIBUNG
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-Antwortstatuscodes für "Set an organization Copilot Space"

StatuscodeBESCHREIBUNG
200

OK

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für "Set an organization Copilot Space"

Anforderungsbeispiel

put/orgs/{org}/copilot-spaces/{space_number}
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.

Feinkörnige Zugriffstoken für "Delete an organization Copilot Space"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Copilot Spaces" organization permissions (write)

Parameter für "Delete an organization Copilot Space"

Header
Name, Typ, BESCHREIBUNG
accept string

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

Pfadparameter
Name, Typ, BESCHREIBUNG
org string Erforderlich

The organization name. The name is not case sensitive.

space_number integer Erforderlich

The unique identifier of the Copilot Space.

HTTP-Antwortstatuscodes für "Delete an organization Copilot Space"

StatuscodeBESCHREIBUNG
204

The Copilot Space has been successfully deleted.

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für "Delete an organization Copilot Space"

Anforderungsbeispiel

delete/orgs/{org}/copilot-spaces/{space_number}
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

The Copilot Space has been successfully deleted.

Status: 204

List 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.

Feinkörnige Zugriffstoken für "List Copilot Spaces for a user"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

Parameter für "List Copilot Spaces for a user"

Header
Name, Typ, BESCHREIBUNG
accept string

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

Pfadparameter
Name, Typ, BESCHREIBUNG
username string Erforderlich

The handle for the GitHub user account.

Abfrageparameter
Name, Typ, BESCHREIBUNG
per_page integer

The number of results per page (max 100).

Standard: 30

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-Antwortstatuscodes für "List Copilot Spaces for a user"

StatuscodeBESCHREIBUNG
200

OK

403

Forbidden

404

Resource not found

Codebeispiele für "List Copilot Spaces for a user"

Anforderungsbeispiel

get/users/{username}/copilot-spaces
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

Example 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.

Feinkörnige Zugriffstoken für "Create a Copilot Space for a user"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

Parameter für "Create a Copilot Space for a user"

Header
Name, Typ, BESCHREIBUNG
accept string

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

Pfadparameter
Name, Typ, BESCHREIBUNG
username string Erforderlich

The handle for the GitHub user account.

Körperparameter
Name, Typ, BESCHREIBUNG
name string Erforderlich

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.

  • no_access: No default access (default)
  • reader: Makes the space publicly readable Note: User spaces do not support writer or admin base roles.

Standard: no_access

Kann eine der folgenden sein: reader, no_access

resources_attributes array of objects

Resources to attach to the space.

Name, Typ, BESCHREIBUNG
resource_type string

The type of resource.

Kann eine der folgenden sein: repository, github_file, free_text, github_issue, github_pull_request, media_content, uploaded_text_file

metadata object

Metadata specific to the resource type.

Name, Typ, BESCHREIBUNG
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-Antwortstatuscodes für "Create a Copilot Space for a user"

StatuscodeBESCHREIBUNG
201

Created

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für "Create a Copilot Space for a user"

Anforderungsbeispiel

post/users/{username}/copilot-spaces
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.

Feinkörnige Zugriffstoken für "Get a Copilot Space for a user"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

Parameter für "Get a Copilot Space for a user"

Header
Name, Typ, BESCHREIBUNG
accept string

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

Pfadparameter
Name, Typ, BESCHREIBUNG
username string Erforderlich

The handle for the GitHub user account.

space_number integer Erforderlich

The unique identifier of the Copilot Space.

HTTP-Antwortstatuscodes für "Get a Copilot Space for a user"

StatuscodeBESCHREIBUNG
200

OK

403

Forbidden

404

Resource not found

Codebeispiele für "Get a Copilot Space for a user"

Anforderungsbeispiel

get/users/{username}/copilot-spaces/{space_number}
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

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

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.

Feinkörnige Zugriffstoken für "Set a Copilot Space for a user"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

Parameter für "Set a Copilot Space for a user"

Header
Name, Typ, BESCHREIBUNG
accept string

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

Pfadparameter
Name, Typ, BESCHREIBUNG
username string Erforderlich

The handle for the GitHub user account.

space_number integer Erforderlich

The unique identifier of the Copilot Space.

Körperparameter
Name, Typ, BESCHREIBUNG
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.

  • no_access: No default access (default)
  • reader: Makes the space publicly readable Note: User spaces do not support writer or admin base roles.

Kann eine der folgenden sein: reader, no_access

resources_attributes array of objects

Resources to attach to the space.

Name, Typ, BESCHREIBUNG
resource_type string

The type of resource.

Kann eine der folgenden sein: repository, github_file, free_text, github_issue, github_pull_request, media_content, uploaded_text_file

metadata object

Metadata specific to the resource type.

Name, Typ, BESCHREIBUNG
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-Antwortstatuscodes für "Set a Copilot Space for a user"

StatuscodeBESCHREIBUNG
200

OK

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für "Set a Copilot Space for a user"

Anforderungsbeispiel

put/users/{username}/copilot-spaces/{space_number}
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.

Feinkörnige Zugriffstoken für "Delete a Copilot Space for a user"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

Parameter für "Delete a Copilot Space for a user"

Header
Name, Typ, BESCHREIBUNG
accept string

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

Pfadparameter
Name, Typ, BESCHREIBUNG
username string Erforderlich

The handle for the GitHub user account.

space_number integer Erforderlich

The unique identifier of the Copilot Space.

HTTP-Antwortstatuscodes für "Delete a Copilot Space for a user"

StatuscodeBESCHREIBUNG
204

The Copilot Space has been successfully deleted.

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für "Delete a Copilot Space for a user"

Anforderungsbeispiel

delete/users/{username}/copilot-spaces/{space_number}
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

The Copilot Space has been successfully deleted.

Status: 204