Create graph
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.
- With an org-scoped API key, control team scope from the request body: pass
team_idson create or update, or filter list with theteam_idsquery parameter. Omitteam_idson 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_idsis not accepted.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your Writer API key.
Body
The name of the Knowledge Graph (max 255 characters). Omitting this field leaves the name unchanged.
A description of the Knowledge Graph (max 255 characters). Omitting this field leaves the description unchanged.
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
A unique identifier of the Knowledge Graph.
The timestamp when the Knowledge Graph was created.
The name of the Knowledge Graph (max 255 characters).
A description of the Knowledge Graph (max 255 characters).
An array of web connector URLs associated with this Knowledge Graph.
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.