DevelopersHow to connect an assistantKeys
Reference/Files/Read

Search files

GEThttps://api.getwerk.ai/api/v1/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

AuthorizationheaderRequired

Authorization: Bearer <key> Authentication

Headers

Werk-Localestring

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

qstring

The words to look for; left out, files are listed by the other filters.

From 1 to 200 characters
instring

Where to look for the words, comma separated: name, description, text, summary, pages; left out, everywhere.

projectsstring

Project ids, comma separated; left out, every project of the key's person.

cardstring, uuid

A card's id, to keep that card's files only.

kindenum

Keeps files of one kind only.

Allowed valuesphotodocument
attachedBystring, uuid

A person's id, to keep the files they added.

attachedFromstring, date or string, date-time

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.

attachedBeforestring, date or string, date-time

Keeps files added before this day or moment, in the same forms as attachedFrom.

readingstring

Reading states, comma separated, to keep files in them: not_read, reading, awaiting_confirmation, ready or failed; a photo is never awaiting_confirmation.

sortenum

relevance, only with q, or attached; left out, relevance with q and attached without.

Allowed valuesrelevanceattached
orderenum

The order of the sort; left out, desc: newest first when sorted by attached.

Allowed valuesascdesc
limitinteger

How many files a page holds.

From 1 to 100
Default50
afterstring

The cursor from the previous page's nextCursor; left out, the first page.

From 1 to 512 characters

Response

200 The files found.

itemsarray of objects

The files found, in the order asked.

Up to 100 items
Show properties of itemsHide properties of items
projectobject

The file's project.

Show properties of projectHide properties of project
projectIdstring, uuid

The project's id.

conversationIdstring, uuid

The id Werk's apps use for the key's person's view of the project.

namestring

The project's name.

finalStepobject

The project's last step, the one that ends the work.

Show properties of finalStepHide properties of finalStep
idstring

The step's id.

labelstring

The step's name.

itemobject

The card the file is on.

Show properties of itemHide properties of item
outcomeenum

completed when the card is on its project's last step, not_completed when it was archived before it, open otherwise.

Allowed valuesopencompletednot_completed
idstring, uuid

The card's id.

refstring or null

The card's number as people write it, with # before it.

titlestring

The card's title, as written.

languagestring or null

The language the card's title and description are written in.

titleTranslationobject

The title in the reader's language, when it is written in another.

Show properties of titleTranslationHide properties of titleTranslation
languagestring

The reader's language the text is translated into.

From 2 to 64 characters
stateenum

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.

Allowed valuesreadypendingfailedpaused
textstring

The translated text, present once ready.

statusobject

The step the card is on, with where that step sits in the work.

Show properties of statusHide properties of status
keystring

The id of the step the card is on.

At least 1 character
labelstring

The step's name.

At least 1 character
categoryenum

open on a new step, done on the project's last step, active on any other step.

Allowed valuesopenactivedone
bucketenum

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.

Allowed valuesnewin_progresswaitingresolvedclosed
labelLanguagestring

The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.

From 2 to 64 characters
labelTranslationobject

The step's name in the reader's language, when it is written in another.

Show properties of labelTranslationHide properties of labelTranslation
languagestring

The reader's language the text is translated into.

From 2 to 64 characters
stateenum

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.

Allowed valuesreadypendingfailedpaused
textstring

The translated text, present once ready.

dueNoticeLeadenum

How long before the due date its holder and followers get the due notice; none sends no notice.

Allowed valuesnoneat_due15_minutes1_hour2_hours1_day2_days
dueSetByobject or null

Who set the due moment; present only for a due date with a time.

Show properties of dueSetByHide properties of dueSetBy
displayNamestring

That person's name.

dueobject or null

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:

kinddate
kindenum

date for a due day with no time, datetime for a due moment.

Allowed valuesdate
datestring, date

The due day, as YYYY-MM-DD.

kinddatetime
kindenum

date for a due day with no time, datetime for a due moment.

Allowed valuesdatetime
atstring, date-time

The due moment, as an ISO 8601 date and time with its offset.

enteredTimeZonestring or null

The time zone the due moment was given in, when known.

