Dynamiq
Knowledge Bases

Update a knowledge base source

Updates a source's provider-specific config (for example the selected drives, folders, files, or website crawl settings). provider must match the source's existing provider.

PUT
/v1/knowledgebase-sources/{source_id}

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

source_id*string

Knowledge base source UUID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Body for PUT /v1/knowledgebase-sources/{source_id}.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/knowledgebase-sources/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "provider": "google_drive",    "config": {}  }'
{
  "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"
    }
  }
}
{
  "error": {
    "code": "bad_request",
    "message": "Bad Request",
    "details": {
      "input": "cannot be blank"
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}