Create and manage a Knowledge Graph
Knowledge Graph, our graph-based retrieval-augmented generation (RAG), achieves higher accuracy than traditional RAG approaches that use vector retrieval.
This guide will help you understand and use the Knowledge Graph API to integrate RAG capabilities into your no-code applications.
You need an API key to access the Writer API. Get an API key by following the steps in the API quickstart.
We recommend setting the API key as an environment variable in a .env
file with the name WRITER_API_KEY
.
Create a Knowledge Graph
A Knowledge Graph is a collection of files that are used to answer questions. To start working with a Knowledge Graph, create an empty Knowledge Graph that you can add files to.
Endpoint: POST https://api.writer.com/v1/graphs
Request body
The request body is a JSON object that contains the following fields:
Parameter | Type | Description |
---|---|---|
name | string | The name of the Knowledge Graph. |
description | string | The description of the Knowledge Graph. The description should help the model understand the purpose of the Knowledge Graph and when it should be used. |
Response format
The response has the following structure:
Parameter | Type | Description |
---|---|---|
id | string | The ID of the Knowledge Graph. |
created_at | string | The date and time the Knowledge Graph was created. |
name | string | The name of the Knowledge Graph. |
description | string | The description of the Knowledge Graph. |
Add a file to a Knowledge Graph
Once you’ve created a Knowledge Graph, you can add files to it. The files you add to a Knowledge Graph are used to answer questions and enhance the accuracy of the responses from the LLM
You must upload the file to the Writer API before adding it to a Knowledge Graph. See Manage files for more information about how to upload files.
Endpoint: POST /v1/graphs/{graph_id}/file
The response will have this structure:
Path parameters
Parameter | Description |
---|---|
graph_id | The ID of the Knowledge Graph to update. |
Request body
The request body is a JSON object that contains the following fields:
Parameter | Description |
---|---|
file_id | The ID of the file to add to the Knowledge Graph. |
You must upload the file to the Writer API before adding it to a Knowledge Graph. See Manage files for more information about how to upload files.
Remove a file from a Knowledge Graph
Endpoint: DELETE /v1/graphs/{graph_id}/file/{file_id}
Path parameters
Parameter | Description |
---|---|
graph_id | The ID of the Knowledge Graph to update. |
file_id | The ID of the file to remove from the Knowledge Graph. |
Response format
The response has this structure:
Add a Knowledge Graph to a no-code application
After you’ve created a Knowledge Graph, you can add it to a no-code application to add RAG capabilities.
You can use this endpoint to add or remove Knowledge Graphs from a no-code application.
Endpoint: PUT /v1/applications/{application_id}/graphs
Path parameters
Parameter | Description |
---|---|
application_id | The ID of the no-code application to update. |
Request body
The request body is a JSON object that contains the following fields:
Parameter | Type | Description |
---|---|---|
graph_ids | array[string] | The IDs of the Knowledge Graphs to associate with the no-code application. |
This method updates the associated Knowledge Graphs to the exact list of IDs provided in the request.
To remove a single Knowledge Graph from the no-code application, set the graph_ids
parameter to an array containing the IDs of all the other Knowledge Graphs associated with the no-code application, excluding the ID of the Knowledge Graph to remove. To remove all Knowledge Graphs from the no-code application, set this parameter to an empty array.
Response format
The response contains the new list of IDs of the Knowledge Graphs associated with the no-code application.
Next steps
Now that you’ve created a Knowledge Graph, learn how to ask it questions in a chat completion via tool calling.
Was this page helpful?