REST API Reference

Base URL: https://api.nomiastorage.com/v1

Authentication

All API requests must include a bearer token in the Authorization header. You can generate API keys from your workspace settings. Keys are workspace-scoped and can be granted read-only or read-write access.

curl https://api.nomiastorage.com/v1/files \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxx"

API keys are prefixed sk_live_ for production and sk_test_ for sandbox. Test keys are rate-limited but free to use.

Rate limits

Rate limits apply per API key. When a limit is exceeded the API returns HTTP 429 with a Retry-After header indicating when you can retry.

Plan Read operations Write operations Upload throughput
Starter300 req/min60 req/min1 GB/hr
Pro1,200 req/min300 req/min10 GB/hr
Business6,000 req/min1,200 req/min100 GB/hr
EnterpriseCustomCustomCustom

Errors

All errors follow a consistent JSON shape. The code field is machine-readable; message is for humans.

{
  "error": {
    "code": "file_not_found",
    "message": "No file with id 'fil_xyz' exists in this workspace.",
    "request_id": "req_01hxyz..."
  }
}

Files

MethodPathDescription
GET/filesList files in a workspace or folder
POST/filesInitiate a multipart upload
GET/files/{id}Retrieve file metadata
GET/files/{id}/contentDownload file content
PUT/files/{id}Update file name or metadata
DELETE/files/{id}Delete a file (moved to trash)
POST/files/{id}/copyCopy a file to another folder

Folders

MethodPathDescription
GET/foldersList top-level folders
POST/foldersCreate a folder
GET/folders/{id}Get folder metadata and contents
PUT/folders/{id}Rename or move a folder
DELETE/folders/{id}Delete a folder and its contents

Sharing

MethodPathDescription
POST/sharesCreate a share link for a file or folder
GET/shares/{id}Get share link details
PUT/shares/{id}Update expiry or password
DELETE/shares/{id}Revoke a share link

Webhooks

Nomia delivers signed POST requests to your endpoint when events occur. Verify the Nomia-Signature header to authenticate each delivery.

MethodPathDescription
GET/webhooksList registered webhook endpoints
POST/webhooksRegister a new webhook endpoint
DELETE/webhooks/{id}Delete a webhook endpoint

Client libraries

Official SDKs are maintained by Nomia and kept in sync with the API. All are open-source under MIT.