assigneeobject or null

The card's holder, or null when the card is free.

Show properties of assigneeHide properties of assignee
personIdstring, uuid

The holder's person id.

displayNamestring

The holder's name as the project shows it.

initialsstring

The holder's initials, for an avatar with no photo.

photoobject

The holder's photo, when they have one.

Show properties of photoHide properties of photo
personIdstring, uuid

The person whose photo it is.

versioninteger

The photo's version, which changes with the photo; its read takes it to fetch the current one.

At least 1
versioninteger

The card's version, which grows with every change to it.

At least 1
numberinteger or null

The card's number in its project, unique there and never reused.

At least 1
currentStepobject or null

The card's step among its project's steps, as the project defines it.

Show properties of currentStepHide properties of currentStep
idstring

The step's id; a change of step sends it as stepId.

At least 1 character
labelstring

The step's name.

At least 1 character
bucketenum

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.

Allowed valuesnewin_progresswaitingresolvedclosed
labelLanguagestring

The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.

From 2 to 64 characters
labelTranslationobject

The step's name in the reader's language, when it is written in another.

Show properties of labelTranslationHide properties of labelTranslation
languagestring

The reader's language the text is translated into.

From 2 to 64 characters
stateenum

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.

Allowed valuesreadypendingfailedpaused
textstring

The translated text, present once ready.

archivedboolean

True when the card is archived: it has left the working lists and stays readable and searchable.

countsobject

How much the card holds.

Show properties of countsHide properties of counts
photosinteger

Photos on the card.

At least 0
updatesinteger

Updates on the card.

At least 0
documentsinteger

Documents on the card.

At least 0
checklistobject

The card's list: its items checked and in all; absent when the card has no list.

Show properties of checklistHide properties of checklist
doneinteger

List items checked.

At least 0
totalinteger

List items in all.

At least 0
allowedActionsarray of enums

The changes the key's person may make to this card by hand now, by action name.

Allowed valuestake_cardassign_cardgive_back_cardmove_cardarchive_cardunarchive_cardedit_cardset_card_dueadd_updatecreate_reminderlink_duplicateadd_entriesrename_entryremove_entryreorder_entriesfollow_cardunfollow_cardfollow_invitationtick_entryuntick_entryset_due_notice
fileobject

The file.

Show properties of fileHide properties of file

One of 2 shapes, told apart by kind:

kindphoto
kindenum

photo or document.

Allowed valuesphoto
updateIdstring, uuid or null

The update the file came with, or null for a file added to the card itself.

photoobject

The photo, for a photo.

Show properties of photoHide properties of photo
idstring, uuid

The photo's id on the card; removing it names this id.

attachedByobject or null

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:

kinduser
kindenum

user for a person; connector or schedule for a change Werk made without one.

Allowed valuesuser
displayNamestring

The person's name as the project shows it.

At least 1 character
initialsstring

The person's initials, for an avatar with no photo.

isViewerboolean

True when the person is the key's own person.

photoobject

The person's photo, when they have one.

Show properties of photoHide properties of photo
personIdstring, uuid

The person whose photo it is.

versioninteger

The photo's version, which changes with the photo; its read takes it to fetch the current one.

At least 1
viaobject

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
kindenum

connection for an app connected by sign-in, key for an API key.

Allowed valuesconnectionkey
namestring

The app's or the key's name, as Werk shows it.

At least 1 character
verifiedboolean

True when Werk verified the app's identity.

labelstring

The caption Werk shows beside the change, in the reader's language.

At least 1 character
kindconnector
kindenum

user for a person; connector or schedule for a change Werk made without one.

Allowed valuesconnector
labelstring

The name Werk shows for a change made without a person.

At least 1 character
kindschedule
kindenum

user for a person; connector or schedule for a change Werk made without one.

Allowed valuesschedule
labelstring

The name Werk shows for a change made without a person.

At least 1 character
assetobject

The photo's file.

Show properties of assetHide properties of asset
idstring, uuid

The file's id.

kindenum

What the file is: a photo, a voice recording or a document.

Allowed valuesimage
filenamestring

The document's name; only a document has one.

From 1 to 255 characters
formatenum

