Items

Upload a file attachment to an item

Uploads a file to an existing item, creating a new versioned item record with the attachment. The item can be identified by its Ketryx ID or sourceId. Maximum file size is 500 MB by default (configurable). The file stays on later records until removed with DELETE. Approvals follow the project's invalidation settings.

post/projects/{projectId}/items/{itemId}/attachments

Request

Base URL
https://app.ketryx.com/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ketryx/apis/ketryx-api/docs/projects/:projectId/items/:itemId/attachments/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body multipart/form-data

filestring binary

Response

Attachment uploaded successfully

idstring required

Ketryx ID of the uploaded file

attachmentIdstring required

Ketryx ID of the attachment, as listed and removed by the other attachment operations

filenamestring required

Original filename of the uploaded file

contentTypestring required

MIME type of the uploaded file

sizeBytesinteger required

File size in bytes

urlstring required

URL to download the uploaded file

itemRecordIdstring required

Ketryx ID of the newly created item record

Example response

{
  "id": "KXUPF1GGK0R03458B8VK6R8S7SKCQSV",
  "attachmentId": "KXEXR01M4T80JJZE84A86ZQBYGK2ZET",
  "filename": "screenshot.png",
  "contentType": "image/png",
  "url": "https://app.ketryx.com/api/projects/KXPRJ.../files/KXUPF...",
  "itemRecordId": "KXREC2AVTG0CEEA83MVPCG00XH2KXRB"
}

Changes

No recorded changes to this operation across all 1 revision of this API.