Download a document
GEThttps://api.getwerk.ai/api/v1/projects/{projectId}/cards/{cardId}/documents/{documentId}/original
The document's original file, as an attachment.
With If-None-Match holding its current ETag, the answer is 304 with no body.
Authorization
AuthorizationheaderRequired
Authorization: Bearer <key> Authentication
Headers
If-None-Matchstring
The ETag of a copy already held. When it is current, the answer is 304.
Path parameters
projectIdstring, uuidRequired
The project's id.
cardIdstring, uuidRequired
The card's id.
documentIdstring, uuidRequired
The document's id.
Response
200 The original file.
application/pdfapplication/vnd.openxmlformats-officedocument.wordprocessingml.documentapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheettext/csvtext/plaintext/markdown
304 The copy held is current.
Errors
400
invalid_query The query is not in the form the route takes; the limit is in the unit of the input details.field names (characters for a text, entries for a list, the value for a number).401
session_revoked The request carries no session the server holds, or its session has ended.401
session_expired The session has expired.404
conversation_not_found The project the request names, or its chat, is not one the signed-in person is in.404
item_not_found The card the request names, or its list, is not one the signed-in person can see.404
asset_not_found The file the request names is not one the signed-in person can reach where the request names it, or is no longer available.409
session_changed The session changed while the request was in flight.429
rate_limited More requests of this kind were sent than Werk takes within the time it counts them over.500
server_error The server could not complete the request, and it is not known whether a write it holds was made.curl
curl "https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/cards/3c9e5b17-8d2f-4a64-b1e3-7f5a0c9d2b48/documents/d7e1b5c3-9a4f-4e26-b8d0-2f6a4c8e1d59/original" \
-H "Authorization: Bearer wk_key_..."TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/cards/3c9e5b17-8d2f-4a64-b1e3-7f5a0c9d2b48/documents/d7e1b5c3-9a4f-4e26-b8d0-2f6a4c8e1d59/original", {
headers: {
Authorization: "Bearer wk_key_...",
},
});200
Send a requestGET
It is sent with the key you give, as you. A change made here is real.
JSON
The request could not be sent, or its response could not be read.