Upload a file (subject to change)

Stores a file and returns its Ketryx ID. The file is inert until a capability-guarded call consumes it, such as POST /projects/{projectId}/items/documents. Maximum file size is 300 MB by default (configurable).

post/projects/{projectId}/uploads

Request

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

Request body multipart/form-data

filestring binary

Response

File uploaded successfully

idstring required

Ketryx ID of the uploaded file

filenamestring required

Filename the file was uploaded under

contentTypestring required

MIME type of the uploaded file

sizeBytesinteger required

File size in bytes

Example response

{
  "id": "KXUPF1GGK0R03458B8VK6R8S7SKCQSV",
  "filename": "quality-manual.pdf",
  "contentType": "application/pdf"
}

Changes

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