# List graph — GET /v1/knowledge/files/{id}/graph

URL: https://docs.hanzo.ai/docs/openapi/knowledge/get-knowledge-files-by-id-graph

> Answers one of the caller's org files' place in the org's graph: the files it links to and is linked from (a hyperlink, a citation by name), the files that name the same entities, and the entities it names.

`GET /v1/knowledge/files/{id}/graph`

> [Knowledge →](https://docs.hanzo.ai/docs/openapi/knowledge) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                      |
| ------------- | ---------------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/knowledge/files/{id}/graph` |
| **Method**    | `GET`                                                |
| **Operation** | `get_knowledge_files_by_id_graph`                    |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`               |

Answers one of the caller's org files' place in the org's graph:
the files it links to and is linked from (a hyperlink, a citation by name),
the files that name the same entities, and the entities it names. It is how
an agent finds the other documents a question about this one needs.

## Request

1 field.

| Field | In   | Type   | Required | Description                                                   |
| ----- | ---- | ------ | -------- | ------------------------------------------------------------- |
| `id`  | path | string | yes      | ID is the file's id, as POST /v1/knowledge/files answered it. |

## Response

| Status    | Body                | Meaning |
| --------- | ------------------- | ------- |
| `200`     | knowledge.fileGraph | ok      |
| `default` | problem-details     | refused |

`200` body — 34 fields.

| Field                 | In   | Type                    | Always | Description                                                                                                                                                                                    |
| --------------------- | ---- | ----------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `entities`            | body | knowledge.fileEntity\[] | —      | Entities are the entities it names, most mentioned first.                                                                                                                                      |
| `entities[].files`    | body | integer (int64)         | —      | Files is how many other files of the org name it too.                                                                                                                                          |
| `entities[].kind`     | body | string                  | —      | Kind is person, org, product, place or term.                                                                                                                                                   |
| `entities[].name`     | body | string                  | —      | Name is the entity as the text names it.                                                                                                                                                       |
| `entities[].sections` | body | integer (int64)         | —      | Sections is how many of the file's sections name it.                                                                                                                                           |
| `file`                | body | knowledge.File          | —      |                                                                                                                                                                                                |
| `file.bucket`         | body | string                  | —      | Bucket is the org bucket the object is in, by the friendly name /v1/s3/buckets lists.                                                                                                          |
| `file.chars`          | body | integer (int64)         | —      | Chars is the length of the text read out of the file, in bytes.                                                                                                                                |
| `file.clipped`        | body | boolean                 | —      | Clipped is true when only the file's beginning is indexed: its text ran past the org's bound or the room the index has.                                                                        |
| `file.created`        | body | integer (int64)         | —      | Created is when the file was first registered, in unix seconds.                                                                                                                                |
| `file.done`           | body | integer (int64)         | —      | Done is how far the running stage has come, of Total: bytes of the file read (extract), sections summarized (toc), cut into passages (passages) and linked (graph), passages embedded (embed). |
| `file.embedded`       | body | integer (int64)         | —      | Embedded is how many of those passages carry a vector — Passages once the embed stage is done, unless Note says the file is embedded in part.                                                  |
| `file.error`          | body | string                  | —      | Error is why a stored or failed file was not indexed — or, on a ready file, why it is searched by its words alone — in words a person can act on.                                              |
| `file.id`             | body | string                  | —      | ID names the file in its org.                                                                                                                                                                  |
| `file.key`            | body | string                  | —      | Key is the object's key in that bucket.                                                                                                                                                        |
| `file.name`           | body | string                  | —      | Name is the object's file name, the last segment of its key.                                                                                                                                   |
| `file.note`           | body | string                  | —      | Note says in words where the file is indexed less than whole and why: its text past the org's bound or the room the index has, its passages past the bound on vectors.                         |
| `file.parent`         | body | string                  | —      | Parent is the id of the archive this file was unpacked from.                                                                                                                                   |
| `file.passages`       | body | integer (int64)         | —      | Passages is how many passages its text was cut into.                                                                                                                                           |
| `file.project`        | body | string                  | —      | Project is the project scope it is indexed under.                                                                                                                                              |
| `file.sections`       | body | integer (int64)         | —      | Sections is how many nodes its table of contents has, the document's own root included.                                                                                                        |
| `file.size`           | body | integer (int64)         | —      | Size is the object's length in bytes, as the store reports it.                                                                                                                                 |
| `file.stage`          | body | string                  | —      | Stage is the ingest stage the file is in: extract, toc, passages or graph while indexing, embed while a ready file's vectors are written.                                                      |
| `file.status`         | body | string                  | —      | Status is queued, indexing, ready, stored (kept but not indexed — Error says why) or failed.                                                                                                   |
| `file.total`          | body | integer (int64)         | —      | Total is what the running stage has to do in all, in Done's units.                                                                                                                             |
| `file.type`           | body | string                  | —      | Type is the object's media type as the store holds it, or the one its name implies when the store holds only the generic default.                                                              |
| `file.updated`        | body | integer (int64)         | —      | Updated is when its record last changed, in unix seconds.                                                                                                                                      |
| `links`               | body | knowledge.fileLink\[]   | —      | Links are the other files it is joined to, strongest first.                                                                                                                                    |
| `links[].direction`   | body | string                  | —      | Direction is out when this file links to the other, in when the other links to this one, and shared when the two name the same entities.                                                       |
| `links[].file`        | body | string                  | —      | File is the other file, by id.                                                                                                                                                                 |
| `links[].kind`        | body | string                  | —      | Kind is href (a hyperlink), cites (the text names the file), xref (a cross-reference inside one document) or entity (shared mentions).                                                         |
| `links[].label`       | body | string                  | —      | Label is the link's own text, or the entities the two files share.                                                                                                                             |
| `links[].name`        | body | string                  | —      | Name is the other file's name.                                                                                                                                                                 |
| `links[].weight`      | body | integer (int64)         | —      | Weight is how many edges of this kind join the two; for shared entities, how many entities they share.                                                                                         |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

`hanzo` has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.

**SDK**

**.ts**

```ts
import { Configuration, KnowledgeApi } from 'hanzoai';

const api = new KnowledgeApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getKnowledgeFilesByIdGraph({ id: 'id' });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import KnowledgeApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = KnowledgeApi(client).get_knowledge_files_by_id_graph(id='id')
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.KnowledgeAPI.GetKnowledgeFilesByIdGraph(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, knowledge_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = knowledge_api::get_knowledge_files_by_id_graph(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.KnowledgeApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new KnowledgeApi(client).getKnowledgeFilesByIdGraph();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/knowledge/files/<id>/graph \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

MCP reaches **knowledge** through the `knowledge` tool, which names its 9 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_knowledge_connectors"
         }
       }
     }'
```

---

[Knowledge API](https://docs.hanzo.ai/docs/openapi/knowledge) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)
