Skip to main content
POST
cURL
Knowledge Graphs can be deployed org-wide (accessible to every team in the organization) or deployed to specific teams. Both are accessible via the API and SDK.
  • With an org-scoped API key, control team scope from the request body: pass team_ids on create or update, or filter list with the team_ids query parameter. Omit team_ids on list to see only org-wide Knowledge Graphs.
  • With a team-scoped API key, every request is automatically restricted to the key’s team. Create assigns to that team; list and retrieve return only that team’s Knowledge Graphs; body team_ids is not accepted.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your Writer API key.

Body

application/json
name
string

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

description
string

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

team_ids
integer<int64>[]

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

200 - application/json
id
string<uuid>
required

A unique identifier of the Knowledge Graph.

created_at
string<date-time>
required

The timestamp when the Knowledge Graph was created.

name
string
required

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

description
string

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

urls
web_connector_url · object[]

An array of web connector URLs associated with this Knowledge Graph.

team_ids
integer<int64>[]

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.