Dynamiq
Knowledge Bases

List knowledge base sources

Lists the connected content sources of a knowledge base — for example Google Drive, SharePoint, Notion, or a crawled website — that feed documents into it.

GET
/v1/knowledgebases/{knowledgebase_id}/sources

Authorization

personalAccessToken
AuthorizationBearer <token>

Personal Access Token of a Dynamiq user — the only credential accepted by the management API (api.*). Prefix dyn_pat_ (legacy uak_ tokens still authenticate). Send as Authorization: Bearer <token>.

In: header

Path Parameters

knowledgebase_id*string

Knowledge base UUID.

Query Parameters

page?integer

Page number (1-based).

page_size?integer

Number of items per page. Values below the minimum or above the maximum are clamped to the nearest bound.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/knowledgebases/497f6eca-6276-4993-bfeb-53cbbbba6f08/sources"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "knowledgebase_id": "6f950f69-320f-4b35-bbd4-0a7c1c91d2a1",
      "name": "string",
      "description": "string",
      "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9",
      "provider": "google_drive",
      "status": "active",
      "config": {},
      "latest_sync_id": "20fba974-7acd-480e-bb67-4e62961cb88e",
      "latest_sync": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
        "status": "running",
        "started_at": "2019-08-24T14:15:22Z",
        "ended_at": "2019-08-24T14:15:22Z",
        "error": null
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "first_name": "string",
        "last_name": "string",
        "avatar_url": "string"
      },
      "updated_by": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "first_name": "string",
        "last_name": "string",
        "avatar_url": "string"
      }
    }
  ],
  "pagination": {
    "page": 0,
    "page_size": 0,
    "page_count": 0,
    "total_count": 0
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

Download a knowledge base item file

Downloads the original file backing a knowledge base item as a binary attachment (`Content-Disposition: attachment; filename="<item-name>"`).

Create a knowledge base source

Connects a content source to a knowledge base. `provider` selects the source type and `config` carries the provider-specific selection (drives, folders, files, or — for `website` — the URL and crawl limits). A `connection_id` referencing an OAuth connection is required for every provider except `website`.