---
title: "List documents in knowledge graph"
method: GET
path: "/api/v0/knowledge-graphs/{kg_id}/documents"
tags: ["Knowledge Graphs"]
---

# List documents in knowledge graph

`GET /api/v0/knowledge-graphs/{kg_id}/documents`

Paginated list of documents associated with the knowledge graph. Same response shape as GET /documents; KG ownership is the authorization boundary (404 if the KG isn't found or owned).

## Path parameters

- `kg_id` string, uuid, required

## Query parameters

- `limit` integer — Maximum number of documents to return per page.
- `offset` integer — Number of documents to skip.

## Response `200`

Successful Response

- DocumentListResponse
  - `documents` DocumentGetResponse[], required — The list of documents.
    - `id` string, uuid, required — The ID of the document.
    - `name` string, required — The name of the document.
    - `folder_id` string, uuid, nullable, required — The ID of the folder that contains the document.
    - `file_path` string, nullable, required — The path to the document file.
    - `file_type` string, required — The type of the document file. Options: `pdf`, `docx`, `txt`, `html`, `md`.
    - `file_url` string, nullable, required — The URL of the document file.
    - `renditions` DocumentRenditionResponse[] — Derived views of the file, one entry per kind — `pdf` for the paginated rendition, `mesh` for a 3D solid's tessellation. A viewer selects on which kinds are present, never on the file's extension.
      - `kind` string, required — What the rendition is: `pdf` (paginated) or `mesh` (3D solid).
      - `file_path` string, required — The storage path of the rendition.
      - `file_url` string, nullable — A signed URL for the rendition.
    - `summary` string, required — A summary of the document content.
    - `visibility` string, required — The visibility of the document. Options: `private`, `org`.
    - `num_pages` integer, required — The number of pages in the document.
    - `version` integer, required — The version of the document.
    - `job_status_id` string, uuid, nullable — The public UUID of the job status for the document's current processing job.
    - `job_status` string, nullable — The current job status: queued, processing, done, error, cancelled.
    - `created_at` string, date-time, required — The date and time the document was created.
    - `updated_at` string, date-time, required — The date and time the document was last updated.
    - `tags` string[], required — The tags associated with the document.
  - `pagination` PaginationMetadata, required
    - `total` integer, required — The total number of items matching the query.
    - `limit` integer, required — The maximum number of items per page.
    - `offset` integer, required — The number of items skipped.
    - `has_more` boolean, required — Whether there are more items available.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/outerport/apis/outerport-api.md) · [All operations](https://skmtc.dev/outerport/apis/outerport-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/outerport/outerport-api/revisions/f565b46daaea/schema)
