AI

Get web knowledge source links

Changed on

This endpoint returns a paginated list of links that were indexed from a web knowledge source. This is useful for understanding what content the AI copilot has access to from web sources. Corresponds to liveblocks.getWebKnowledgeSourceLinks.

get/ai/copilots/{copilotId}/knowledge/web/{knowledgeSourceId}/links

Request

  • Base URL: https://api.liveblocks.io/v2
  • URL: https://api.liveblocks.io/v2/ai/copilots/{copilotId}/knowledge/web/{knowledgeSourceId}/links
  • Auth: none declared

Path parameters

copilotIdstring required

ID of the AI copilot

Example:cp_abc123
knowledgeSourceIdstring required

ID of the knowledge source

Example:ks_abc123

Query parameters

limitinteger

A limit on the number of links to be returned. The limit can range between 1 and 100, and defaults to 20.

Example:20
startingAfterstring

A cursor used for pagination. Get the value from the nextCursor response of the previous page.

Example:eyJjcmVhdGVkQXQiOjE2NjAwMDA5ODgxMzd9

Response

Success. Returns the list of web knowledge source links.

nextCursorstring nullable required

Example response

{
  "nextCursor": null,
  "data": [
    {
      "id": "ksl_abc123",
      "url": "https://docs.example.com/getting-started",
      "status": "ready",
      "createdAt": "2024-06-01T12:00:00.000Z",
      "lastIndexedAt": "2024-06-01T12:00:00.000Z"
    }
  ]
}

Changes

  • 77cd6a75b2b7Revision changes
    • breaking

      for the query request parameter limit, the type changed from number to integer

    • breaking

      response property nextCursor list-of-types was widened by adding types null to media type application/json of response 200

    • info

      the response property became required for the status

    • info

      the response property became required for the status

  • ec617781b00bRevision changes
    • info

      endpoint added