DevelopersHow to connect an assistantKeys
Reference/Files/Read

Get a card's file

GEThttps://api.getwerk.ai/api/v1/projects/{projectId}/cards/{cardId}/files/{fileId}

One photo or document on a card, with what Werk read in it.

A photo is named by its id on the card, a document by its own id.

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.

Path parameters

projectIdstring, uuidRequired

The project's id.

cardIdstring, uuidRequired

The card's id.

fileIdstring, uuidRequired

The photo's or the document's id.

Response

200 The file.

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.

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).
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.
404asset_not_foundThe file the request names is not one the signed-in person can reach where the request names it, or is no longer available.
409session_changedThe session changed while the request was in flight.
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/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/cards/1a7d3f92-6b4e-4c15-8e2a-9f0c5b7d3e81/files/b8f2d6a4-3e1c-4b79-9d05-6a3e8c2f1b97" \
  -H "Authorization: Bearer wk_key_..."
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/cards/1a7d3f92-6b4e-4c15-8e2a-9f0c5b7d3e81/files/b8f2d6a4-3e1c-4b79-9d05-6a3e8c2f1b97", {
  headers: {
    Authorization: "Bearer wk_key_...",
  },
});
const answer = await res.json();
200JSON
{
  "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
    }
  }
}