WRwriter
KG API

Create graph

Changed on

Create a new Knowledge Graph.

By default, the new Knowledge Graph is org-wide (accessible to every team in the organization). To deploy the Knowledge Graph to specific teams instead, provide a team_ids array in the request body. When the request is authenticated with a team-scoped API key, the new Knowledge Graph is automatically assigned to that key's team and team_ids in the body is not accepted.

post/v1/graphs

Request

  • Base URL
    https://api.writer.com
  • URL
    https://api.writer.com/v1/graphs
  • Auth
    HTTP bearer

Request body

namestring

The name of the Knowledge Graph (max 255 characters). Omitting this field leaves the name unchanged.

descriptionstring

A description of the Knowledge Graph (max 255 characters). Omitting this field leaves the description unchanged.

team_idsinteger[]

Optional list of team IDs to deploy the Knowledge Graph to. Omit the field or pass an empty array to create an org-wide Knowledge Graph (accessible to every team in the organization), which is the default. Provide one or more team IDs to scope the Knowledge Graph to those teams. Only applies when using an org-scoped API key; requests made with a team-scoped API key ignore this field and always assign the graph to that key's team.

Response

idstring uuid required

A unique identifier of the Knowledge Graph.

created_atstring date-time required

The timestamp when the Knowledge Graph was created.

namestring required

The name of the Knowledge Graph (max 255 characters).

descriptionstring

A description of the Knowledge Graph (max 255 characters).

team_idsinteger[]

The team IDs the Knowledge Graph is deployed to. An empty array indicates an org-wide Knowledge Graph accessible to every team in the organization.

Changes

  • 55e7d6385506Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 0bbaae2a6920Revision changes
    • info

      added the optional property to the response with the status