Search files
The photos and documents on the cards of the key's person's projects, listed by filters or searched by words.
With q, Werk looks in file names, in what it read in photos and documents, and by meaning; without it, files are listed newest first. Each file comes with its card and project.
Authorization
Authorization: Bearer <key> Authentication
Headers
The language tag Werk writes the answer's own words in, such as step names and history lines, matched to a language it serves; a card's text stays as written. At a project's paths, the reads of its cards and steps, of a card, its update photos, a file and its reminders, and of follow and reminder invitations, and a document's read-now and consent, take the language of the person's chat with Werk in that project first, while it has one. Without either, the language Werk uses with the person the key or the connection acts for.
Query parameters
The words to look for; left out, files are listed by the other filters.
Where to look for the words, comma separated: name, description, text, summary, pages; left out, everywhere.
Project ids, comma separated; left out, every project of the key's person.
A card's id, to keep that card's files only.
Keeps files of one kind only.
A person's id, to keep the files they added.
Keeps files added from this day or moment on: YYYY-MM-DD in the key's person's time zone, or an ISO 8601 date and time with Z or an offset.
Keeps files added before this day or moment, in the same forms as attachedFrom.
Reading states, comma separated, to keep files in them: not_read, reading, awaiting_confirmation, ready or failed; a photo is never awaiting_confirmation.
relevance, only with q, or attached; left out, relevance with q and attached without.
The order of the sort; left out, desc: newest first when sorted by attached.
How many files a page holds.
The cursor from the previous page's nextCursor; left out, the first page.
Response
200 The files found.
The files found, in the order asked.
Show properties of itemsHide properties of items
The file's project.
Show properties of projectHide properties of project
The project's id.
The id Werk's apps use for the key's person's view of the project.
The project's name.
The project's last step, the one that ends the work.
Show properties of finalStepHide properties of finalStep
The step's id.
The step's name.
The card the file is on.
Show properties of itemHide properties of item
completed when the card is on its project's last step, not_completed when it was archived before it, open otherwise.
The card's id.
The card's number as people write it, with # before it.
The card's title, as written.
The language the card's title and description are written in.
The title in the reader's language, when it is written in another.
Show properties of titleTranslationHide properties of titleTranslation
The reader's language the text is translated into.
ready when text holds the translation, pending while it is being made, failed when it could not be made, paused when no plan pays for translations now.
The translated text, present once ready.
The step the card is on, with where that step sits in the work.
Show properties of statusHide properties of status
The id of the step the card is on.
The step's name.
open on a new step, done on the project's last step, active on any other step.
The kind of step the card is on; a step that ends the work reads in_progress while it is not the project's last step.
The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.
The step's name in the reader's language, when it is written in another.
Show properties of labelTranslationHide properties of labelTranslation
The reader's language the text is translated into.
ready when text holds the translation, pending while it is being made, failed when it could not be made, paused when no plan pays for translations now.
The translated text, present once ready.
How long before the due date its holder and followers get the due notice; none sends no notice.
Who set the due moment; present only for a due date with a time.
Show properties of dueSetByHide properties of dueSetBy
That person's name.
The card's due date, or null when it has none.
Show properties of dueHide properties of due
One of 2 shapes, told apart by kind:
kinddatedate for a due day with no time, datetime for a due moment.
The due day, as YYYY-MM-DD.
kinddatetimedate for a due day with no time, datetime for a due moment.
The due moment, as an ISO 8601 date and time with its offset.
The time zone the due moment was given in, when known.
The card's holder, or null when the card is free.
Show properties of assigneeHide properties of assignee
The holder's person id.
The holder's name as the project shows it.
The holder's initials, for an avatar with no photo.
The holder's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
The card's version, which grows with every change to it.
The card's number in its project, unique there and never reused.
The card's step among its project's steps, as the project defines it.
Show properties of currentStepHide properties of currentStep
The step's id; a change of step sends it as stepId.
The step's name.
The kind of step: new for an open step, in_progress or waiting for one in between, resolved or closed for one that ends the work.
The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.
The step's name in the reader's language, when it is written in another.
Show properties of labelTranslationHide properties of labelTranslation
The reader's language the text is translated into.
ready when text holds the translation, pending while it is being made, failed when it could not be made, paused when no plan pays for translations now.
The translated text, present once ready.
True when the card is archived: it has left the working lists and stays readable and searchable.
How much the card holds.
Show properties of countsHide properties of counts
Photos on the card.
Updates on the card.
Documents on the card.
The card's list: its items checked and in all; absent when the card has no list.
Show properties of checklistHide properties of checklist
List items checked.
List items in all.
The changes the key's person may make to this card by hand now, by action name.
The file.
Show properties of fileHide properties of file
One of 2 shapes, told apart by kind:
kindphotophoto or document.
The update the file came with, or null for a file added to the card itself.
The photo, for a photo.
Show properties of photoHide properties of photo
The photo's id on the card; removing it names this id.
Who added the photo, or null when no longer known.
Show properties of attachedByHide properties of attachedBy
One of 3 shapes, told apart by kind:
kinduseruser for a person; connector or schedule for a change Werk made without one.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
The connected app or API key the change came through; absent for a change made in Werk's apps.
Show properties of viaHide properties of via
connection for an app connected by sign-in, key for an API key.
The app's or the key's name, as Werk shows it.
True when Werk verified the app's identity.
The caption Werk shows beside the change, in the reader's language.
kindconnectoruser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
kindscheduleuser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
The photo's file.
Show properties of assetHide properties of asset
The file's id.
What the file is: a photo, a voice recording or a document.
The document's name; only a document has one.
The document's format; only a document has one.
The file's media type.
The file's size in bytes.
The photo's width in pixels; absent on photos stored before sizes were kept.
The photo's height in pixels; absent on photos stored before sizes were kept.
The recording's length in seconds; only a voice recording has one.
False once the file's bytes were released and it can no longer be read.
When the photo was added to the card.
True when the key's person may take this photo off the card now.
What Werk read in the photo.
Show properties of readingHide properties of reading
ready once read, reading while Werk reads it, not_read when it will not be read, failed when reading failed.
What Werk sees in the photo, or null.
The text Werk read in the photo, or null.
kinddocumentphoto or document.
The update the file came with, or null for a file added to the card itself.
Who added the document, or null when no longer known.
Show properties of attachedByHide properties of attachedBy
One of 3 shapes, told apart by kind:
kinduseruser for a person; connector or schedule for a change Werk made without one.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
The connected app or API key the change came through; absent for a change made in Werk's apps.
Show properties of viaHide properties of via
connection for an app connected by sign-in, key for an API key.
The app's or the key's name, as Werk shows it.
True when Werk verified the app's identity.
The caption Werk shows beside the change, in the reader's language.
kindconnectoruser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
kindscheduleuser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
When the document was added.
The document, for a document.
Show properties of documentHide properties of document
The document's id.
The card the document is on.
The document's name.
The document's media type.
The document's revision, which grows each time its file is replaced.
not_read while it is not being read, awaiting_confirmation while Werk waits for a yes to its cost, reading, failed, or ready.
The document's version, which grows with every change to it; a read request sends it as expectedVersion.
How many parts the document has, or null while not known.
How many parts Werk read.
True when Werk read only the document's first parts.
Werk's summary of the document, or null.
The issuer, number, date, total and currency Werk read in the document, or null.
Show properties of fieldsHide properties of fields
The issuer Werk read in the document, or null when it found none.
Show properties of issuerHide properties of issuer
The issuer as read.
The part of the document it was read from.
Show properties of sourceHide properties of source
The document's id.
The revision it was read in.
The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.
The SHA-256 of the file it was read from.
Where in the file the part is.
Show properties of locationHide properties of location
One of 5 shapes, told apart by kind:
kindpdf_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The PDF page.
kindsectionWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The section, counted from 1.
kindparagraphWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The paragraph, counted from 1.
kindsheet_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The sheet's name.
The part's first row.
The part's last row.
kindlinesWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The part's first line.
The part's last line.
The document's number Werk read in the document, or null when it found none.
Show properties of numberHide properties of number
The document's number as read.
The part of the document it was read from.
Show properties of sourceHide properties of source
The document's id.
The revision it was read in.
The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.
The SHA-256 of the file it was read from.
Where in the file the part is.
Show properties of locationHide properties of location
One of 5 shapes, told apart by kind:
kindpdf_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The PDF page.
kindsectionWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The section, counted from 1.
kindparagraphWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The paragraph, counted from 1.
kindsheet_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The sheet's name.
The part's first row.
The part's last row.
kindlinesWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The part's first line.
The part's last line.
The date Werk read in the document, or null when it found none.
Show properties of dateHide properties of date
The date as read, as YYYY-MM-DD.
The part of the document it was read from.
Show properties of sourceHide properties of source
The document's id.
The revision it was read in.
The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.
The SHA-256 of the file it was read from.
Where in the file the part is.
Show properties of locationHide properties of location
One of 5 shapes, told apart by kind:
kindpdf_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The PDF page.
kindsectionWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The section, counted from 1.
kindparagraphWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The paragraph, counted from 1.
kindsheet_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The sheet's name.
The part's first row.
The part's last row.
kindlinesWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The part's first line.
The part's last line.
The total Werk read in the document, or null when it found none.
Show properties of totalHide properties of total
The total as read, a decimal number with a point.
The part of the document it was read from.
Show properties of sourceHide properties of source
The document's id.
The revision it was read in.
The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.
The SHA-256 of the file it was read from.
Where in the file the part is.
Show properties of locationHide properties of location
One of 5 shapes, told apart by kind:
kindpdf_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The PDF page.
kindsectionWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The section, counted from 1.
kindparagraphWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The paragraph, counted from 1.
kindsheet_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The sheet's name.
The part's first row.
The part's last row.
kindlinesWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The part's first line.
The part's last line.
The currency Werk read in the document, or null when it found none.
Show properties of currencyHide properties of currency
The currency as read, its ISO 4217 code.
The part of the document it was read from.
Show properties of sourceHide properties of source
The document's id.
The revision it was read in.
The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.
The SHA-256 of the file it was read from.
Where in the file the part is.
Show properties of locationHide properties of location
One of 5 shapes, told apart by kind:
kindpdf_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The PDF page.
kindsectionWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The section, counted from 1.
kindparagraphWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The paragraph, counted from 1.
kindsheet_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The sheet's name.
The part's first row.
The part's last row.
kindlinesWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The part's first line.
The part's last line.
Why reading failed, or null.
What reading the document counts on the plan, in messages, or null before Werk inspected it.
A PDF's pages, or other text in pages of 3,000 characters; null when not known.
A workbook's sheets with data; null for other files or when not known.
True when the key's person may take this document off the card now.
With words, how the file was found: by its words, by meaning, or both; empty without words.
With words, where in the file they matched.
Show properties of matchesHide properties of matches
One of 2 shapes, told apart by in:
innamedescriptiontextsummaryWhere it matched: a document's name, Werk's description of a photo, the text Werk read in a photo, Werk's summary of a document, or a part of a document.
inpagesWhere it matched: a document's name, Werk's description of a photo, the text Werk read in a photo, Werk's summary of a document, or a part of a document.
For a part of a document, the part, counted from 1.
For a part of a document, where it is in the file.
Show properties of locationHide properties of location
One of 5 shapes, told apart by kind:
kindpdf_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The PDF page.
kindsectionWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The section, counted from 1.
kindparagraphWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The paragraph, counted from 1.
kindsheet_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The sheet's name.
The part's first row.
The part's last row.
kindlinesWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The part's first line.
The part's last line.
For a part of a document, the start of the text that matched.
How many files match in all, past this page included.
False when the search read as deep as it goes, so more files may match than total says.
With words, how many files that pass the other filters are not read yet, or read only in part; null without words.
With words, true when the search also looked by meaning; null without words.
The cursor that reads the next page as after, or null when none remains.
Errors
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).invalid_card_query The request about cards or their files is not in the form its route takes, or names a day of a filter while the signed-in person's profile has no time zone; 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).session_revoked The request carries no session the server holds, or its session has ended.session_expired The session has expired.conversation_not_found The project the request names, or its chat, is not one the signed-in person is in.item_not_found The card the request names, or its list, is not one the signed-in person can see.session_changed The session changed while the request was in flight.cursor_expired The page cursor no longer fits the list as it stands or the arguments it was read with.project_profile_changed The project's setup changed while the cards were read.rate_limited More requests of this kind were sent than Werk takes within the time it counts them over.server_error The server could not complete the request, and it is not known whether a write it holds was made.curl "https://api.getwerk.ai/api/v1/files?q=faucet&kind=photo" \
-H "Authorization: Bearer wk_key_..."const res = await fetch("https://api.getwerk.ai/api/v1/files?q=faucet&kind=photo", {
headers: {
Authorization: "Bearer wk_key_...",
},
});
const answer = await res.json();{
"items": [
{
"project": {
"projectId": "2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73",
"conversationId": "9e3b1c75-4f2a-4d86-b0c9-5a7e2d1f8c36",
"name": "Harbor Street kitchen",
"finalStep": {
"id": "paid",
"label": "Paid"
}
},
"item": {
"outcome": "open",
"id": "1a7d3f92-6b4e-4c15-8e2a-9f0c5b7d3e81",
"ref": "#12",
"title": "Replace the leaking sink faucet",
"language": "en-US",
"status": {
"key": "waiting_parts",
"label": "Waiting for parts",
"category": "active",
"bucket": "waiting"
},
"dueNoticeLead": "at_due",
"due": null,
"assignee": {
"personId": "8a2e6c14-3f5d-4b9a-a7e2-61c0d9f4b3e8",
"displayName": "Tom Okafor",
"initials": "TO"
},
"version": 4,
"number": 12,
"currentStep": {
"id": "waiting_parts",
"label": "Waiting for parts",
"bucket": "waiting"
},
"archived": false,
"counts": {
"photos": 1,
"updates": 1,
"documents": 0
}
},
"file": {
"kind": "photo",
"updateId": "c9a3e7f1-4d6b-4f80-a2c8-5b1e9d3f7a46",
"photo": {
"id": "b8f2d6a4-3e1c-4b79-9d05-6a3e8c2f1b97",
"attachedBy": {
"kind": "user",
"displayName": "Tom Okafor",
"initials": "TO",
"isViewer": false
},
"asset": {
"id": "f3a9c1e7-5b2d-4c68-a4e0-9d7b3f1c5e82",
"kind": "image",
"mimeType": "image/jpeg",
"sizeBytes": 482113,
"width": 1600,
"height": 1200
},
"attachedAt": "2026-11-19T16:12:00.000Z",
"removable": true
},
"reading": {
"state": "ready",
"description": "A chrome kitchen faucet with a cracked base, under a stainless sink.",
"text": null
}
},
"foundBy": [
"words",
"meaning"
],
"matches": [
{
"in": "description"
}
]
}
],
"total": 1,
"complete": true,
"unread": 0,
"byMeaning": true,
"nextCursor": null
}Send a requestGET
It is sent with the key you give, as you. A change made here is real.
The request could not be sent, or its response could not be read.