Dynamiq
Knowledge Bases

List knowledge bases

Lists the knowledge bases of a project, ordered by name by default. The project_id query parameter is required.

GET
/v1/knowledgebases

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

Query Parameters

project_id*string

Project UUID to list knowledge bases for.

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.

sort?string

Comma-separated sort fields. Prefix a field with - for descending order, e.g. sort=-started_at.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/knowledgebases?project_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
      "workflow_id": "03e70e31-d7a4-4401-a629-6a4b6096cdfe",
      "workflow_version_id": "60bab57e-9f59-448d-bef4-a6fd602db8a4",
      "runtime_id": "cb6c5dda-251e-4b64-ab75-e6c8247ffa87",
      "hostname": "string",
      "vector_store_id": "fde8ce2d-425a-4f9f-ac16-b00440677b44",
      "runtime": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "version": "string",
        "label": "string"
      },
      "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": "bad_request",
    "message": "Bad Request",
    "details": {
      "input": "cannot be blank"
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

Start linking an action connector account

Starts the hosted flow that links an action connector account for a `pipedream_account` requirement. Returns a connect URL, pre-targeted at the connector app declared in the requirement's spec (for example `gmail`); redirect the end user there to authorize their account. Once the account is linked, the requirement becomes `completed`. The request has no body. Served on the management API; authenticate with a connect token.

Create a knowledge base

Creates a knowledge base in a project. The `flow` and `flow_ui` describe the ingestion workflow (how uploaded documents are chunked, embedded, and indexed) and its editor layout. On creation the knowledge base is provisioned with its own `hostname` for document search and uploads.