Skip to main content
Ahora la API REST está versionada. Para obtener más información, consulta "Acerca del control de versiones de la API".

REST API endpoints for Copilot Spaces

Use the REST API to interact with Copilot Spaces resources.

List resources for an organization Copilot Space

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

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

Tokens de acceso granulares para "List resources for an organization Copilot Space"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Copilot Spaces" organization permissions (read)

Parámetros para "List resources for an organization Copilot Space"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de ruta
Nombre, Tipo, Descripción
org string Obligatorio

The organization name. The name is not case sensitive.

space_number integer Obligatorio

The unique identifier of the Copilot Space.

Códigos de estado de respuesta HTTP para "List resources for an organization Copilot Space"

código de estadoDescripción
200

OK

403

Forbidden

404

Resource not found

Ejemplos de código para "List resources for an organization Copilot Space"

Si accede a GitHub en GHE.com, reemplace api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

Response

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

Create a resource for an organization Copilot Space

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

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

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

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

Tokens de acceso granulares para "Create a resource for an organization Copilot Space"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Copilot Spaces" organization permissions (write)

Parámetros para "Create a resource for an organization Copilot Space"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de ruta
Nombre, Tipo, Descripción
org string Obligatorio

The organization name. The name is not case sensitive.

space_number integer Obligatorio

The unique identifier of the Copilot Space.

Parámetros del cuerpo
Nombre, Tipo, Descripción
resource_type string Obligatorio

The type of resource to create.

Puede ser uno de los siguientes: repository, github_file, free_text, github_issue, github_pull_request

metadata object Obligatorio

Resource-specific metadata.

Códigos de estado de respuesta HTTP para "Create a resource for an organization Copilot Space"

código de estadoDescripción
200

Duplicate github_file resource already exists

201

Resource created

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Get a resource for an organization Copilot Space

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

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

Tokens de acceso granulares para "Get a resource for an organization Copilot Space"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Copilot Spaces" organization permissions (read)

Parámetros para "Get a resource for an organization Copilot Space"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de ruta
Nombre, Tipo, Descripción
org string Obligatorio

The organization name. The name is not case sensitive.

space_number integer Obligatorio

The unique identifier of the Copilot Space.

space_resource_id integer Obligatorio

The unique identifier of the resource.

Códigos de estado de respuesta HTTP para "Get a resource for an organization Copilot Space"

código de estadoDescripción
200

OK

403

Forbidden

404

Resource not found

Ejemplos de código para "Get a resource for an organization Copilot Space"

Si accede a GitHub en GHE.com, reemplace api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

Response

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

Set a resource for an organization Copilot Space

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

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

Tokens de acceso granulares para "Set a resource for an organization Copilot Space"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Copilot Spaces" organization permissions (write)

Parámetros para "Set a resource for an organization Copilot Space"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de ruta
Nombre, Tipo, Descripción
org string Obligatorio

The organization name. The name is not case sensitive.

space_number integer Obligatorio

The unique identifier of the Copilot Space.

space_resource_id integer Obligatorio

The unique identifier of the resource.

Parámetros del cuerpo
Nombre, Tipo, Descripción
metadata object

Updated resource-specific metadata.

Códigos de estado de respuesta HTTP para "Set a resource for an organization Copilot Space"

código de estadoDescripción
200

OK

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Ejemplos de código para "Set a resource for an organization Copilot Space"

Si accede a GitHub en GHE.com, reemplace api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

Response

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

Delete a resource from an organization Copilot Space

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

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

Tokens de acceso granulares para "Delete a resource from an organization Copilot Space"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Copilot Spaces" organization permissions (write)

Parámetros para "Delete a resource from an organization Copilot Space"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de ruta
Nombre, Tipo, Descripción
org string Obligatorio

The organization name. The name is not case sensitive.

space_number integer Obligatorio

The unique identifier of the Copilot Space.

space_resource_id integer Obligatorio

The unique identifier of the resource.

Códigos de estado de respuesta HTTP para "Delete a resource from an organization Copilot Space"

código de estadoDescripción
204

No Content

403

Forbidden

404

Resource not found

Ejemplos de código para "Delete a resource from an organization Copilot Space"

Si accede a GitHub en GHE.com, reemplace api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

Response

Status: 204

List resources for a Copilot Space for a user

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

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

Tokens de acceso granulares para "List resources for a Copilot Space for a user"

Este punto de conexión no funciona con tokens de acceso de usuario de la aplicación de GitHub, tokens de acceso de instalación de la aplicación de GitHub, o tokens de acceso personal de grano fino.