The document's format; only a document has one.

Allowed valuespdfdocxxlsxcsvtxtmd
mimeTypestring

The file's media type.

At least 1 character
sizeBytesinteger

The file's size in bytes.

At least 0
widthinteger

The photo's width in pixels; absent on photos stored before sizes were kept.

At least 1
heightinteger

The photo's height in pixels; absent on photos stored before sizes were kept.

At least 1
durationSecondsnumber

The recording's length in seconds; only a voice recording has one.

More than 0, up to 300
availableboolean

False once the file's bytes were released and it can no longer be read.

attachedAtstring, date-time

When the photo was added to the card.

removableboolean

True when the key's person may take this photo off the card now.

readingobject

What Werk read in the photo.

Show properties of readingHide properties of reading
stateenum

ready once read, reading while Werk reads it, not_read when it will not be read, failed when reading failed.

Allowed valuesreadyreadingnot_readfailed
descriptionstring or null

What Werk sees in the photo, or null.

Up to 800 characters
textstring or null

The text Werk read in the photo, or null.

Up to 4000 characters
kinddocument
kindenum

photo or document.

Allowed valuesdocument
updateIdstring, uuid or null

The update the file came with, or null for a file added to the card itself.

attachedByobject or null

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:

kinduser
kindenum

user for a person; connector or schedule for a change Werk made without one.

Allowed valuesuser
displayNamestring

The person's name as the project shows it.

At least 1 character
initialsstring

The person's initials, for an avatar with no photo.

isViewerboolean

True when the person is the key's own person.

photoobject

The person's photo, when they have one.

Show properties of photoHide properties of photo
personIdstring, uuid

The person whose photo it is.

versioninteger

The photo's version, which changes with the photo; its read takes it to fetch the current one.

At least 1
viaobject

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
kindenum

connection for an app connected by sign-in, key for an API key.

Allowed valuesconnectionkey
namestring

The app's or the key's name, as Werk shows it.

At least 1 character
verifiedboolean

True when Werk verified the app's identity.

labelstring

The caption Werk shows beside the change, in the reader's language.

At least 1 character
kindconnector
kindenum

user for a person; connector or schedule for a change Werk made without one.

Allowed valuesconnector
labelstring

The name Werk shows for a change made without a person.

At least 1 character
kindschedule
kindenum

user for a person; connector or schedule for a change Werk made without one.

Allowed valuesschedule
labelstring

The name Werk shows for a change made without a person.

At least 1 character
attachedAtstring, date-time

When the document was added.

documentobject

The document, for a document.

Show properties of documentHide properties of document
idstring, uuid

The document's id.

itemIdstring, uuid

The card the document is on.

filenamestring

The document's name.

From 1 to 255 characters
mimeTypeenum

The document's media type.

Allowed valuesapplication/pdfapplication/vnd.openxmlformats-officedocument.wordprocessingml.documentapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheettext/csvtext/plaintext/markdown
revisioninteger

The document's revision, which grows each time its file is replaced.

At least 1
stateenum

not_read while it is not being read, awaiting_confirmation while Werk waits for a yes to its cost, reading, failed, or ready.

Allowed valuesnot_readawaiting_confirmationreadingfailedready
versioninteger

The document's version, which grows with every change to it; a read request sends it as expectedVersion.

At least 1
totalSourcesinteger or null

How many parts the document has, or null while not known.

At least 0
readSourcesinteger

How many parts Werk read.

At least 0
truncatedboolean

True when Werk read only the document's first parts.

summarystring or null

Werk's summary of the document, or null.

From 1 to 2000 characters
fieldsobject or null

The issuer, number, date, total and currency Werk read in the document, or null.

Show properties of fieldsHide properties of fields
issuerobject or null

The issuer Werk read in the document, or null when it found none.

Show properties of issuerHide properties of issuer
valuestring

The issuer as read.

From 1 to 512 characters
sourceobject

The part of the document it was read from.

Show properties of sourceHide properties of source
documentIdstring

The document's id.

At least 1 character
revisioninteger

The revision it was read in.

At least 1
pageinteger

The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.

At least 1
sha256string

The SHA-256 of the file it was read from.

