WRwriter
KG API

Retrieve graph

Changed on

Retrieve a Knowledge Graph.

get/v1/graphs/{graph_id}

Request

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

Path parameters

graph_idstring uuid required

The unique identifier of the Knowledge Graph.

Response

idstring uuid required

The 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.

descriptionstring

A description of the Knowledge Graph.

type'manual' | 'connector' | 'web' required

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
  • web: URLs are connected to the Knowledge Graph
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 optional property to the response with the status

  • 0bbaae2a6920Revision changes
    • warning

      added the new web enum value to the response property for the response status

    • info

      added the optional property to the response with the status