Upload a public file

POST

files

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.files.create({ content: "…", contentType: "image/png", filename: "logo.png" });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "contentType": "image/png",
  "filename": "logo.png",
  "id": "fil_y3rgwmhkbgxxa2qzmfyrdj0e",
  "object": "file",
  "size": 24680,
  "url": "https://files.norbelys.com/files/org_x/fil_y/logo.png"
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Org-scoped Norbelys API key. Create one in Settings → API keys and send it as Authorization: Bearer ak_….

Headers

Idempotency-Key

string

Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Maximum string length: 255

Body

application/json

content

string

required

Base64-encoded file content (max 8 MB decoded). Example: iVBORw0KGgoAAAANSUhEUgAA…

Minimum string length: 1

contentType

string

required

MIME type — an image/* type or application/pdf. Example: image/png

Pattern: ^(?:image\/[\w.+-]+|application\/pdf)$

Example:

"image/png"

filename

string

required

Original file name — kept (sanitized) as the URL's last segment. Example: logo.png

Required string length: 1 - 200

Example:

"logo.png"

Response

contentType

string

required

MIME type. Example: image/png

Example:

"image/png"

filename

string

required

The sanitized file name. Example: logo.png

Example:

"logo.png"

string

required

The file id.

Example:

"fil_y3rgwmhkbgxxa2qzmfyrdj0e"

object

any

required

Always "file".

size

integer

required

Decoded size in bytes. Example: 24680

Required range: x >= 0

Example:

24680

url

string

required

The permanent public URL.

Example:

"https://files.norbelys.com/files/org_x/fil_y/logo.png"

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.files.create({ content: "…", contentType: "image/png", filename: "logo.png" });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "contentType": "image/png",
  "filename": "logo.png",
  "id": "fil_y3rgwmhkbgxxa2qzmfyrdj0e",
  "object": "file",
  "size": 24680,
  "url": "https://files.norbelys.com/files/org_x/fil_y/logo.png"
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Analytics

Domains

Fields

Files

Groups

Integrations

Messages

Organization

People

Programs

Segments

Senders

Suppressions

Verify

Upload a public file

Authorizations

Headers

Body

Response