Skip to main content
GET
/
v1
/
graphs
/
{graph_id}
cURL
curl --location --request GET https://api.writer.com/v1/graphs/{graph_id} \  --header "Authorization: Bearer <token>"
{  "id": "50daa3d0-e7d9-44a4-be42-b53e2379ebf7",  "created_at": "2024-07-10T15:03:48.785843Z",  "name": "Example Knowledge Graph",  "description": "Example description",  "file_status": {  "in_progress": 0,  "completed": 0,  "failed": 0,  "total": 0  },  "type": "web",  "urls": [  {  "url": "https://example.com/docs",  "status": {  "status": "success",  "error_type": null  },  "type": "sub_pages"  },  {  "url": "https://docs.example.com",  "status": {  "status": "error",  "error_type": "invalid_url"  },  "type": "single_page"  }  ] }

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.

Response

200 - application/json
id
string<uuid>
required

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

file_status
object
required

The processing status of files in the Knowledge Graph.

type
enum<string>
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
Available options:
manual,
connector,
web
description
string

A description of the Knowledge Graph.

urls
web_connector_url · object[]

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

⌘I