Files

Complete a file upload

post

Confirms a completed direct upload and returns the file-type field value. Pass documentId, documentVersionId, and uploadId from the generate-upload-url step, and the etags S3 returned for each uploaded part. The returned object is the complete field value — pass it as-is when creating/updating a record.

Autorisierungen

AuthorizationstringErforderlich

Enter your Workspace API key.

API keys can be generated and managed within the Workspace Integration settings in the Ninox app.

Pfadparameter

workspaceIdstring · min: 12 · max: 12Erforderlich

Workspace ID

Example: 5rdco4s18swuPattern: ^[a-z0-9]+$

Body

contentTypestring · min: 1Erforderlich

MIME type of the uploaded file

documentIdstring · min: 12 · max: 12Erforderlich

documentId returned by the generate-upload-url step

Pattern: ^[a-z0-9]+$

documentVersionIdstring · min: 12 · max: 12Erforderlich

documentVersionId returned by the generate-upload-url step

Pattern: ^[a-z0-9]+$

etagsstring[] · min: 1Erforderlich

ETag returned by S3 for each uploaded part, in order

fileNamestring · min: 1Erforderlich

Original file name

fileSizeinteger · max: 9007199254740991Erforderlich

File size in bytes

uploadIdstring · min: 1Erforderlich

uploadId returned by the generate-upload-url step

Antworten

201

Upload completed successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

404

Workspace not found

application/json

507

Storage quota exceeded

application/json

post/api/v1/workspace/{workspaceId}/files/complete

POST /api/v1/workspace/{workspaceId}/files/complete HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "contentType": "text",
  "documentId": "text",
  "documentVersionId": "text",
  "etags": [
    "text"
  ],
  "fileName": "text",
  "fileSize": 1,
  "uploadId": "text"
}

{
  "data": {
    "documentId": "text",
    "documentVersionId": "text",
    "fileName": "text",
    "fileSize": 1,
    "fileType": "text"
  }
}

Start a file upload (get presigned URLs)

post

Generates presigned URLs for uploading a file directly to storage — the first step of a file-type field upload. Upload the file bytes directly to the returned URL(s) (one per part), then call .../files/complete with the resulting ETags to finish. This never sends file bytes through this API.

Autorisierungen

AuthorizationstringErforderlich

Enter your Workspace API key.

API keys can be generated and managed within the Workspace Integration settings in the Ninox app.

Pfadparameter

workspaceIdstring · min: 12 · max: 12Erforderlich

Workspace ID

Example: 5rdco4s18swuPattern: ^[a-z0-9]+$

Body

contentTypestring · min: 1Erforderlich

MIME type of the file being uploaded

partsinteger · min: 1 · max: 10000Erforderlich

Number of multipart upload parts (1 for a single-part upload, max 10,000 per S3 limits)

Antworten

201

Presigned upload URLs generated successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

404

Workspace not found

application/json

post/api/v1/workspace/{workspaceId}/files/upload-url

POST /api/v1/workspace/{workspaceId}/files/upload-url HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "contentType": "text",
  "parts": 1
}

{
  "data": {
    "documentId": "text",
    "documentVersionId": "text",
    "preSignedUrls": [
      "text"
    ],
    "uploadId": "text"
  }
}

Upload a file to a record

post

Uploads a file and attaches it to a record in a single multipart/form-data request, with the file in the file form field, like the Ninox 3 files endpoint. No presigned URL or complete step is needed. The returned object can also be stored in a file-type field (max. 50 MB).

Autorisierungen

AuthorizationstringErforderlich

Enter your Workspace API key.

API keys can be generated and managed within the Workspace Integration settings in the Ninox app.

Pfadparameter

moduleNamestring · min: 1Erforderlich

Module name

recordIdinteger · max: 9007199254740991Erforderlich

Record ID

Example: 1

tableNamestring · min: 1Erforderlich

Table name

workspaceIdstring · min: 12 · max: 12Erforderlich

Workspace ID

Example: 5rdco4s18swuPattern: ^[a-z0-9]+$

Body

filestring · binaryErforderlich

Antworten

201

File uploaded and attached

application/json

400

Bad request (missing file, etc.)

application/json

401

Unauthorized

application/json

404

Workspace, table or record not found

application/json

413

File too large (max 50 MB)

application/json

507

Storage quota exceeded

application/json

post/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/records/{recordId}/files

POST /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/records/{recordId}/files HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "data": {
    "documentId": "text",
    "documentVersionId": "text",
    "fileName": "text",
    "fileSize": 1,
    "fileType": "text"
  }
}