List queryable sources – GET /v1/sources

GET/v1/sources

betaapiKeyworkspace

When to use

Start here to discover queryable datasets and connectors in the current workspace.

For agents

Call this before selecting sources. Prefer source IDs returned here over guessed IDs.

Example

typescript

import { PermuteClient } from '@permute/sdk';

const orgClient = new PermuteClient({
  apiKey: process.env.PERMUTE_API_KEY!,
});

const client = orgClient.withWorkspace(process.env.PERMUTE_WORKSPACE_ID!);

const result = await client.sources.list();

Response

json

{
  "data": {
    "items": [
      {
        "id": "data_abc123",
        "type": "dataset",
        "name": "Revenue workbook.xlsx",
        "summary": "Monthly revenue and customer detail",
        "fileType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
      },
      {
        "id": "conn_hubspot123",
        "type": "connector",
        "name": "HubSpot",
        "provider": "hubspot",
        "summary": "hubspot connector"
      }
    ]
  }
}