Parámetros para "List resources for a Copilot Space for a user"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de ruta
Nombre, Tipo, Descripción
username string Obligatorio

The handle for the GitHub user account.

space_number integer Obligatorio

The unique identifier of the Copilot Space.

Códigos de estado de respuesta HTTP para "List resources for a Copilot Space for a user"

código de estadoDescripción
200

OK

403

Forbidden

404

Resource not found

Ejemplos de código para "List resources for a Copilot Space for a user"

Si accede a GitHub en GHE.com, reemplace api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

Response

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

Create a resource for a Copilot Space for a user

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

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

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

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

Tokens de acceso granulares para "Create a resource for a Copilot Space for a user"

Este punto de conexión no funciona con tokens de acceso de usuario de la aplicación de GitHub, tokens de acceso de instalación de la aplicación de GitHub, o tokens de acceso personal de grano fino.

Parámetros para "Create a resource for a Copilot Space for a user"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de ruta
Nombre, Tipo, Descripción
username string Obligatorio

The handle for the GitHub user account.

space_number integer Obligatorio

The unique identifier of the Copilot Space.

Parámetros del cuerpo
Nombre, Tipo, Descripción
resource_type string Obligatorio

The type of resource to create.

Puede ser uno de los siguientes: repository, github_file, free_text, github_issue, github_pull_request

metadata object Obligatorio

Resource-specific metadata.

Códigos de estado de respuesta HTTP para "Create a resource for a Copilot Space for a user"

código de estadoDescripción
200

Duplicate github_file resource already exists

201

Resource created

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Get a resource for a Copilot Space for a user

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

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

Tokens de acceso granulares para "Get a resource for a Copilot Space for a user"

Este punto de conexión no funciona con tokens de acceso de usuario de la aplicación de GitHub, tokens de acceso de instalación de la aplicación de GitHub, o tokens de acceso personal de grano fino.

Parámetros para "Get a resource for a Copilot Space for a user"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de ruta
Nombre, Tipo, Descripción
username string Obligatorio

The handle for the GitHub user account.

space_number integer Obligatorio

The unique identifier of the Copilot Space.

space_resource_id integer Obligatorio

The unique identifier of the resource.

Códigos de estado de respuesta HTTP para "Get a resource for a Copilot Space for a user"

código de estadoDescripción
200

OK

403

Forbidden

404

Resource not found

Ejemplos de código para "Get a resource for a Copilot Space for a user"

Si accede a GitHub en GHE.com, reemplace api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

Response

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

Set a resource for a Copilot Space for a user

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

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

Tokens de acceso granulares para "Set a resource for a Copilot Space for a user"

Este punto de conexión no funciona con tokens de acceso de usuario de la aplicación de GitHub, tokens de acceso de instalación de la aplicación de GitHub, o tokens de acceso personal de grano fino.

Parámetros para "Set a resource for a Copilot Space for a user"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de ruta
Nombre, Tipo, Descripción
username string Obligatorio

The handle for the GitHub user account.

space_number integer Obligatorio

The unique identifier of the Copilot Space.

space_resource_id integer Obligatorio

The unique identifier of the resource.

Parámetros del cuerpo
Nombre, Tipo, Descripción
metadata object

Updated resource-specific metadata.

Códigos de estado de respuesta HTTP para "Set a resource for a Copilot Space for a user"

código de estadoDescripción
200

OK

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Ejemplos de código para "Set a resource for a Copilot Space for a user"

Si accede a GitHub en GHE.com, reemplace api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

Response

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

Delete a resource from a Copilot Space for a user

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

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

Tokens de acceso granulares para "Delete a resource from a Copilot Space for a user"

Este punto de conexión no funciona con tokens de acceso de usuario de la aplicación de GitHub, tokens de acceso de instalación de la aplicación de GitHub, o tokens de acceso personal de grano fino.

Parámetros para "Delete a resource from a Copilot Space for a user"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de ruta
Nombre, Tipo, Descripción
username string Obligatorio

The handle for the GitHub user account.

space_number integer Obligatorio

The unique identifier of the Copilot Space.

space_resource_id integer Obligatorio

The unique identifier of the resource.

Códigos de estado de respuesta HTTP para "Delete a resource from a Copilot Space for a user"

código de estadoDescripción
204

No Content

403

Forbidden

404

Resource not found

Ejemplos de código para "Delete a resource from a Copilot Space for a user"

Si accede a GitHub en GHE.com, reemplace api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

Response

Status: 204