locationobject

Where in the file the part is.

Show properties of locationHide properties of location

One of 5 shapes, told apart by kind:

kindpdf_page
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuespdf_page
pageinteger

The PDF page.

At least 1
kindsection
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessection
sectioninteger

The section, counted from 1.

At least 1
kindparagraph
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuesparagraph
paragraphinteger

The paragraph, counted from 1.

At least 1
kindsheet_rows
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessheet_rows
sheetstring

The sheet's name.

At least 1 character
firstRowinteger

The part's first row.

At least 1
lastRowinteger

The part's last row.

At least 1
kindlines
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valueslines
firstLineinteger

The part's first line.

At least 1
lastLineinteger

The part's last line.

At least 1
numberobject or null

The document's number Werk read in the document, or null when it found none.

Show properties of numberHide properties of number
valuestring

The document's number as read.

From 1 to 128 characters
sourceobject

The part of the document it was read from.

Show properties of sourceHide properties of source
documentIdstring

The document's id.

At least 1 character
revisioninteger

The revision it was read in.

At least 1
pageinteger

The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.

At least 1
sha256string

The SHA-256 of the file it was read from.

locationobject

Where in the file the part is.

Show properties of locationHide properties of location

One of 5 shapes, told apart by kind:

kindpdf_page
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuespdf_page
pageinteger

The PDF page.

At least 1
kindsection
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessection
sectioninteger

The section, counted from 1.

At least 1
kindparagraph
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuesparagraph
paragraphinteger

The paragraph, counted from 1.

At least 1
kindsheet_rows
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessheet_rows
sheetstring

The sheet's name.

At least 1 character
firstRowinteger

The part's first row.

At least 1
lastRowinteger

The part's last row.

At least 1
kindlines
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valueslines
firstLineinteger

The part's first line.

At least 1
lastLineinteger

The part's last line.

At least 1
dateobject or null

The date Werk read in the document, or null when it found none.

Show properties of dateHide properties of date
valuestring, date

The date as read, as YYYY-MM-DD.

sourceobject

The part of the document it was read from.

Show properties of sourceHide properties of source
documentIdstring

The document's id.

At least 1 character
revisioninteger

The revision it was read in.

At least 1
pageinteger

The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.

At least 1
sha256string

The SHA-256 of the file it was read from.

locationobject

Where in the file the part is.

Show properties of locationHide properties of location

One of 5 shapes, told apart by kind:

kindpdf_page
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuespdf_page
pageinteger

The PDF page.

At least 1
kindsection
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessection
sectioninteger

The section, counted from 1.

At least 1
kindparagraph
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuesparagraph
paragraphinteger

The paragraph, counted from 1.

At least 1
kindsheet_rows
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessheet_rows
sheetstring

The sheet's name.

At least 1 character
firstRowinteger

The part's first row.

At least 1
lastRowinteger

The part's last row.

At least 1
kindlines
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valueslines
firstLineinteger

The part's first line.

At least 1
lastLineinteger

The part's last line.

At least 1
totalobject or null

The total Werk read in the document, or null when it found none.

Show properties of totalHide properties of total
valuestring

The total as read, a decimal number with a point.

Up to 128 characters
sourceobject

The part of the document it was read from.

Show properties of sourceHide properties of source
documentIdstring

The document's id.

At least 1 character
revisioninteger

The revision it was read in.

At least 1
pageinteger

The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.

At least 1
sha256string

The SHA-256 of the file it was read from.

locationobject

Where in the file the part is.

Show properties of locationHide properties of location

One of 5 shapes, told apart by kind:

kindpdf_page
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuespdf_page
pageinteger

The PDF page.

At least 1
kindsection
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessection
sectioninteger

The section, counted from 1.

At least 1
kindparagraph
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuesparagraph
paragraphinteger

The paragraph, counted from 1.

At least 1
kindsheet_rows
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessheet_rows
sheetstring

The sheet's name.

At least 1 character
firstRowinteger

The part's first row.

At least 1
lastRowinteger

The part's last row.

At least 1
kindlines
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valueslines
firstLineinteger

The part's first line.

At least 1
lastLineinteger

