Update graph

Update the name, description, web connector URLs, or team assignment of a Knowledge Graph.

Including a team_ids array replaces the whole team assignment: an empty array makes the Knowledge Graph org-wide, one or more team IDs scope it to exactly those teams. Omitting team_ids leaves the current team assignment unchanged. Team-scoped API keys cannot change the team assignment of a Knowledge Graph.

PUT /v1/graphs/{graph_id}

cURL

cURL

curl --location --request PUT https://api.writer.com/v1/graphs/{graph_id} \
 --header "Authorization: Bearer <token>" \
 --header "Content-Type: application/json" \
--data-raw '{"name":"string", "description":"string", "urls":[{"url":"https://example.com/docs", "type":"sub_pages", "exclude_urls":["https://example.com/docs/private"]}]}'

200

{
  "id": "50daa3d0-e7d9-44a4-be42-b53e2379ebf7",
  "created_at": "2024-07-10T15:03:48.785843Z",
  "name": "Updated graph name",
  "description": "Updated graph description",
  "urls": [
    {
      "url": "https://example.com/docs",
      "status": {
        "status": "success",
        "error_type": null
      },
      "type": "sub_pages"
    }
  ],
  "team_ids": []
}

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.

Path Parameters

graph_id · string<uuid> · required

The unique identifier of the Knowledge Graph.

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.

urls · update_graph_web_url · object[]

An array of web connector URLs to update for this Knowledge Graph. You can only connect URLs to Knowledge Graphs with the type web. To clear the list of URLs, set this field to an empty array.

Show child attributes

team_ids · integer<int64>[]

Optional list of team IDs the Knowledge Graph is deployed to. Omitting this field leaves the current team assignment unchanged. Passing an array replaces the whole team assignment: an empty array makes the graph org-wide, one or more team IDs scope it to exactly those teams. Not accepted from team-scoped API keys.

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.

Show child attributes

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.