WRwriter
KG API

List graphs

Changed on

Retrieve a list of Knowledge Graphs.

By default, the response contains only org-wide Knowledge Graphs. To include Knowledge Graphs that are deployed to specific teams, pass one or more team IDs in the team_ids query parameter. Requests authenticated with a team-scoped API key always return only that key's team; passing a different value in team_ids is rejected.

get/v1/graphs

Request

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

Query parameters

order'asc' | 'desc'

Specifies the order of the results. Valid values are asc for ascending and desc for descending.

beforestring uuid

The ID of the first object in the previous page. This parameter instructs the API to return the previous page of results.

afterstring uuid

The ID of the last object in the previous page. This parameter instructs the API to return the next page of results.

limitinteger

Specifies the maximum number of objects returned in a page. The default value is 50. The minimum value is 1, and the maximum value is 100.

team_idsinteger[]

Filter results to Knowledge Graphs deployed to any of the specified teams. Repeat the query parameter to pass multiple IDs (for example, ?team_ids=42&team_ids=43). Omitting this parameter returns only org-wide Knowledge Graphs; Knowledge Graphs deployed to specific teams are excluded unless the caller opts them in via team_ids.

Response

first_idstring uuid

The ID of the first Knowledge Graph in the current response.

last_idstring uuid

The ID of the last Knowledge Graph in the current response.

has_moreboolean required

Indicates if there are more Knowledge Graphs available beyond the current page.

Changes

  • 55e7d6385506Revision changes
    • info

      added the new optional query request parameter team_ids

    • 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