Skip to main content
GET
/
v1
/
graphs
cURL
curl --location --request GET https://api.writer.com/v1/graphs \
 --header "Authorization: Bearer <token>"
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "file_status": {
        "in_progress": 123,
        "completed": 123,
        "failed": 123,
        "total": 123
      },
      "type": "manual",
      "description": "<string>",
      "urls": [
        {
          "url": "<string>",
          "status": {
            "status": "validating",
            "error_type": "invalid_url"
          },
          "type": "single_page",
          "exclude_urls": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "has_more": true,
  "first_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
order
enum<string>
default:desc

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

Available options:
asc,
desc
​
before
string<uuid>

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

​
after
string<uuid>

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

​
limit
integer<int32>
default:50

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.

Response

200 - application/json
​
data
graph · object[]
required
​
has_more
boolean
required

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

​
first_id
string<uuid>

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

​
last_id
string<uuid>

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