GET

List a project's Knowledge

/v1/projects/{project}/knowledge in the Knowledge API.

curl "https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/knowledge?per_page=50" \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

Pages the entries, newest first. Each row names the entry's kind, its audience, its status with a label beside each, its title and how many passages it became; body is null on every row. Sort with sort_by (created_at by default, or updated_at, title) and sort_direction.

Requires ability

project-knowledge:view-any

The token must hold this ability, or the call is refused with 403.

MCP tool

list_knowledge_entries

Runs the same action from an agent, behind the same ability.

Authorization

bearerToken

AuthorizationBearer <token>

A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.

In: header

Path Parameters

project*string

The project, resolved by the route binder.

Formatuuid

Query Parameters

page?integer

The 1-based page to return. A page past the last answers an empty data array with meta.total still filled, so a loop can stop without guessing.

Range1 <= value

Default1

per_page?integer

Rows per page, 1 to 100. A higher value clamps to the cap silently. Defaults to 25.

Range1 <= value <= 100

Default25

sort_by?string

The column to order by. Defaults to created_at; a column the endpoint does not offer falls back to the default rather than failing.

Default"created_at"

sort_direction?string

asc or desc. Defaults to desc.

Default"desc"

Value in

"asc"
"desc"

limit?integer

Legacy alias of per_page, kept for clients that predate it. per_page wins when both are sent.

Range1 <= value <= 100

Responses

200OKapplication/json

The page of entries, without their text.

401UnauthorizedAUTHENTICATION_REQUIREDapplication/json

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.

404Not foundRESOURCE_NOT_FOUNDapplication/json

An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.

422Validation failedVALIDATION_FAILEDapplication/json

The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with error.message saying why and no fields.

429Too many requestsRATE_LIMITEDapplication/json

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X GET "https://example.com/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/knowledge"

{  "data": [    {      "id": "3b7e4d2a-9c1f-4a6b-8d5e-2f7c9a1b3e4d",      "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",      "kind": "question",      "kind_label": "Question & Answer",      "audience": "members",      "audience_label": "Members & Team",      "status": "ready",      "status_label": "Ready",      "title": "When does my membership renew?",      "body": null,      "file_name": null,      "file_size": null,      "mime": null,      "chunk_count": 1,      "characters": 64,      "failure": null,      "indexed_at": "2026-10-19T16:02:11+00:00",      "created_at": "2026-10-19T16:02:11+00:00",      "updated_at": "2026-10-19T16:02:11+00:00"    }  ],  "links": {    "first": "…",    "last": "…",    "prev": null,    "next": null  },  "meta": {    "current_page": 1,    "from": 1,    "last_page": 1,    "path": "…",    "per_page": 50,    "to": 1,    "total": 1  }}

Type definitions

The shapes above as types, ready to paste into your client.

export interface Response {  data: KnowledgeEntryResource[];  links: Links;  meta: Meta;}export interface KnowledgeEntryResource {  id: string;  project_id: string;  kind: string;  kind_label: "Question & Answer" | "Document";  audience: string;  audience_label: "Team Only" | "Members & Team";  status: string;  status_label: "Indexing" | "Ready" | "Failed";  title: string;  body: string | null;  file_name: string | null;  file_size: number | null;  mime: string | null;  chunk_count: number;  characters: number;  failure: string | null;  indexed_at: string | null;  created_at: string | null;  updated_at: string | null;}export interface Links {  first: string | null;  last: string | null;  prev: string | null;  next: string | null;}export interface Meta {  current_page: number;  from: number | null;  last_page: number;  links: Link[];  path: string | null;  per_page: number;  to: number | null;  total: number;}export interface Link {  url: string | null;  label: string;  active: boolean;}

How is this guide?

Last updated on October 19, 2026 at 20:02 UTC

Knowledge API

Knowledge is what a project teaches Subscriby Copilot beyond what Subscriby already knows about it: questions with their answers, and guides, each cut into passages the Copilot is handed when a question matches.

Create a Knowledge entry

/v1/projects/{project}/knowledge in the Knowledge API.