The part's last line.

At least 1
currencyobject or null

The currency Werk read in the document, or null when it found none.

Show properties of currencyHide properties of currency
valuestring

The currency as read, its ISO 4217 code.

sourceobject

The part of the document it was read from.

Show properties of sourceHide properties of source
documentIdstring

The document's id.

At least 1 character
revisioninteger

The revision it was read in.

At least 1
pageinteger

The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.

At least 1
sha256string

The SHA-256 of the file it was read from.

locationobject

Where in the file the part is.

Show properties of locationHide properties of location

One of 5 shapes, told apart by kind:

kindpdf_page
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuespdf_page
pageinteger

The PDF page.

At least 1
kindsection
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessection
sectioninteger

The section, counted from 1.

At least 1
kindparagraph
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuesparagraph
paragraphinteger

The paragraph, counted from 1.

At least 1
kindsheet_rows
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessheet_rows
sheetstring

The sheet's name.

At least 1 character
firstRowinteger

The part's first row.

At least 1
lastRowinteger

The part's last row.

At least 1
kindlines
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valueslines
firstLineinteger

The part's first line.

At least 1
lastLineinteger

The part's last line.

At least 1
failureCodeenum or null

Why reading failed, or null.

Allowed valuesparse_failedencryptedunsupported_formattranscription_failedsummary_failedinvalid_outputaccess_lostlimit_exceededprovider_unavailable
unitsinteger or null

What reading the document counts on the plan, in messages, or null before Werk inspected it.

At least 1
pagesinteger or null

A PDF's pages, or other text in pages of 3,000 characters; null when not known.

At least 1
sheetsinteger or null

A workbook's sheets with data; null for other files or when not known.

At least 1
removableboolean

True when the key's person may take this document off the card now.

foundByarray of enums

With words, how the file was found: by its words, by meaning, or both; empty without words.

Allowed valueswordsmeaning
Up to 2 items
matchesarray of objects

With words, where in the file they matched.

Show properties of matchesHide properties of matches

One of 2 shapes, told apart by in:

innamedescriptiontextsummary
inenum

Where 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.

Allowed valuesnamedescriptiontextsummary
inpages
inenum

Where 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.

Allowed valuespages
pageinteger

For a part of a document, the part, counted from 1.

At least 1
locationobject

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_page
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuespdf_page
pageinteger

The PDF page.

At least 1
kindsection
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessection
sectioninteger

The section, counted from 1.

At least 1
kindparagraph
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuesparagraph
paragraphinteger

The paragraph, counted from 1.

At least 1
kindsheet_rows
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessheet_rows
sheetstring

The sheet's name.

At least 1 character
firstRowinteger

The part's first row.

At least 1
lastRowinteger

The part's last row.

At least 1
kindlines
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valueslines
firstLineinteger

The part's first line.

At least 1
lastLineinteger

The part's last line.

At least 1
textstring

For a part of a document, the start of the text that matched.

totalinteger

How many files match in all, past this page included.

At least 0
completeboolean

False when the search read as deep as it goes, so more files may match than total says.

unreadinteger or null

With words, how many files that pass the other filters are not read yet, or read only in part; null without words.

At least 0
byMeaningboolean or null

With words, true when the search also looked by meaning; null without words.

nextCursorstring or null

The cursor that reads the next page as after, or null when none remains.

From 1 to 512 characters

Errors

400invalid_queryThe 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).
400invalid_card_queryThe 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).
401session_revokedThe request carries no session the server holds, or its session has ended.
401session_expiredThe session has expired.
404conversation_not_foundThe project the request names, or its chat, is not one the signed-in person is in.
404item_not_foundThe card the request names, or its list, is not one the signed-in person can see.
409session_changedThe session changed while the request was in flight.
409cursor_expiredThe page cursor no longer fits the list as it stands or the arguments it was read with.
409project_profile_changedThe project's setup changed while the cards were read.
rate_limitedMore requests of this kind were sent than Werk takes within the time it counts them over.
500server_errorThe 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/files?q=faucet&kind=photo" \
  -H "Authorization: Bearer wk_key_..."
TypeScript
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();
200JSON
{
  "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
}