Get a Copilot Space for a user | Sample

2 parameters

usernamestringrequired

The handle for the GitHub user account.

space_numberintegerrequired

The unique identifier of the Copilot Space.

3 status codes

200Response

idintegerrequired

The unique identifier of the space.

numberintegerrequired

The number that identifies the space within its owner.

namestringrequired

The display name of the space.

descriptionstringoptional

A description of the space.

general_instructionsstringoptional

General instructions for the Copilot Space.

base_rolestringrequired

The base role that determines default permissions. - `no_access`: No default access - `reader`: Default read permissions - `writer`: Default write permissions (organization spaces only) - `admin`: Default admin permissions (organization spaces only)

Allowed:readerwriteradminno_access

ownerobjectrequired

The user or organization that owns this space.

creatorobjectrequired

A GitHub user.

created_atstringrequired

The date and time the space was created.

updated_atstringrequired

The date and time the space was last updated.

html_urlstringrequired

The HTML URL of the space.

api_urlstringrequired

The API URL of the space.

resources_attributesarray<object>optional

Resources attached to the space.

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 403 is returned: Forbidden. A 404 is returned: Resource not found.

import { Client } from "octri-github";

const client = new Client({
  baseUrl: "https://api.github.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.copilotSpaces.get({
  username: "octocat",
  spaceNumber: "example",
});

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

Was this helpful?

Request

Response

Errors