GET
/
v1
/
files
curl --location --request GET https://api.writer.com/v1/files \
 --header "Authorization: Bearer <token>"
{
  "data": [
    {
      "id": "7c36a365-392f-43ba-840d-8f3103b42572",
      "name": "example.pdf",
      "created_at": "2024-07-10T12:00:00Z",
      "graph_ids": [
        "31a8b75a-9a90-432f-8861-942229125333"
      ],
      "status": "in_progress"
    },
    {
      "id": "4bbe6207-737e-486f-a287-c5e95536984a",
      "name": "image.jpg",
      "created_at": "2024-07-09T15:30:00Z",
      "graph_ids": [
        "31a8b75a-9a90-432f-8861-942229125333"
      ],
      "status": "completed"
    },
    {
      "id": "efc86bb4-30a4-40c9-a52a-ecee0d7e071f",
      "name": "document.txt",
      "created_at": "2024-07-08T16:00:00Z",
      "graph_ids": [
        "31a8b75a-9a90-432f-8861-942229125333"
      ],
      "status": "failed"
    }
  ],
  "has_more": false,
  "first_id": "7c36a365-392f-43ba-840d-8f3103b42572",
  "last_id": "efc86bb4-30a4-40c9-a52a-ecee0d7e071f"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
before
string

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

​
after
string

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

​
limit
integer
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.

​
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
​
graph_id
string

The unique identifier of the graph to which the files belong.

​
status
enum<string>

Specifies the status of the files to retrieve. Valid values are in_progress, completed or failed.

Available options:
in_progress,
completed,
failed
​
file_types
string

The extensions of the files to retrieve. Separate multiple extensions with a comma. For example: pdf,jpg,docx.

Response

200 - application/json

The response is of type object.