POST /users/{username}/copilot-spaces
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.
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
username |
String | Yes |
The handle for the GitHub user account. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
The name of the Copilot Space. |
base_role |
String | No |
The base role that determines default permissions for the space.
Valid values:
Default value: "no_access" |
description |
String | No |
A description of the Copilot Space. |
general_instructions |
String | No |
General instructions for the Copilot Space. |
resources_attributes[] |
Array | No |
Resources to attach to the space. |
resources_attributes[].resource_type |
String | No |
The type of resource. Valid values:
|
resources_attributes[].metadata |
Object | No |
Metadata specific to the resource type. |
resources_attributes[].metadata.name |
String | No |
Name for the resource. |
resources_attributes[].metadata.file_path |
String | No |
File path for file resources. |
resources_attributes[].metadata.text |
String | No |
Text content for free text resources. |
resources_attributes[].metadata.number |
Integer | No |
Issue or PR number. |
resources_attributes[].metadata.repository_id |
Integer | No |
Repository ID for repository or file resources. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.