GET/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}

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.

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.

RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters

orgstringrequired

The organization name. The name is not case sensitive.

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 "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.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({
  org: "acme-inc",
  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"
}

Request

Response

Errors