Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Writer KG API API

The KG API API from Writer — 5 operation(s) for kg api.

Writer KG API API is one of 7 APIs that Writer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include KG API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 5 paths, and defines 26 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.writer.com.

8 operations 5 paths 26 schemas 2 DELETE2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.writer.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Writer KG API API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer authentication header of the form Bearer , where is your [Writer API key](https://dev.writer.com/api-reference/api-keys).

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 2 DELETE, 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

KG API 8
GET
/v1/graphs
List graphs
findGraphsWithFileStatus 4 params → 200
POST
/v1/graphs
Create graph
createGraph body → 200
POST
/v1/graphs/question
Question
question body → 200
GET
/v1/graphs/{graph_id}
Retrieve graph
findGraphWithFileStatus 1 param → 200
PUT
/v1/graphs/{graph_id}
Update graph
updateGraph 1 param body → 200
DELETE
/v1/graphs/{graph_id}
Delete graph
deleteGraph 1 param → 200
POST
/v1/graphs/{graph_id}/file
Add file to graph
addFileToGraph 1 param body → 200
DELETE
/v1/graphs/{graph_id}/file/{file_id}
Remove file from graph
removeFileFromGraph 2 params → 200

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are graph_query_config (8 properties), graph (7 properties), file_response (5 properties), question_response (5 properties). Each schema is shown below with its type and property counts.

question_request
object
5 properties 2 required
web_connector_url
object
4 properties 3 required
source
object
A source snippet containing text and fileId from Knowledge Graph content.
2 properties 2 required
graph_type
string
The type of Knowledge Graph: - manual: files are uploaded via UI or API - connector: files are uploaded via a data connector such as Google Drive or Confluence…
delete_graph_response
object
2 properties 2 required
references
object
Detailed source information organized by reference type, providing comprehensive metadata about the sources used to generate the response.
2 properties
question_response_chunk
object
1 property 1 required
graph_request
object
2 properties
web_connector_url_error_type
string
The type of error that can occur during web connector URL processing.
graph_file_request
object
1 property 1 required
web
object
A web-based reference containing text snippets from online sources accessed during the query.
4 properties 4 required
web_connector_url_status
string
The status of web connector URL processing.
graph
object
7 properties 5 required
graph_response
object
5 properties 3 required
file
object
A file-based reference containing text snippets from uploaded documents in the Knowledge Graph.
5 properties 3 required
graph_query_config
object
Configuration options for Knowledge Graph queries.
8 properties
update_graph_web_url
object
3 properties 2 required
update_graph_request
object
3 properties
graph_file_status
object
4 properties 4 required
web_connector_url_type
string
The type of web connector processing for a URL.
sub_query
object
A sub-question generated to break down complex queries into more manageable parts, along with its answer and supporting sources.
3 properties 3 required
web_connector_url_state
object
The state of a web connector URL processing.
2 properties 1 required
graphs_response
object
4 properties 2 required
question_response
object
5 properties 3 required
file_response
object
5 properties 5 required
delete_file_response
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

writer-kg-api-api-openapi.yml Raw ↑

Other APIs Writer publishes across the network.

Writer File API API
Writer Generation API API
Writer template API
Writer Tools API API
Writer Translation API
Writer Vision API