Get a resource for a Copilot Space for a user

3 parameters

usernamestringrequired

The handle for the GitHub user account.

space_numberintegerrequired

The unique identifier of the Copilot Space.

space_resource_idintegerrequired

The unique identifier of the resource.

3 status codes

200Response

idintegerrequired

The unique identifier of the resource.

resource_typestringrequired

The type of the resource.

Allowed:repositorygithub_filefree_textgithub_issuegithub_pull_requestmedia_contentuploaded_text_file

copilot_chat_attachment_idintegeroptional

The ID of the associated chat attachment, if any.

metadataobjectrequired

Resource-specific metadata. The keys and values depend on the resource type.

created_atstringrequired

The date and time the resource was created.

updated_atstringrequired

The date and time the resource was last updated.

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.resources.get({
  username: "octocat",
  spaceNumber: "example",
  spaceResourceId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
});

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

Was this helpful?

Request

Response

Errors