cURL
curl --location --request GET https://api.writer.com/v1/files/{file_id} \
--header "Authorization: Bearer <token>"import os
from writerai import Writer
client = Writer(
# This is the default and can be omitted
api_key=os.environ.get("WRITER_API_KEY"),
)
file = client.files.retrieve(
"file_id",
)
print(file.id)import Writer from 'writer-sdk';
const client = new Writer({
apiKey: process.env['WRITER_API_KEY'], // This is the default and can be omitted
});
async function main() {
const file = await client.files.retrieve('file_id');
console.log(file.id);
}
main();{
"id": "7c36a365-392f-43ba-840d-8f3103b42572",
"created_at": "2024-07-10T13:34:28.301201Z",
"name": "example.pdf",
"graph_ids": [
"704ffd94-de04-4de2-9f8b-f9fc04831edd"
],
"status": "completed"
}Files API
Retrieve file
Retrieve detailed information about a specific file, including its metadata, status, and associated graphs.
GET
/
v1
/
files
/
{file_id}
cURL
curl --location --request GET https://api.writer.com/v1/files/{file_id} \
--header "Authorization: Bearer <token>"import os
from writerai import Writer
client = Writer(
# This is the default and can be omitted
api_key=os.environ.get("WRITER_API_KEY"),
)
file = client.files.retrieve(
"file_id",
)
print(file.id)import Writer from 'writer-sdk';
const client = new Writer({
apiKey: process.env['WRITER_API_KEY'], // This is the default and can be omitted
});
async function main() {
const file = await client.files.retrieve('file_id');
console.log(file.id);
}
main();{
"id": "7c36a365-392f-43ba-840d-8f3103b42572",
"created_at": "2024-07-10T13:34:28.301201Z",
"name": "example.pdf",
"graph_ids": [
"704ffd94-de04-4de2-9f8b-f9fc04831edd"
],
"status": "completed"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your Writer API key.
Path Parameters
The unique identifier of the file.
Response
200 - application/json
A unique identifier of the file.
The timestamp when the file was uploaded.
The name of the file.
A list of Knowledge Graph IDs that the file is associated with.
If you provided a graphId during upload, the file is associated with that Knowledge Graph. However, the graph_ids field in the upload response is an empty list. The association will be visible in the graph_ids list when you retrieve the file using the file retrieval endpoint.
The processing status of the file.
Was this page helpful?