API Documentation

Up-to-date API Documentation of 0CodeKit.

Remarks

Previous documentation on Postman can still be found here but is no longer maintained.

Base URL

https://prod.0codekit.com

Authentication

Include a key:value pair in the header of the request, where the key is auth and the value your API key that can be obtained in your 0CodeKit account portal.

For example: auth:a4c3dcc5-8e41-4cad-bd5f-c24086baba00

Functions

Extract text from given PDF (Advanced OCR)

Extracts text and specific data from documents, supporting OCR and specialized workflows.

POSThttps://v2.1saas.co/ai/advancedocr

Header parameters

Body

urlstring

The URL to the document.

Example: "https://icseindia.org/document/sample.pdf"

bufferstring

The Base64-encoded buffer. Can be provided instead of url.

resultType*enum

Result type specifies the output type.

ocrextractions

workflow*string

A workflow outlines steps for processing documents, including analysis, extraction, and transformation. It uses unique identifiers to track and retrieve results for each document.

languagestring

The language of the uploaded document.

documentTypestring

The type of the uploaded document.

Response

Success

Body

Other propertiesany of

Request

const response = await fetch('https://v2.1saas.co/ai/advancedocr', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "resultType": "ocr",
      "workflow": "text"
    }),
});
const data = await response.json();

Response

{
  "status": 0,
  "errorMessage": "text"
}

Extract a custom object from a given text.

This function takes a text input, a context for added relevance, and a list of fields with their descriptions. It leverages an LLM to extract the specified information from the text and organizes it into a structured object.

POST/ai/extract-from-text

Header parameters

Body

text*string

The text in which the information will be searched.

Example: "Greetings! I am Zog, an alien from planet Blip, 142 years old, and a passionate collector of cosmic dust."

context*string

Prompt that contextualizes the text.

Example: "A brief self-introduction from an alien applying for an intergalactic research role."

fields*array of object

Response

Success

Body

any

Request

const response = await fetch('/ai/extract-from-text', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "text": "Greetings! I am Zog, an alien from planet Blip, 142 years old, and a passionate collector of cosmic dust.",
      "context": "A brief self-introduction from an alien applying for an intergalactic research role.",
      "fields": [
        {
          "name": "age",
          "description": "Age of the alien. Just a number, no other text."
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "status": 0,
  "errorMessage": "text"
}

Find the best match for a query string from a list of targets.

This function takes a query string and a list of target strings. It uses an LLM to find the best match(es), accounting for variations in the query string, and returns the closest match(es) based on the options provided.

POST/ai/fuzzy-match

Header parameters

Body

queryString*string

The main string you want to match against the target list. Typically, this is the name or entity you are searching for.

Example: "Alf from Melmac"

contextstring

A short description of the type of data being matched. This helps provide additional clarity for the AI in determining the best match.

Example: "Names of people"

targetList*array of string

The list of potential matches. Each entry in this list represents a possible candidate for matching with the query string.

optionsobject

Response

Success

Body

matches*any of

Request

const response = await fetch('/ai/fuzzy-match', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "queryString": "Alf from Melmac",
      "targetList": [
        "Willie Tanner",
        "Gordon Shumway",
        "Kate Tanner",
        "Trevor Ochmonek"
      ]
    }),
});
const data = await response.json();

Response

{
  "matches": [
    "Gordon Shumway"
  ]
}

Redact sensitive information from pdf.

POST/ai/redact-pdf

Header parameters

Body

urlstring

The PDF URL.

bufferstring

The PDF as a Base64-encoded buffer. Can be specified instead of url.

sensitiveContent*string

A text prompt describing which data from the document should be covered.

Example: "All people names and addresses should be considered sensitive data."

fileNamestring

The file name the result PDF will have. Default is a random ID.

getAsUrlboolean

Whether the result PDF should be returned as a URL. Default is false.

Example: true

languagestring

The language of the document in ISO 639-1 nomenclature. Default is 'en' (English).

Example: "de"

Response

Success

Body

url*string

The result PDF URL.

fileName*string

The name of the file.

Request

const response = await fetch('/ai/redact-pdf', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sensitiveContent": "All people names and addresses should be considered sensitive data."
    }),
});
const data = await response.json();

Response

{
  "url": "text",
  "fileName": "text"
}

Detect adult content.

Check if the content is appropriate for all audiences.

POST/ai/detectadultcontent

Header parameters

Body

imageUrl*string

The URL of the image to be checked.

Example: "https://example.com/image.jpg"

Response

Success

Body

object

Request

const response = await fetch('/ai/detectadultcontent', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "imageUrl": "https://example.com/image.jpg"
    }),
});
const data = await response.json();

Response

{}

Detect text in an image.

Detects text in an image using the Azure Computer Vision API.

POST/ai/picturetextrecognition

Header parameters

Body

imageUrl*string

The URL of the image to analyze.

Example: "https://example.com/image.jpg"

Response

Success

Body

recognizedTexts*array of string

List of recognized text strings in the image.

Request

const response = await fetch('/ai/picturetextrecognition', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "imageUrl": "https://example.com/image.jpg"
    }),
});
const data = await response.json();

Response

{
  "recognizedTexts": [
    "text"
  ]
}

Text Entity Detection.

Identities Entities From Input Text.

POST/ai/entitydetection

Header parameters

Body

text*string

Text for entity detection.

Response

Success

Body

detections*array of object

Request

const response = await fetch('/ai/entitydetection', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "text": "text"
    }),
});
const data = await response.json();

Response

{
  "detections": [
    {
      "text": "text",
      "category": "text",
      "offset": 0,
      "length": 0,
      "confidenceScore": 0
    }
  ]
}

Remove image background.

Remove background from image url or buffer.

POST/ai/removebg

Header parameters

Body

urlstring

bufferstring

getAsUrl*boolean

fileNamestring

Response

Success

Body

object

Request

const response = await fetch('/ai/removebg', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "getAsUrl": false
    }),
});
const data = await response.json();

Response

{}

Detect brand

Detect brand from given image.

POST/ai/detectbrand

Header parameters

Body

imageUrl*string

Image for brand detection.

Response

Success

Body

brands*array of string

Request

const response = await fetch('/ai/detectbrand', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "imageUrl": "text"
    }),
});
const data = await response.json();

Response

{
  "brands": [
    "text"
  ]
}

Generate python code.

Generate python code based on provided prompt.

POST/ai/generatepythoncode

Header parameters

Body

prompt*string

Prompt to generate python code.

Response

Success

Body

id*string

code*string

Request

const response = await fetch('/ai/generatepythoncode', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "prompt": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "code": "text"
}

Detect color.

Detect color from given image.

POST/ai/detectcolor

Header parameters

Body

imageUrl*string

Image for color detection.

Response

Success

Body

object

Request

const response = await fetch('/ai/detectcolor', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "imageUrl": "text"
    }),
});
const data = await response.json();

Response

{}

Too Long To Read

Creates a summary of the given text.

POST/ai/toolongtoread

Header parameters

Body

prompt*string

The text to be summarized.

Example:

"Once upon a time, in a far away land, there lived a young girl who was full of dreams and aspirations. She was passionate about exploring the world and discovering all its secrets. She wanted to see the wonders of the world, to meet new people, to learn new things, and to experience life in all its glory. As a young girl, she often thought of what it would be like to journey to exotic places, to explore the unknown and to find her place in the world. She wanted to be free to make her own decisions, to choose her own destiny, and to be independent. ne day, she decided she was ready to embark on her quest. She packed her bags, said goodbye to her family, and set off on her travels. She went to places she had only dreamed of, and experienced things she had never imagined. She met people from all walks of life, made new friends, and experienced new cultures. She explored the great outdoors and embraced nature in all its beauty. She tried new foods, and found her favorite cuisines. Through it all, she found her own path and discovered her true purpose in life."

Response

Success

Body

result*object

Request

const response = await fetch('/ai/toolongtoread', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "prompt": "Once upon a time, in a far away land, there lived a young girl who was full of dreams and aspirations. She was passionate about exploring the world and discovering all its secrets. She wanted to see the wonders of the world, to meet new people, to learn new things, and to experience life in all its glory. As a young girl, she often thought of what it would be like to journey to exotic places, to explore the unknown and to find her place in the world. She wanted to be free to make her own decisions, to choose her own destiny, and to be independent. ne day, she decided she was ready to embark on her quest. She packed her bags, said goodbye to her family, and set off on her travels. She went to places she had only dreamed of, and experienced things she had never imagined. She met people from all walks of life, made new friends, and experienced new cultures. She explored the great outdoors and embraced nature in all its beauty. She tried new foods, and found her favorite cuisines. Through it all, she found her own path and discovered her true purpose in life."
    }),
});
const data = await response.json();

Response

{
  "result": {
    "id": "cmpl-2iZ3t9nGQ4aJ7Qb4Q7Xq8Zn5",
    "data": "A young girl with dreams of exploring the world and experiencing life's wonders embarks on a journey to exotic places. She meets people from different cultures, tries new foods, and enjoys nature's beauty. Throughout her travels, she finds her own path and discovers her true purpose in life."
  }
}

Detect language.

Detect language of given text.

POST/ai/languagedetection

Header parameters

Body

text*string

Text for language detection.

Response

Success

Body

name*string

iso6391Name*string

confidenceScore*number

Request

const response = await fetch('/ai/languagedetection', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "text": "text"
    }),
});
const data = await response.json();

Response

{
  "name": "text",
  "iso6391Name": "text",
  "confidenceScore": 0
}

Transcribe audio.

Transcribe an audio file to text. This supports the following file types: flac, m4a, mp3, mp4, mpeg, mpga, oga, ogg, wav, webm. The maximum file size is 25MB.

POST/ai/transcribe

Header parameters

Body

urlstring

The URL to the audio file.

Example: "https://www.pacdv.com/sounds/voices/am-i-totally-screwed-or.wav"

bufferstring

The Base64-encoded audio file. Can be provided instead of url.

langstring

The audio language. Default is en.

Example: "en"

Response

Success

Body

text*string

The transcription result.

Example: "Ladies and gentlemen, am I totally screwed, or what?"

Request

const response = await fetch('/ai/transcribe', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "text": "Ladies and gentlemen, am I totally screwed, or what?"
}

Detect labels in an image.

Detects labels in an image using the Google Vision API.

POST/ai/pictureobjectrecognition

Header parameters

Body

imageUrl*string

The URL of the image to analyze.

Example: "https://example.com/image.jpg"

Response

Success

Body

recognizedLabels*array of string

List of recognized labels in the image.

Request

const response = await fetch('/ai/pictureobjectrecognition', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "imageUrl": "https://example.com/image.jpg"
    }),
});
const data = await response.json();

Response

{
  "recognizedLabels": [
    "text"
  ]
}

Generate an image.

Generate an image based on prompt.

POST/ai/generateimage

Header parameters

Body

prompt*string

Prompt to generate image.

n*number

Number of output image's to be generated.

size*enum

256x256512x5121024x10241024x10241792x10241024x1792

Response

Success

Body

id*number

image*array of object

Request

const response = await fetch('/ai/generateimage', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "prompt": "text",
      "n": 0,
      "size": "256x256"
    }),
});
const data = await response.json();

Response

{
  "id": 0,
  "image": [
    {
      "url": "text"
    }
  ]
}

Extract contact information.

Extract contact information from given prompt.

POST/ai/extractcontactinformation

Header parameters

Body

prompt*string

Prompt for contact info extraction.

Response

Success

Body

id*string

data*object

Request

const response = await fetch('/ai/extractcontactinformation', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "prompt": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "data": {
    "name": "text",
    "phone": "text",
    "email": "text",
    "address": "text",
    "website": "text"
  }
}

Generate javascript code.

Generate javascript code based on provided prompt.

POST/ai/generatejavascriptcode

Header parameters

Body

prompt*string

Prompt to generate javascript code.

Response

Success

Body

id*string

code*string

Request

const response = await fetch('/ai/generatejavascriptcode', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "prompt": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "code": "text"
}

Detect mood.

Detect mood from given text.

POST/ai/mooddetection

Header parameters

Body

text*string

Response

Success

Body

moodOverall*string

moodScore*object

moodPerSentence*array of object

Request

const response = await fetch('/ai/mooddetection', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "text": "text"
    }),
});
const data = await response.json();

Response

{
  "moodOverall": "text",
  "moodScore": {
    "positive": 0,
    "neutral": 0,
    "negative": 0
  },
  "moodPerSentence": [
    {
      "mood": "text",
      "text": "text"
    }
  ]
}

Detect face.

Detect face from given image.

POST/ai/detectface

Header parameters

Body

imageUrl*string

Image for face detection.

Response

Success

Body

totalFaces*number

facesPosition*array of object

Request

const response = await fetch('/ai/detectface', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "imageUrl": "text"
    }),
});
const data = await response.json();

Response

{
  "totalFaces": 0,
  "facesPosition": [
    {
      "left": 0,
      "top": 0,
      "width": 0,
      "height": 0
    }
  ]
}

Detect email type.

Detect email type from provided subject and body.ß

POST/ai/detectemailtype

Header parameters

Body

subject*string

Subject of email.

body*string

Body of email.

Response

Success

Body

id*string

type*string

Request

const response = await fetch('/ai/detectemailtype', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "subject": "text",
      "body": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "type": "text"
}

PDF Optical Character Recognition.

POST/ai/pdfocr

Header parameters

Body

pdfUrl*string

PDF URL.

Response

Success

Body

recognizedText*string

The text that was recognized in the PDF.

Request

const response = await fetch('/ai/pdfocr', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "pdfUrl": "text"
    }),
});
const data = await response.json();

Response

{
  "recognizedText": "text"
}

Check content policy.

Check if the content is appropriate to be posted on the internet.

POST/ai/checkcontentpolicy

Header parameters

Body

prompt*string

The text containing the content to be checked.

Example: "Hello world!"

Response

Success

Body

id*string

The ID of the content.

Example: "cmpl-2iZ3t9nGQ4aJ7Qb4Q7Xq8Zn5"

safe*boolean

Boolean value indicating if the content is safe.

Example: true

data*string

The message containing the result of the content check.

Example: "Content is safe."

Request

const response = await fetch('/ai/checkcontentpolicy', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "prompt": "Hello world!"
    }),
});
const data = await response.json();

Response

{
  "id": "cmpl-2iZ3t9nGQ4aJ7Qb4Q7Xq8Zn5",
  "safe": true,
  "data": "Content is safe."
}

Translate text to a specified language.

Translates the provided text into the specified target language using Google Translate API.

POST/ai/translate

Header parameters

Body

text*string

The text to be translated.

Example: "Hello, world!"

resultLang*string

The target language code to translate the text into.

Example: "es"

Response

Success

Body

translation*any of

Request

const response = await fetch('/ai/translate', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "text": "Hello, world!",
      "resultLang": "es"
    }),
});
const data = await response.json();

Response

{
  "translation": "text"
}

Hash a message.

POST/crypto/hash

Header parameters

Body

hashType*enum

MD5SHA1SHA224SHA256SHA3SHA384SHA512RIPEMD160HmacMD5HmacSHA1HmacSHA224HmacSHA256HmacSHA3HmacSHA384HmacSHA512HmacRIPEMD160

message*string

secretKeystring

Response

Success

Body

hashedText*string

Request

const response = await fetch('/crypto/hash', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "hashType": "MD5",
      "message": "text"
    }),
});
const data = await response.json();

Response

{
  "hashedText": "text"
}

Decrypt ciphertext.

POST/crypto/decrypt

Header parameters

Body

cryptoType*enum

AESDESTripleDESRabbitRC4RC4Drop

ciphertext*string

The ciphertext.

secretKey*string

The encryption key.

Response

Success

Body

decryptedText*string

The plaintext.

Request

const response = await fetch('/crypto/decrypt', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cryptoType": "AES",
      "ciphertext": "text",
      "secretKey": "text"
    }),
});
const data = await response.json();

Response

{
  "decryptedText": "text"
}

Encrypt plaintext.

POST/crypto/encrypt

Header parameters

Body

cryptoType*enum

AESDESTripleDESRabbitRC4RC4Drop

message*string

The plaintext.

secretKey*string

The encryption key.

Response

Success

Body

encryptedText*string

The ciphertext.

Request

const response = await fetch('/crypto/encrypt', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cryptoType": "AES",
      "message": "text",
      "secretKey": "text"
    }),
});
const data = await response.json();

Response

{
  "encryptedText": "text"
}

Calculate geographical distance.

Returns the distance between a start and end point. The distance is calculated using a specific mode of travel, which can influence the route taken and is also used to estimate the amount of time it takes to travel.

POST/calculate/geodistance-v2

Header parameters

Body

startPoint*string

The start point.

Example: "Flensburg"

endPoint*string

The end point.

Example: "Istanbul"

mode*enum

The mode of travel.

Example: "walking"

drivingwalkingbicyclingtransit

Response

Success

Body

distanceInKM*number

The distance between start and end point in kilometers when traveling.

duration*object

The estimated amount of time it takes to travel from start to end point.

Request

const response = await fetch('/calculate/geodistance-v2', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "startPoint": "Flensburg",
      "endPoint": "Istanbul",
      "mode": "walking"
    }),
});
const data = await response.json();

Response

{
  "distanceInKM": 0,
  "duration": {
    "hours": 0,
    "minutes": 0
  }
}

Calculate the BMI.

Uses the height and weight of a person to calculate their BMI as well as several other related values, including their recommended nutrients.

POST/calculate/bmi

Header parameters

Body

weight*number

The weight in kilograms.

Example: 80

height*number

The height in centimeters.

Example: 180

Response

Success

Body

bmi*number

The calculated BMI value.

Example: 24.69

bmiClassification*string

The BMI classification

Example: "normal"

dbw*number

Desirable body weight (DBW) in kilograms.

Example: 72

kcal*number

The amount of energy in kilocalories required per day.

Example: 2160

nutrients*object

Request

const response = await fetch('/calculate/bmi', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "weight": 80,
      "height": 180
    }),
});
const data = await response.json();

Response

{
  "bmi": 24.69,
  "bmiClassification": "normal",
  "dbw": 72,
  "kcal": 2160,
  "nutrients": {
    "carbohydrates": 324,
    "protein": 81,
    "fat": 60
  }
}

Find gender of name.

POST/operator/gender

Header parameters

Body

firstnamestring

The first name.

fullnamestring

The full name. The first name is only used if firstname is not provided.

Response

Success

Body

firstname*string

The first name, either from firstname or fullname.

lastnamestring

The last name, extracted from fullname.

detectedGender*enum

The detected gender, either male, female, or unisex.

malefemaleunisex

Request

const response = await fetch('/operator/gender', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "firstname": "text",
  "lastname": "text",
  "detectedGender": "male"
}

Retrieve credits.

POST/user/retrievecredits

Header parameters

Body

object

Response

Success

Body

credits*number

The number of credits you have left.

Request

const response = await fetch('/user/retrievecredits', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "credits": 0
}

Remove duplicates from the list.

POST/operator/duplicate

Header parameters

Body

list*array of any

The List that contains duplicate values.

Response

Success

Body

list*array of any

The List that removed all duplicate values.

Request

const response = await fetch('/operator/duplicate', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "list": []
    }),
});
const data = await response.json();

Response

{
  "list": []
}

Parse URL query parameters.

POST/operator/parseurlquery

Header parameters

Body

url*string

The URL.

Response

Success

Body

Other propertiesstring

Request

const response = await fetch('/operator/parseurlquery', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "text"
    }),
});
const data = await response.json();

Response

{
  "status": 0,
  "errorMessage": "text"
}

Get website logo URL.

POST/operator/logo

Header parameters

Body

url*string

Response

Success

Body

type*string

url*string

size*string

Request

const response = await fetch('/operator/logo', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "url": "text",
  "size": "text"
}

Get thumbnail for video.

POST/operator/thumbnail

Header parameters

Body

url*string

Pattern: ^(https?:\/\/)?([\w-]+\.)+[\w-]+(\/[\w-./?%&=]*)?$

getAsUrlboolean

fileNamestring

Response

Success

Body

url*string

fileName*string

Request

const response = await fetch('/operator/thumbnail', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "text"
    }),
});
const data = await response.json();

Response

{
  "url": "text",
  "fileName": "text"
}

Get JSON values from keys.

POST/operator/advancedswitch

Header parameters

Body

external*boolean

json*any of

key*any of

Response

Success

Body

found*any of

Request

const response = await fetch('/operator/advancedswitch', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "external": false,
      "json": "text",
      "key": "text"
    }),
});
const data = await response.json();

Response

{
  "found": []
}

Check rate limit.

A simple way to implement rate limiting by checking whether a new request is allowed now.

POSThttps://v2.1saas.co/operator/trafficlight

Header parameters

Body

name*string

An arbitrary name for this traffic light.

interval*number

The minimum time that must pass after one request was allowed.

Response

Success

Body

ok*boolean

Request

const response = await fetch('https://v2.1saas.co/operator/trafficlight', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "interval": 0
    }),
});
const data = await response.json();

Response

{
  "ok": false
}

Split name.

Split a full name into its first and last name.

POST/operator/splitname

Header parameters

Body

name*string

The full name that will be split.

reversedboolean

Whether first and last name should be reversed. Might be useful in languages where the last name comes first, e.g. Chinese.

Response

Success

Body

firstName*string

The first name. This might also be multiple first names.

lastName*string

The last name.

Request

const response = await fetch('/operator/splitname', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "firstName": "text",
  "lastName": "text"
}

Expand URL.

Converts a shortened URL from any URL shortener to its expanded form.

POST/operator/urlexpander

Header parameters

Body

url*string

The URL.

Response

Success

Body

unshortenedUrl*string

The expanded URL.

Request

const response = await fetch('/operator/urlexpander', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "text"
    }),
});
const data = await response.json();

Response

{
  "unshortenedUrl": "text"
}

Build UTM link.

POST/operator/utm/build

Header parameters

Body

url*string

The base URL.

utm*object

Response

Success

Body

url*string

The built UTM link.

Request

const response = await fetch('/operator/utm/build', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "text",
      "utm": {}
    }),
});
const data = await response.json();

Response

{
  "url": "text"
}

Parse UTM link.

POST/operator/utm/parse

Header parameters

Body

url*string

Response

Success

Body

utm_sourcestring

utm_mediumstring

utm_campaignstring

utm_contentstring

utm_termstring

Request

const response = await fetch('/operator/utm/parse', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "text"
    }),
});
const data = await response.json();

Response

{
  "utm_source": "text",
  "utm_medium": "text",
  "utm_campaign": "text",
  "utm_content": "text",
  "utm_term": "text"
}

Parse HTML.

POST/operator/htmlparser/get

Header parameters

Body

htmlstring

urlstring

allboolean

selectorstring

tagSelectorstring

idSelectorstring

classSelectorstring

Response

Success

Body

data*any of

Request

const response = await fetch('/operator/htmlparser/get', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "data": "text"
}

Merge audio into a video file with optional customizations.

Merges a video file and an audio file into a single video file, optionally applying various customizations like trimming, fading, and more.

POST/operator/merge-video-audio

Header parameters

Body

video*string

The URL of the video file.

Example: "https://example.com/video.mp4"

audio*string

The URL of the audio file.

Example: "https://example.com/audio.mp3"

fileNamestring

The name of the merged video.

Response

Success

Body

outputUrl*string

The URL where the merged video can be downloaded.

Example: "https://example.com/output.mp4"

Request

Response

Convert between ISO and nation name.

Takes a nation name or a nation ISO code and outputs the corresponding nation name and ISO code.

POST/convert/nationiso

Header parameters

Body

isostring

The ISO code of the nation.

nationstring

The English name of the nation.

Response

Success

Body

iso*string

The ISO code of the nation.

nation*string

The English name of the nation.

Request

const response = await fetch('/convert/nationiso', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "iso": "text",
  "nation": "text"
}

Convert Outlook item files.

POST/convert/msgtojson

Header parameters

Body

urlstring

bufferstring

Response

Success

Body

any

Request

const response = await fetch('/convert/msgtojson', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "status": 0,
  "errorMessage": "text"
}

Convert between currencies.

POST/convert/currency

Header parameters

Body

sourceCurrency*string

targetCurrency*string

amount*number

dateFormatstring

Response

Success

Body

oldAmount*number

oldCurrency*string

convertedAmount*number

currency*string

dataDate*string

Request

const response = await fetch('/convert/currency', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sourceCurrency": "text",
      "targetCurrency": "text",
      "amount": 0
    }),
});
const data = await response.json();

Response

{
  "oldAmount": 0,
  "oldCurrency": "text",
  "convertedAmount": 0,
  "currency": "text",
  "dataDate": "text"
}

Convert IP to location.

POST/convert/iptogeo

Header parameters

Body

ip*string

The IP address.

Example: "87.155.190.147"

Response

Success

Body

status*enum

Whether the operation succeeded.

Example: "success"

success

country*string

The name of the country.

Example: "Germany"

countryCode*string

The country code.

Example: "De"

region*string

The region code.

Example: "RP"

regionName*string

The name of the region.

Example: "Rheinland-Pfalz"

city*string

The city the IP address comes from.

Example: "Waldfischbach-Burgalben"

zip*string

The zip code the IP address comes from.

Example: "67714"

lat*number

The latitude of the location.

Example: 49.2794

lon*number

The longitude of the location.

Example: 7.6671

timezone*string

The timezone the IP address is in.

Example: "Europe/Berlin"

isp*string

The internet service provider.

Example: "Deutsche Telekom AG"

org*string

The organization.

Example: "Deutsche Telekom AG"

as*string

The AS code.

Example: "AS3320 Deutsche Telekom AG"

query*string

The IP address that was queried.

Example: "87.155.190.147"

Request

const response = await fetch('/convert/iptogeo', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ip": "87.155.190.147"
    }),
});
const data = await response.json();

Response

{
  "status": "success",
  "country": "Germany",
  "countryCode": "De",
  "region": "RP",
  "regionName": "Rheinland-Pfalz",
  "city": "Waldfischbach-Burgalben",
  "zip": "67714",
  "lat": 49.2794,
  "lon": 7.6671,
  "timezone": "Europe/Berlin",
  "isp": "Deutsche Telekom AG",
  "org": "Deutsche Telekom AG",
  "as": "AS3320 Deutsche Telekom AG",
  "query": "87.155.190.147"
}

Convert CSV to JSON.

POST/convert/csv/json

Header parameters

Body

csv*string

The CSV string that will be converted.

noheaderboolean

If this is false, the first line will be interpreted as column names instead of data. Default is false.

delimiterany of

The delimiter between the different columns. Can be auto for automatic detection of delimiters, or an array of delimiters. Default is auto.

trimboolean

Whether spaces around column values should be trimmed. Default is true.

ignoreEmptyboolean

Whether empty column values should be ignored, instead of being output as empty. Default is false.

Response

Success

Body

json*array of any

An array of JSON objects parsed from the CSV.

Request

const response = await fetch('/convert/csv/json', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "csv": "text"
    }),
});
const data = await response.json();

Response

{
  "json": []
}

Convert CSV to array.

POST/convert/csv/array

Header parameters

Body

csv*string

The CSV string that will be parsed.

omitFirstRowboolean

Whether to omit the first row. Default is false.

delimiter*string

The delimiter by which the rows will be split.

Response

Success

Body

array*array of array of string

The array of rows, where each row is an array of fields.

Request

const response = await fetch('/convert/csv/array', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "csv": "text",
      "delimiter": "text"
    }),
});
const data = await response.json();

Response

{
  "array": [
    [
      "text"
    ]
  ]
}

Look up VAT rate.

Looks up the VAT rate for the specified country in the European Union.

POST/business/lookupvatrates

Header parameters

Body

countryCode*string

The ISO 3166-1 alpha-2 code of the country.

Response

Success

Body

country*string

The name of the country.

vat_name*string

The name of VAT in the country.

vat_abbr*string

The VAT abbreviation.

standard_rate*number

The standard VAT rate.

reduced_rate*any of

The reduced VAT rate, or false.

reduced_rate_alt*any of

The alternative reduced VAT rate, or false.

super_reduced_rate*any of

The super reduced VAT rate, or false.

parking_rate*any of

The parking rate, or false.

Request

const response = await fetch('/business/lookupvatrates', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "countryCode": "text"
    }),
});
const data = await response.json();

Response

{
  "country": "text",
  "vat_name": "text",
  "vat_abbr": "text",
  "standard_rate": 0,
  "reduced_rate": 0,
  "reduced_rate_alt": 0,
  "super_reduced_rate": 0,
  "parking_rate": 0
}

Check for freemail.

Checks whether the email address is from a free email provider.

POST/business/isfreemail

Header parameters

Body

email*string

The email address that should be checked.

Example: "pa1928sch@hotmail.com"

Response

Success

Body

freeEmailProvider*boolean

Whether the email provider is free.

Example: true

provider*string

The provider domain extracted from the email address.

Example: "hotmail.com"

Request

const response = await fetch('/business/isfreemail', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "pa1928sch@hotmail.com"
    }),
});
const data = await response.json();

Response

{
  "freeEmailProvider": true,
  "provider": "hotmail.com"
}

Validate Geolocation.

This endpoint takes an address or coordinates, and checks whether it is valid.

POST/business/validate/geolocation

Header parameters

Body

address*string

The location. Can be an address or coordinates.

Example: "Bavaria Donau 11, Passau"

Response

Success

Body

valid*boolean

Whether the location is valid.

Example: true

addressstring

The address if the location is valid.

Example: "Bavaria Donau 11, Passau"

Request

const response = await fetch('/business/validate/geolocation', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "address": "Bavaria Donau 11, Passau"
    }),
});
const data = await response.json();

Response

{
  "valid": true,
  "address": "Bavaria Donau 11, Passau"
}

Validate the phone number.

Checks whether the phone number is valid.

POST/business/validate/phonenumber

Header parameters

Body

phoneNumber*string

The phone number to validate.

Example: "(+81) 090-1234-5678"

countryCodestring

Short abbreviation of a country.

Example: "JP"

Response

Success

Body

phoneNumber*string

The given phone number to validate.

Example: "(+81) 090-1234-5678"

internationNumberstring

The international number formated.

Example: "\"+81 90 1234 5678"

numberstring

The international based on E164Number Code.

Example: "+819012345678"

nationalNumberstring

The national number of the country.

Example: "9012345678"

countryCodestring

The country code based on the phone number.

Example: "JP"

possibleNumberboolean

Checks if the given number is an possible phone number.

Example: true

isValidboolean

Checks whether the phone number is valid.

Example: true

Request

const response = await fetch('/business/validate/phonenumber', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "phoneNumber": "(+81) 090-1234-5678"
    }),
});
const data = await response.json();

Response

{
  "phoneNumber": "(+81) 090-1234-5678",
  "internationNumber": "\"+81 90 1234 5678",
  "number": "+819012345678",
  "nationalNumber": "9012345678",
  "countryCode": "JP",
  "possibleNumber": true,
  "isValid": true
}

Validate IBAN

Checks whether the provided IBAN (International Bank Account Number) is valid.

POST/business/validate/iban

Header parameters

Body

iban*string

The IBAN

Example: "DE02120300000000202051"

Response

Success

Body

valid*boolean

Whether the IBAN is valid.

Example: true

Request

const response = await fetch('/business/validate/iban', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "iban": "DE02120300000000202051"
    }),
});
const data = await response.json();

Response

{
  "valid": true
}

Validate a VAT ID.

Checks whether the provided VAT (Valued Added Tax) ID is valid using a service provided by VIES, If available, this also returns the associated name and address

POST/business/validate/vat

Header parameters

Body

vatIdstring

The VAT ID. Must start with a two-digit country code.

Example: "DE123456789"

countryCodeenum

The country code of the VAT ID.

Example: "IT"

ATBEBGHRCYCZDKEEFIFRDEELHUIEITLVLTLUMTNLPLPTROSKSIESSEXI

idstring

The number part of the VAT ID.

Example: "07643520567"

Response

Success

Body

countryCode*string

The country code.

vatNumber*string

The VAT number.

requestDate*string

The exact date and time the request was made.

valid*boolean

Whether the ID is valid.

namestring

The name. Only provided if the ID is valid.

addressstring

The address. Only provided if the address is valid.

Request

const response = await fetch('/business/validate/vat', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "countryCode": "text",
  "vatNumber": "text",
  "requestDate": "text",
  "valid": false,
  "name": "text",
  "address": "text"
}

Validate a BIC.

Checks whether a BIC (Bank Identifier Code) is valid.

POST/business/validate/bic

Header parameters

Body

bic*string

The BIC.

Response

Success

Body

valid*boolean

Whether the BIC is valid.

Request

const response = await fetch('/business/validate/bic', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "bic": "text"
    }),
});
const data = await response.json();

Response

{
  "valid": false
}

Verify domain.

Verifies a domain by performing an HTTP GET request against it.

POST/business/verify/domain

Header parameters

Body

domain*string

The domain name.

Example: "https://www.google.com"

Response

Success

Body

mainDomain*string

The main domain name, without subdomain.

isValid*boolean

Whether the domain is valid.

Request

const response = await fetch('/business/verify/domain', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "domain": "https://www.google.com"
    }),
});
const data = await response.json();

Response

{
  "mainDomain": "text",
  "isValid": false
}

Validate a Factur-X/Zugferd PDF.

Factur-X/Zugferd is a standard for digital invoices. The data is encoded into an XML, which is attached to a human-readable PDF file. This endpoint checks that the given PDF has an attached XML invoice, and validates it according to the Factur-X/Zugferd specification (level EN16931). It also returns the XML invoice for further processing.

POST/business/facturx/validate

Header parameters

Body

urlstring

The PDF URL.

bufferstring

The PDF as a Base64-encoded buffer. Can be specified instead of url.

Response

Success

Body

valid*boolean

Whether the PDF is a valid Factur-X/Zugferd invoice (level EN16931).

errorsarray of string

The errors that were generated during the validation of the XML invoice. Only set if valid is false.

invoicestring

The attached Factur-X/Zugferd XML invoice.

Request

Response

Embed a Factur-X/Zugferd XML into an existing PDF.

Factur-X/Zugferd is a standard for digital invoices. The data is encoded into an XML, which is attached to a human-readable PDF file. This endpoint embeds an existing XML invoice into a PDF file which is not yet a Factur-X/Zugferd invoice. It also validates that the XML is valid. To create a valid Factur-X/Zugferd invoice, the user has to guarantee that the provided PDF is in PDF/A format.

POST/business/facturx/embed

Header parameters

Body

urlstring

The PDF URL.

bufferstring

The Base64-encoded PDF file. Can be specified instead of url.

xml*string

The Factur-X/Zugferd XML invoice that shall be embedded.

getAsUrlboolean

Whether the PDF should be returned as a URL. Default is false.

fileNamestring

The PDF file name. Default is a random ID.

Response

Success

Body

object

Request

Response

Upload a temporary file.

Uploads a file buffer to temporary storage and provides a URL. The file is deleted after 24 hours.

POST/storage/temp

Header parameters

Body

fileNamestring

The file name. Default is a random string.

Example: "my-file.txt"

buffer*string

The Base64-encoded file buffer.

Response

Success

Body

url*string

The URL to download the file.

fileName*string

The file name used to upload the file.

Request

const response = await fetch('/storage/temp', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "buffer": "text"
    }),
});
const data = await response.json();

Response

{
  "url": "text",
  "fileName": "text"
}

Delete from permanent storage.

POST/storage/perm/del

Header parameters

Body

fileId*string

Response

Success

Body

message*string

Request

const response = await fetch('/storage/perm/del', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fileId": "text"
    }),
});
const data = await response.json();

Response

{
  "message": "text"
}

Get permanent file.

POST/storage/perm/get

Header parameters

Body

fileNamestring

fileIdstring

getAsUrlboolean

Response

Success

Body

object

Request

const response = await fetch('/storage/perm/get', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{}

List permanent files.

POST/storage/perm/list

Header parameters

Body

object

Response

Success

Body

files*array of object

Request

const response = await fetch('/storage/perm/list', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "files": [
    {
      "fileId": "text",
      "fileName": "text"
    }
  ]
}

Upload to permanent storage.

POST/storage/perm/add

Header parameters

Body

fileUrlstring

fileBufferstring

uploadNamestring

Response

Success

Body

fileId*string

Request

const response = await fetch('/storage/perm/add', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "fileId": "text"
}

Delete a global variable.

A global variable can only be deleted by the user that created it.

POST/storage/globalvariables/del

Header parameters

Body

variableId*string

The variable name.

Example: "myVariable"

Response

Success

Body

message*string

The status message.

Example: "Successfully deleted global variable with id myVariable."

Request

const response = await fetch('/storage/globalvariables/del', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "variableId": "myVariable"
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully deleted global variable with id myVariable."
}

Update a global variable.

Changes the value of the given global variable to the new value.

POST/storage/globalvariables/update

Header parameters

Body

variableName*string

The name of the variable to update.

Example: "myVariable"

variableValue*string

The new value of the variable.

Example: "myValue"

Response

Success

Body

variableName*string

The variable name.

Example: "myVariable"

variableValue*string

The new value of the variable.

Example: "myValue"

Request

const response = await fetch('/storage/globalvariables/update', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "variableName": "myVariable",
      "variableValue": "myValue"
    }),
});
const data = await response.json();

Response

{
  "variableName": "myVariable",
  "variableValue": "myValue"
}

Get a global variable.

The user can only access a global variable that they created themselves.

POST/storage/globalvariables/get

Header parameters

Body

variableName*string

The name of the variable to get.

Example: "myVariable"

Response

Success

Body

variableName*string

The variable name.

Example: "myVariable"

variableValue*string

The variable value.

Example: "myValue"

Request

const response = await fetch('/storage/globalvariables/get', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "variableName": "myVariable"
    }),
});
const data = await response.json();

Response

{
  "variableName": "myVariable",
  "variableValue": "myValue"
}

List all variables.

Lists all variables that the user has created before and not yet deleted.

POST/storage/globalvariables/list

Header parameters

Body

object

Response

Success

Body

variables*array of object

The list of variables for this user.

Request

const response = await fetch('/storage/globalvariables/list', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "variables": [
    {
      "variableName": "myVariable",
      "variableValue": "myValue"
    }
  ]
}

Add a global variable.

The global variable is only visible for the user that created it. If variableName is not provided, it is generated automatically.

POST/storage/globalvariables/add

Header parameters

Body

variableNamestring

The name of the variable to create. Default is auto-generated.

Example: "myVariable"

variableValue*string

The value to assign to the variable.

Example: "myValue"

Response

Success

Body

variableName*string

The variable name that was actually used.

Example: "myVariable"

variableValue*string

The value that was assigned to the variable.

Example: "myValue"

Request

const response = await fetch('/storage/globalvariables/add', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "variableValue": "myValue"
    }),
});
const data = await response.json();

Response

{
  "variableName": "myVariable",
  "variableValue": "myValue"
}

Delete a JSON bin.

POST/storage/json/del

Header parameters

Body

binId*string

The ID of the JSON bin.

Response

Success

Body

message*string

A message describing the status.

Request

const response = await fetch('/storage/json/del', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "binId": "text"
    }),
});
const data = await response.json();

Response

{
  "message": "text"
}

Put data into JSON bin.

Replaces the data in the JSON bin with the new data.

POST/storage/json/put

Header parameters

Body

json*any

The JSON data to put into the bin.

binId*string

The ID of the JSON bin that will be modified.

Response

Success

Body

binId*string

The ID of the JSON bin that was modified.

Request

const response = await fetch('/storage/json/put', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "binId": "text"
    }),
});
const data = await response.json();

Response

{
  "binId": "text"
}

Get a JSON bin.

POST/storage/json/get

Header parameters

Body

binId*string

The ID of the JSON bin.

Response

Success

Body

binId*string

The ID of the JSON bin.

data*any

The content of the JSON bin.

Request

const response = await fetch('/storage/json/get', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "binId": "text"
    }),
});
const data = await response.json();

Response

{
  "binId": "text"
}

List JSON bins.

Returns a list of the bin IDs of all JSON bins this user has created.

POST/storage/json/list

Header parameters

Body

object

Response

Success

Body

message*string

A message describing the status.

bins*array of object

The available JSON bins for this user.

Request

const response = await fetch('/storage/json/list', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "text",
  "bins": [
    {
      "binId": "text"
    }
  ]
}

Add a JSON bin.

POST/storage/json/add

Header parameters

Body

json*any

The JSON data to store in the bin.

Response

Success

Body

message*string

A message describing the status.

binId*string

The ID that was assigned to this JSON bin.

Request

const response = await fetch('/storage/json/add', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "text",
  "binId": "text"
}

Retrieve calendar weeks

This endpoint can be used to return varied calendar-week information according to the data passed in the request.

POST/dateandtime/calendarweek

Header parameters

Body

datestring

The date parameter provides the week number of the year relative to the date, along with the starting and ending week.

Example: "20.01.2022"

weekNumbernumber

The weekNumber parameter provides the workingDate of that week, along with the starting and ending day of the week.

Example: 5

yearnumber

The year parameter provides year of the given weekNumber.

Example: 2023

unixTimestampnumber

The date in unixTimestamp format.

Example: 1642918727

dateFormatstring

Format of provided date.

Example: "DD.MM.YYYY"

outputFormatstring

Format of the output date

Example: "DD.MM.YYYY"

Response

Success

Body

workingDate*string

weekNumber*number

firstDayOfWeek*string

lastDayOfWeek*string

Request

const response = await fetch('/dateandtime/calendarweek', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "workingDate": "text",
  "weekNumber": 0,
  "firstDayOfWeek": "text",
  "lastDayOfWeek": "text"
}

Check weekend date.

Determine if a given date is a weekend, retrieve the day number, and get the weekday.

POST/dateandtime/isweekend

Header parameters

Body

date*string

The date for which information is requested.

dateFormatstring

The format of the input date.

timeZonestring

The timezone

Response

Success

Body

dayNumber*number

weekDay*string

isWeekend*boolean

Request

const response = await fetch('/dateandtime/isweekend', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "date": "text"
    }),
});
const data = await response.json();

Response

{
  "dayNumber": 0,
  "weekDay": "text",
  "isWeekend": false
}

Convert between timezones.

Converts a date and time from one timezone to another.

POST/dateandtime/switchtimezone

Header parameters

Body

inputTime*any of

The time that will be converted.

Example: "08-12-2024 12:00"

inputTimeZone*string

The timezone of the input time.

Example: "Europe/Berlin"

formatPatternstring

The format of the output time.

destinationTimeZone*string

The timezone of the output time.

Response

Success

Body

convertedTime*string

timeZone*string

Request

const response = await fetch('/dateandtime/switchtimezone', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "inputTime": "08-12-2024 12:00",
      "inputTimeZone": "Europe/Berlin",
      "destinationTimeZone": "text"
    }),
});
const data = await response.json();

Response

{
  "convertedTime": "text",
  "timeZone": "text"
}

Retrieve holidays.

This API retrieve a list of holidays for a specific year, country code, and optionally state.

POST/dateandtime/holidays

Header parameters

Body

year*number

The year for which holidays are requested.

Example: 2022

countryCode*string

The ISO 3166-1 alpha-2 country code.

Example: "AT"

statestring

The state within the country (if applicable).

Response

Success

Body

holidays*array of object

Request

const response = await fetch('/dateandtime/holidays', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "year": 2022,
      "countryCode": "AT"
    }),
});
const data = await response.json();

Response

{
  "holidays": [
    {
      "date": "text",
      "start": "2024-12-21T12:24:37.283Z",
      "end": "2024-12-21T12:24:37.283Z",
      "name": "text",
      "type": "text",
      "rule": "text"
    }
  ]
}

Retrieve date range details.

This API calculates month, year, start date, end date, and weekdays within a specified duration from a given start date.

POST/dateandtime/detailperiod

Header parameters

Body

startDate*string

Starting date.

Example: "2023-06-07"

duration*number

Duration of days for which the detail period is retrieved.

Example: 41

Response

Success

Body

monthArray*array of object

Request

const response = await fetch('/dateandtime/detailperiod', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "startDate": "2023-06-07",
      "duration": 41
    }),
});
const data = await response.json();

Response

{
  "monthArray": [
    {
      "month": 0,
      "year": 0,
      "startDate": "text",
      "endDate": "text",
      "weekDaysWithinPeriod": 0
    }
  ]
}

Monthly date details

This retrieves all workdays, saturdays, sundays, and days in the month based on the month, year, and date provided.

POST/dateandtime/month

Header parameters

Body

datestring

Date parameter

dateFormatstring

Format of the input date

monthnumber

Number of the month.

yearnumber

Year

outputFormatstring

Format of the output date

optionsobject

Response

Success

Body

daysInMonth*number

lastDayOfMonth*any of

firstDayOfMonth*any of

workdays*array of any of

saturdays*array of any of

sundays*array of any of

lastWorkdayOfMonth*any of

workdaysReversed*array of any of

Request

const response = await fetch('/dateandtime/month', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "daysInMonth": 0,
  "lastDayOfMonth": "text",
  "firstDayOfMonth": "text",
  "workdays": [
    "text"
  ],
  "saturdays": [
    "text"
  ],
  "sundays": [
    "text"
  ],
  "lastWorkdayOfMonth": "text",
  "workdaysReversed": [
    "text"
  ]
}

Check auth status.

POST/1saas/auth

Header parameters

Body

object

Response

Success

Body

message*string

An explaining message.

Example: "You are authorized."

Request

const response = await fetch('/1saas/auth', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "You are authorized."
}

Generate a city.

POST/generate/city

Header parameters

Body

object

Response

Success

Body

city*string

The random city name.

Example: "Fort Marjorie"

country*string

The random country name.

Example: "Timor-Leste"

Request

const response = await fetch('/generate/city', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "city": "Fort Marjorie",
  "country": "Timor-Leste"
}

Generate a number.

POST/generate/number

Header parameters

Body

range*array of number

The range of the generated number.

typeenum

The type of generated number. Default is integer.

decimalfloatinteger

roundnumber

The number of decimal places the generated number has. This is only used if type is decimal or float.

Response

Success

Body

randomNumber*number

Request

const response = await fetch('/generate/number', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "range": [
        0
      ]
    }),
});
const data = await response.json();

Response

{
  "randomNumber": 0
}

Generate random string.

Generate random string based on type and length.

POST/generate/string

Header parameters

Body

typeenum

Type of randomness. Specifies the character set to use when generating the random string.

12345678

length*number

Type of randomness. Specifies the character set to use when generating the random string. The available types are:

1: Numbers only (0-9).
2: Alphabetical characters (both upper and lower case, A-Z, a-z).
3: Lowercase alphabetical characters only (a-z).
4: Uppercase alphabetical characters only (A-Z).
5: Alphanumeric characters with lowercase letters (a-z, 0-9).
6: Alphanumeric characters with uppercase letters (A-Z, 0-9).
7: Complex characters including special symbols (e.g., !, @, #, etc.).
8: Custom character set, which requires a custom array of characters to be provided.

customarray of string

An array of custom characters to use for generating the random string. Required if type is set to 8.

Response

Success

Body

randomString*string

Request

const response = await fetch('/generate/string', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "length": 0
    }),
});
const data = await response.json();

Response

{
  "randomString": "text"
}

Generate a name.

POST/generate/name

Header parameters

Body

genderenum

malefemale

Response

Success

Body

firstName*string

middleName*string

lastName*string

completeName*string

completeNameWithMiddleName*string

Request

const response = await fetch('/generate/name', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "firstName": "text",
  "middleName": "text",
  "lastName": "text",
  "completeName": "text",
  "completeNameWithMiddleName": "text"
}

Generate a color.

POST/generate/color

Header parameters

Body

hueany of

The hue of the generated color. Default is random.

luminosityenum

The luminosity of the generated color. Default is random.

brightlightdark

seedany of

A number or string that is used as a seed for the random number generator. By default, no seed is used.

formatenum

The format of the returned color. These are the possible formats:

rgb: rgb(0, 0, 0)
rgba: rgba(0, 0, 0, 0)
hsl: hsl(0, 0%, 0%)
hsla: hsla(0, 0%, 0%, 0)
hex: #000000

Default is hex.

rgbrgbahslhslahex

alphanumber

A decimal between 0 and 1 that specifies the value of the alpha channel. This is only relevant when using a format with an alpha channel. Default is a random value.

Response

Success

Body

color*string

Request

const response = await fetch('/generate/color', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "color": "text"
}

Generate user mockdata.

POST/generate/mockdata/user

Header parameters

Body

amountnumber

The amount of users to generate. Default is 1.

emailRequiredboolean

avatarRequiredboolean

passwordRequiredboolean

birthDateRequiredboolean

usernameRequiredboolean

addressRequiredboolean

cityRequiredboolean

countryRequiredboolean

phoneRequiredboolean

createdAtRequiredboolean

balanceRequiredboolean

Response

Success

Body

users*array of object

Request

const response = await fetch('/generate/mockdata/user', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "users": [
    {
      "id": "text",
      "name": "text",
      "lastName": "text",
      "email": "text",
      "avatar": "text",
      "password": "text",
      "birthDate": "text",
      "username": "text",
      "address": "text",
      "city": "text",
      "country": "text",
      "phone": "text",
      "createdAt": "text",
      "balance": 0
    }
  ]
}

Scrape website.

POST/generate/html-scrape

Header parameters

Body

url*string

textOnlyboolean

Response

Success

Body

data*string

Request

const response = await fetch('/generate/html-scrape', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "text"
    }),
});
const data = await response.json();

Response

{
  "data": "text"
}

Encode JWT.

POST/generate/jsonwebtoken/encode

Header parameters

Body

data*any

secret*string

optionsobject

Response

Success

Body

token*string

The encoded JWT.

Request

const response = await fetch('/generate/jsonwebtoken/encode', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "secret": "text"
    }),
});
const data = await response.json();

Response

{
  "token": "text"
}

Decode JWT.

POST/generate/jsonwebtoken/decode

Header parameters

Body

token*string

verifyboolean

Whether to verify the JWT. This requires secret. Default is false.

secretstring

The HMAC secret or PEM-encoded public key.

optionsobject

Response

Success

Body

any

The JWT payload.

Request

const response = await fetch('/generate/jsonwebtoken/decode', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "token": "text"
    }),
});
const data = await response.json();

Response

{
  "status": 0,
  "errorMessage": "text"
}

Generate a QR code.

Returns a QR code as a PNG image, styled using the provided settings.

POST/generate/qrcode/encode

Header parameters

Body

data*string

The data that should be encoded

Example: "https://wemakefuture.com"

widthnumber

The width of the QR code in pixels. Default is 500.

Example: 500

heightnumber

The height of the QR code in pixels. Default is 500.

Example: 500

imagestring

The URL of the image that should be put in the middle. By default, no image is used. The image covers up part of the QR code, which can only be recovered using error correction.

Example: "https://pbs.twimg.com/profile_images/1325818753842618384/I9aD7jAt_400x400.jpg"

marginnumber

The size of the space between the QR code and the border of the image in pixels. Default is 15.

Example: 15

qrOptionsobject

Options for the QR code data.

imageOptionsobject

Options for the image in the center of the QR code.

dotsOptionsobject

Options for the dots that make up most of the QR code.

cornersSquareOptionsobject

Options for the corner squares. This does not influence the smaller dots inside the corner squares.

cornersDotOptionsobject

Options for the corner dots. This does not influence the square border around the corner dots.

Response

Success

Body

imageUrl*string

fileName*string

Request

const response = await fetch('/generate/qrcode/encode', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "data": "https://wemakefuture.com"
    }),
});
const data = await response.json();

Response

{
  "imageUrl": "text",
  "fileName": "text"
}

Decode a QR code.

Decodes a QR code from a URL or buffer and returns the encoded data. The supported file formats are jpg, png, bmp, tiff, gif.

POST/generate/qrcode/decode

Header parameters

Body

urlstring

The URL to the QR code.

bufferstring

The QR code as a Base64-encoded buffer. Can be used instead of url.

Response

Success

Body

data*string

The data contained in the QR code.

Request

const response = await fetch('/generate/qrcode/decode', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "data": "text"
}

Decode barcode.

POST/generate/barcode/decode

Header parameters

Body

urlstring

bufferstring

barcode*enum

The barcode format.

code-128code-2of5code-39code-93ean-13ean-8coabar

Response

Success

Body

code*string

The code extracted from the barcode.

Request

const response = await fetch('/generate/barcode/decode', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "barcode": "code-128"
    }),
});
const data = await response.json();

Response

{
  "code": "text"
}

Generate barcode.

POST/generate/barcode/encode

Header parameters

Body

data*string

optionsobject

formatenum

The generated file type. Default is svg.

svgpngjpeg

getAsUrlboolean

Whether to get as URL or buffer. Default is buffer.

fileNamestring

Response

Success

Body

url*string

The barcode URL.

fileName*string

Request

const response = await fetch('/generate/barcode/encode', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "data": "text"
    }),
});
const data = await response.json();

Response

{
  "url": "text",
  "fileName": "text"
}

Evaluate text against a regex.

Evaluates a given text against a provided regular expression and returns the matches.

POST/text/regex

Header parameters

Body

text*string

The text to be evaluated.

Example: "The quick brown fox jumps over the lazy dog."

expression*string

The regular expression to evaluate against the text.

Example: "\\b\\w{4}\\b"

Response

Success

Body

matches*array of string

The list of matches found in the text.

isValidRegex*boolean

Whether the provided regular expression was valid.

Request

const response = await fetch('/text/regex', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "text": "The quick brown fox jumps over the lazy dog.",
      "expression": "\\b\\w{4}\\b"
    }),
});
const data = await response.json();

Response

{
  "matches": [
    "text"
  ],
  "isValidRegex": false
}

Keyword search in text.

Searches text for keywords and returns their positions.

POST/text/contains

Header parameters

Body

text*string

Text from which you want to find keywords.

keywordstring

Single keyword.

keywordListarray of string

Multiple keywords.

optionsobject

Response

Success

Body

findings*array of object

Request

const response = await fetch('/text/contains', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "text": "text"
    }),
});
const data = await response.json();

Response

{
  "findings": [
    {
      "keyword": "text",
      "contains": false,
      "foundPositions": [
        0
      ]
    }
  ]
}

Compare two strings.

Calculate similarity score between two strings

POST/text/comparestring

Header parameters

Body

string1*string

First String.

string2*string

Second String.

algorithmstring

Similarity algorithm.

Response

Success

Body

similarity*number

distance*number

Request

const response = await fetch('/text/comparestring', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "string1": "text",
      "string2": "text"
    }),
});
const data = await response.json();

Response

{
  "similarity": 0,
  "distance": 0
}

Extract text from body.

Extracts text from body between given start and end markers

POST/text/extractor

Header parameters

Body

start*string

Start marker.

end*string

End marker.

body*string

Body from which to extract the text

greedyboolean

When true, It include start and end marker in result.

caseSensitiveboolean

When true, It make the body case sensitive.

returnEmptyIfNotFoundboolean

When true, Return error if markers not found.

Response

Success

Body

text*string

Request

const response = await fetch('/text/extractor', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "start": "text",
      "end": "text",
      "body": "text"
    }),
});
const data = await response.json();

Response

{
  "text": "text"
}

Execute Python code.

POST/python

Header parameters

Body

code*string

The Python code that will be executed.

requirementsarray of string

The PyPI libraries your Python code requires. For backwards compatibility, this can be left empty, and your dependencies will be discovered automatically. Please do not use this and specify your requirements explicitly, as the automatic discovery is inaccurate and unreliable, and its only purpose is to prevent old code from breaking.

Response

Success

Body

result*any

The data returned by the Python code.

Request

const response = await fetch('/python', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "code": "text"
    }),
});
const data = await response.json();

Response

{}

Note on the Asynchronous Python Code Executor Pricing

The cost of the asynchronous Python code executor is proportional to that of the regular synchronous Python executor. The key difference is that the asynchronous endpoint allows your code to run up to 5 times longer, with a maximum total runtime of 15 minutes.

Charges are applied every 3 minutes, which is the standard execution time increment for the synchronous Python executor.
You are charged for each 3-minute interval (or part thereof) that your code runs asynchronously.

Execute async Python.

Execute a Python script and return immediately. The response is sent to a webhook.

POST/async-python

Header parameters

Body

code*string

The Python script that will be executed.

requirementsarray of string

The PyPI libraries your Python code requires.

sendTostring

The URL of the webhook the response will be sent to.

Response

Success

Body

status*string

taskId*string

Request

const response = await fetch('/async-python', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "code": "text"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "taskId": "text"
}

Execute JavaScript code.

POST/javascript

Header parameters

Body

code*string

The JavaScript code that will be executed.

Response

Success

Body

any

The data returned by the JavaScript code.

Request

const response = await fetch('/javascript', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "code": "text"
    }),
});
const data = await response.json();

Response

{
  "status": 0,
  "errorMessage": "text"
}

Get async task status.

POST/taskstatus

Header parameters

Body

taskId*string

The ID of the task that will be checked.

Response

Success

Body

status*string

resultstring

Request

const response = await fetch('/taskstatus', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "taskId": "text"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "result": "text"
}

Generate Bar Chart

This endpoint generates a bar chart image based on the provided data, labels, and customization options.

POST/chart/bars

Header parameters

Body

data*array of number

Data points for the bar chart.

labels*array of string

Labels corresponding to the data points.

getAsUrlboolean

If true, returns a URL instead of the chart image.

widthnumber

Width of the chart image.

heightnumber

Height of the chart image.

backgroundColorstring

Background color of the chart image.

bordersColorsarray of string

Colors for the borders of the bars.

barsColorsarray of string

Colors for the bars in the chart.

borderWidthnumber

Width of the borders around the bars.

titlestring

Title of the chart.

optionsobject

Additional configuration options for Chart.js.

fileNamestring

Optional filename for the generated chart image.

Response

Success

Body

url*string

The result image URL.

Request

const response = await fetch('/chart/bars', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "data": [
        0
      ],
      "labels": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

{
  "url": "text"
}

Generate Doughnut Chart

This endpoint generates a doughnut chart image based on the provided data, labels, and customization options.

POST/chart/doughnut

Header parameters

Body

data*array of number

Data points for the doughnut chart.

labels*array of string

Labels corresponding to the data points.

getAsUrlboolean

If true, returns a URL instead of the chart image.

widthnumber

Width of the chart image.

heightnumber

Height of the chart image.

backgroundColorstring

Background color of the chart image.

bordersColorsarray of string

Colors for the borders of the doughnut.

barsColorsarray of string

Colors for the doughnut in the chart.

borderWidthnumber

Width of the borders around the doughnut.

titlestring

Title of the chart.

optionsobject

Additional configuration options for Chart.js.

fileNamestring

Optional filename for the generated chart image.

Response

Success

Body

url*string

The result image URL.

Request

const response = await fetch('/chart/doughnut', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "data": [
        0
      ],
      "labels": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

{
  "url": "text"
}

Generate Line Chart

This endpoint generates a line chart image based on the provided data, labels, and customization options.

POST/chart/line

Header parameters

Body

data*array of number

Data points for the line chart.

labels*array of string

Labels corresponding to the data points.

getAsUrlboolean

If true, returns a URL instead of the chart image.

widthnumber

Width of the chart image.

heightnumber

Height of the chart image.

backgroundColorstring

Background color of the chart image.

bordersColorsarray of string

Colors for the borders of the line.

barsColorsarray of string

Colors for the line in the chart.

fillboolean

Fill the color under the line.

tensionnumber

Tension of the line.

borderWidthnumber

Width of the borders around the line.

titlestring

Title of the chart.

optionsobject

Additional configuration options for Chart.js.

fileNamestring

Optional filename for the generated chart image.

Response

Success

Body

url*string

The result image URL.

Request

const response = await fetch('/chart/line', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "data": [
        0
      ],
      "labels": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

{
  "url": "text"
}

Blur an image.

POST/image/blur

Header parameters

Body

urlstring

The image URL

bufferstring

The image as a Base64-encoded buffer. Can be specified instead of url.

sigmanumber

How strongly the image will be blurred.

getAsUrlboolean

Whether the result image should be returned as a URL. Default is false.

fileNamestring

The file name of the result image. Default is a random ID.

Response

Success

Body

url*string

The result image URL.

Request

const response = await fetch('/image/blur', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "url": "text"
}

Convert an image.

POST/image/convert

Header parameters

Body

urlstring

The image URL

bufferstring

The image as a Base64-encoded buffer. Can be specified instead of url.

outputFormat*enum

The output format of the conversion.

jpegjpgpnggiftiffwebp

withMetaDataboolean

Whether the image metadata should be converted, too.

optionsobject

getAsUrlboolean

Whether the result image should be returned as a URL. Default is false.

fileNamestring

The file name of the result image. Default is a random ID.

Response

Success

Body

url*string

The result image URL.

Request

const response = await fetch('/image/convert', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "outputFormat": "jpeg"
    }),
});
const data = await response.json();

Response

{
  "url": "text"
}

Get EXIF data.

POST/image/exif

Header parameters

Body

urlstring

The image URL

bufferstring

The image as a Base64-encoded buffer. Can be specified instead of url.

Response

Success

Body

exifData*any

The EXIF data of the image. For details, see https://exiv2.org/tags.html.

Request

const response = await fetch('/image/exif', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{}

Crop an image.

POST/image/crop

Header parameters

Body

urlstring

The image URL

bufferstring

The image as a Base64-encoded buffer. Can be specified instead of url.

options*object

getAsUrlboolean

Whether the result image should be returned as a URL. Default is false.

fileNamestring

The file name of the result image. Default is a random ID.

Response

Success

Body

url*string

The result image URL.

Request

const response = await fetch('/image/crop', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "options": {
        "left": 100,
        "top": 100,
        "width": 500,
        "height": 500
      }
    }),
});
const data = await response.json();

Response

{
  "url": "text"
}

Flip an image.

POST/image/flip

Header parameters

Body

urlstring

The image URL

bufferstring

The image as a Base64-encoded buffer. Can be specified instead of url.

axis*enum

The axis the image will be flipped about.

XxYy

getAsUrlboolean

Whether the result image should be returned as a URL. Default is false.

fileNamestring

The file name of the result image. Default is a random ID.

Response

Success

Body

url*string

The result image URL.

Request

const response = await fetch('/image/flip', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "axis": "X"
    }),
});
const data = await response.json();

Response

{
  "url": "text"
}

Convert HTML to image.

POST/image/html

Header parameters

Body

urlstring

The image URL

htmlstring

The HTML source. Can be specified instead of url.

optionsobject

getAsUrlboolean

Whether the result image should be returned as a URL. Default is false.

fileNamestring

The file name of the result image. Default is a random ID.

Response

Success

Body

url*string

The result image URL.

Request

const response = await fetch('/image/html', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "url": "text"
}

Overlay two images.

POST/image/overlay

Header parameters

Body

frontImageUrl*string

The URL of the front image.

backImageUrl*string

The URL of the background image.

positionenum

The position of the front image on the back image. This overrides options.horizontalPosition and options.verticalPosition.

centertop-lefttop-rightbottom-leftbottom-right

getAsUrlboolean

Whether to return the result as a buffer or a URL. Default is buffer.

optionsobject

fileNamestring

A custom file name. If this is not set, a randomly generated is used instead.

Response

Success

Body

url*string

The URL of the overlayed image. Only available if getAsUrl is true.

fileNamestring

The filename of the image, if one was provided.

Request

const response = await fetch('/image/overlay', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "frontImageUrl": "text",
      "backImageUrl": "text"
    }),
});
const data = await response.json();

Response

{
  "url": "text",
  "fileName": "text"
}

Resize an image.

POST/image/resize

Header parameters

Body

urlstring

bufferstring

widthnumber

heightnumber

optionsobject

getAsUrlboolean

fileNamestring

Response

Success

Body

object

Request

const response = await fetch('/image/resize', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{}

Rotate an image.

POST/image/rotate

Header parameters

Body

urlstring

The image URL

bufferstring

The image as a Base64-encoded buffer. Can be specified instead of url.

angle*number

The clockwise rotation.

backgroundstring

The color of the space that is not occupied by the image after the rotation. Only used if angle is not a multiple of 90 degrees. Default is #000000.

Example: "#000000"

getAsUrlboolean

Whether the result image should be returned as a URL. Default is false.

fileNamestring

The file name of the result image. Default is a random ID.

Response

Success

Body

url*string

The result image URL.

Request

const response = await fetch('/image/rotate', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "angle": 0
    }),
});
const data = await response.json();

Response

{
  "url": "text"
}

Sharpen an image.

POST/image/sharpen

Header parameters

Body

urlstring

The image URL

bufferstring

The image as a Base64-encoded buffer. Can be specified instead of url.

sigmanumber

How strongly the image will be sharpened.

getAsUrlboolean

Whether the result image should be returned as a URL. Default is false.

fileNamestring

The file name of the result image. Default is a random ID.

Response

Success

Body

url*string

The result image URL.

Request

const response = await fetch('/image/sharpen', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "url": "text"
}

Draw image on PDF.

POST/pdf/draw/image

Header parameters

Body

urlstring

The PDF URL.

bufferstring

The PDF as a Base64-encoded buffer. Can be specified instead of url.

getAsUrlboolean

Whether the result PDF should be returned as a URL. Default is false.

Example: true

imageUrlstring

The URL of the image to draw.

imageBufferstring

T?he image as a Base64-encoded buffer. Can be specified instead of imageUrl.

anchorenum

The part of the page on which the image should be drawn. Default is center.

Example: "center"

bottom-leftbottombottom-rightleftcenterrighttop-lefttoptop-right

alignenum

The part of the image that should be aligned with the specified position. Default is the value of anchor.

Example: "center"

bottom-leftbottombottom-rightleftcenterrighttop-lefttoptop-right

xnumber

The horizontal offset in points relative to the anchor. Default is 0.

Example: 0

ynumber

The vertical offset in points relative to the anchor. Default is 0.

Example: 0

widthnumber

The width of the image in points. This or height has to be provided. If only width is provided, height is calculated automatically.

Example: 200

heightnumber

The height of the image in points. This or width has to be provided. If only height is provided, width is calculated automatically.

Example: 100

rotatenumber

The counter-clockwise rotation of the image in degrees. Default is 0.

Example: 45

pagesstring

The pages the image should be drawn onto. Given as a range of pages, where 1 means the first page and ^1 means the last page.

fileNamestring

The file name the result PDF will have. Default is a random ID.

Response

Success

Body

object

Request

const response = await fetch('/pdf/draw/image', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{}

Draw text on PDF.

POST/pdf/draw/text

Header parameters

Body

urlstring

The PDF URL.

bufferstring

The PDF as a Base64-encoded buffer. Can be specified instead of url.

getAsUrlboolean

Whether the result PDF should be returned as a URL. Default is false.

Example: true

text*string

The text to draw.

Example: "Hello, world!"

fontenum

The font to use. Default is Helvetica.

Example: "Helvetica"

HelveticaCourierTimesRoman

anchorenum

The part of the page on which the text should be drawn. Default is center.

Example: "center"

bottom-leftbottombottom-rightleftcenterrighttop-lefttoptop-right

alignenum

The part of the text that should be aligned with the specified position. Default is the value of anchor.

Example: "center"

bottom-leftbottombottom-rightleftcenterrighttop-lefttoptop-right

xnumber

The horizontal offset in points relative to the anchor. Default is 0.

Example: 0

ynumber

The vertical offset in points relative to the anchor. Default is 0.

Example: 0

rotatenumber

The counter-clockwise rotation of the text in degrees. Default is 0.

Example: 45

sizenumber

The font size in points. Default is 32.

Example: 32

colorstring

The font color as a six-digit hexcode, i.e. RRGGBB. Default is 000000, i.e. black.

Example: "FFFF00"

pagesstring

The pages the text should be drawn onto. Given as a range of pages, where 1 means the first page and ^1 means the last page.

Example: "1,3-5,^3-^1"

fileNamestring

The file name the result PDF will have. Default is a random ID.

Response

Success

Body

url*string

The result PDF URL.

Request

const response = await fetch('/pdf/draw/text', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "text": "Hello, world!"
    }),
});
const data = await response.json();

Response

{
  "url": "text"
}

Edit PDF metadata.

POST/pdf/metadata/edit

Header parameters

Body

urlstring

The PDF URL.

bufferstring

The PDF as a Base64-encoded buffer. Can be specified instead of url.

getAsUrlboolean

Whether the result PDF should be returned as a URL. Default is false.

Example: true

titlestring

The new title of the PDF.

authorstring

The new author of the PDF.

subjectstring

The new subject of the PDF.

keywordsarray of string

The new keywords of the PDF.

fileNamestring

The file name of the result PDF. Default is a random ID.

Response

Success

Body

url*string

The result PDF URL.

Request

const response = await fetch('/pdf/metadata/edit', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "url": "text"
}

Get PDF metadata.

POST/pdf/metadata/info

Header parameters

Body

urlstring

The PDF URL.

bufferstring

The PDF as a Base64-encoded buffer. Can be specified instead of url.

Response

Success

Body

titlestring

The title of the PDF.

authorstring

The author of the PDF.

subjectstring

The subject of the PDF.

keywordsarray of string

The keywords of the PDF.

creatorstring

The creator of the PDF, which is the software used to design it.

creationDatestring (date-time)

The creation date of the PDF.

modificationDatestring (date-time)

The last modification date of the PDF.

isEncrypted*boolean

Whether the PDF is encrypted.

pageCount*number

The page count of the PDF.

pages*array of object

Request

const response = await fetch('/pdf/metadata/info', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "title": "text",
  "author": "text",
  "subject": "text",
  "keywords": [
    "text"
  ],
  "creator": "text",
  "creationDate": "2024-12-21T12:24:37.283Z",
  "modificationDate": "2024-12-21T12:24:37.283Z",
  "isEncrypted": false,
  "pageCount": 0,
  "pages": [
    {
      "width": 0,
      "height": 0,
      "rotation": 0
    }
  ]
}

Add PDF pages.

POST/pdf/pages/add

Header parameters

Body

urlstring

The PDF URL.

bufferstring

The PDF as a Base64-encoded buffer. Can be specified instead of url.

getAsUrlboolean

Whether the result PDF should be returned as a URL. Default is false.

Example: true

widthnumber

The width of the pages to add. Default is the width of the first page.

Example: 595

heightnumber

The height of the pages to add. Default is the height of the first page.

Example: 842

pages*array of number

The positions of the pages that should be added. Every number represents one page, and is the page number after which the new page should be added, e.g. 0 means inserting at the very beginning, while 10 means inserting after the 10th page.

fileNamestring

The file name of the result PDF. Default is a random ID.

Response

Success

Body

url*string

The result PDF URL.

Request

const response = await fetch('/pdf/pages/add', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "pages": [
        0
      ]
    }),
});
const data = await response.json();

Response

{
  "url": "text"
}

Remove PDF pages.

POST/pdf/pages/remove

Header parameters

Body

urlstring

The PDF URL.

bufferstring

The PDF as a Base64-encoded buffer. Can be specified instead of url.

getAsUrlboolean

Whether the result PDF should be returned as a URL. Default is false.

Example: true

pages*string

The pages that should be removed from the PDF. Given as a range of pages, where 1 means the first page and ^1 means the last page.

Example: "1,3-5,^3-^1"

fileNamestring

The file name of the result PDF. Default is a random ID.

Response

Success

Body

url*string

The result PDF URL.

Request

const response = await fetch('/pdf/pages/remove', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "pages": "1,3-5,^3-^1"
    }),
});
const data = await response.json();

Response

{
  "url": "text"
}

Resize PDF pages.

POST/pdf/pages/resize

Header parameters

Body

urlstring

The PDF URL.

bufferstring

The PDF as a Base64-encoded buffer. Can be specified instead of url.

getAsUrlboolean

Whether the result PDF should be returned as a URL. Default is false.

Example: true

width*number

The new width in points.

height*number

The new height in points.

pages*string

The pages that should be resized. Given as a range of pages, where 1 means the first page and ^1 means the last page.

Example: "1,3-5,^3-^1"

fileNamestring

The file name of the result PDF. Default is a random ID.

Response

Success

Body

url*string

The result PDF URL.

Request

const response = await fetch('/pdf/pages/resize', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "width": 0,
      "height": 0,
      "pages": "1,3-5,^3-^1"
    }),
});
const data = await response.json();

Response

{
  "url": "text"
}

Rotate PDF pages.

POST/pdf/pages/rotate

Header parameters

Body

urlstring

The PDF URL.

bufferstring

The PDF as a Base64-encoded buffer. Can be specified instead of url.

getAsUrlboolean

Whether the result PDF should be returned as a URL. Default is false.

Example: true

rotate*number

Clockwise rotation of the pages in degrees. Must be a multiple of 90.

Example: 90

pages*string

The pages that will be rotated. Given as a range of pages, where 1 means the first page and ^1 means the last page.

Example: "1,3-5,^3-^1"

fileNamestring

The file name of the result PDF. Default is a random ID.

Response

Success

Body

url*string

The result PDF URL.

Request

const response = await fetch('/pdf/pages/rotate', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "rotate": 90,
      "pages": "1,3-5,^3-^1"
    }),
});
const data = await response.json();

Response

{
  "url": "text"
}

Convert PDF to Base64.

POST/pdf/base64

Header parameters

Body

pdf*string

The PDF URL.

fileNamestring

The file name will be returned again. If none is provided, one will be generated automatically.

Response

Success

Body

pdfBase64*string

The Base64-encoded PDF buffer.

fileName*string

The provided file name or an auto-generated one.

Request

const response = await fetch('/pdf/base64', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "pdf": "text"
    }),
});
const data = await response.json();

Response

{
  "pdfBase64": "text",
  "fileName": "text"
}

Compress PDF.

POST/pdf/compress

Header parameters

Body

urlstring

bufferstring

getAsUrlboolean

fileNamestring

Response

Success

Body

url*string

Request

const response = await fetch('/pdf/compress', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "url": "text"
}

Count PDF pages.

POST/pdf/count

Header parameters

Body

urlstring

The PDF URL.

bufferstring

The PDF as a Base64-encoded buffer. Can be specified instead of url.

Response

Success

Body

pageCount*number

The number of pages in the PDF.

Request

const response = await fetch('/pdf/count', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "pageCount": 0
}

Decrypt PDF.

POST/pdf/decrypt

Header parameters

Body

urlstring

The PDF URL.

bufferstring

The PDF as a Base64-encoded buffer. Can be specified instead of url.

getAsUrlboolean

Whether the result PDF should be returned as a URL. Default is false.

Example: true

password*string

The password used to decrypt the PDF. Can be either the user or the owner password.

Response

Success

Body

url*string

The result PDF URL.

Request

const response = await fetch('/pdf/decrypt', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "password": "text"
    }),
});
const data = await response.json();

Response

{
  "url": "text"
}

Create empty PDF.

POST/pdf/create

Header parameters

Body

getAsUrlboolean

Whether the result PDF should be returned as a URL. Default is false.

Example: true

pagesnumber

The number of pages the new PDF should have. Must be at least 1. Default is 1.

Example: 10

widthnumber

The width of the pages in points. Default is 595.

Example: 595

heightnumber

The height of the pages in points. Default is 842.

Example: 842

fileNamestring

The file name the result PDF will have. Default is a random ID.

Response

Success

Body

url*string

The result PDF URL.

Request

const response = await fetch('/pdf/create', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "url": "text"
}

Convert DOCX to PDF.

POST/pdf/docx-to-pdf

Header parameters

Body

urlstring

The DOCX URL.

bufferstring

The DOCX as a Base64-encoded buffer. Can be specified instead of url.

getAsUrlboolean

Whether the result PDF should be returned as a URL. Default is false.

Example: true

fileNamestring

The file name of the result PDF. Default is a random ID.

Response

Success

Body

url*string

The result PDF URL.

Request

const response = await fetch('/pdf/docx-to-pdf', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "url": "text"
}

Encrypt PDF.

POST/pdf/encrypt

Header parameters

Body

urlstring

The PDF URL.

bufferstring

The PDF as a Base64-encoded buffer. Can be specified instead of url.

getAsUrlboolean

Whether the result PDF should be returned as a URL. Default is false.

Example: true

userPassword*string

The user password.

ownerPasswordstring

The owner password. Default is the user password.

Response

Success

Body

url*string

The result PDF URL.

Request

const response = await fetch('/pdf/encrypt', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "userPassword": "text"
    }),
});
const data = await response.json();

Response

{
  "url": "text"
}

Get PDF metadata.

WARNING: This endpoint is deprecated. Please use /pdf/metadata/info instead.

POST/pdf/getinfometadata

Header parameters

Body

pdf*string

The PDF URL or Base64-encoded buffer.

filenamestring

The PDF file name. Default is a random ID.

Response

Success

Body

titlestring

The title of the PDF.

authorstring

The author of the PDF.

producerstring

The producer of the PDF.

creatorstring

The creator of the PDF, which is the software used to design it.

creationDatestring (date-time)

The creation date of the PDF.

modificationDatestring (date-time)

The last modification date of the PDF.

pageCount*number

The page count of the PDF.

filename*string

The file name that was passed in the request, or a random ID.

Request

const response = await fetch('/pdf/getinfometadata', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "pdf": "text"
    }),
});
const data = await response.json();

Response

{
  "title": "text",
  "author": "text",
  "producer": "text",
  "creator": "text",
  "creationDate": "2024-12-21T12:24:37.283Z",
  "modificationDate": "2024-12-21T12:24:37.283Z",
  "pageCount": 0,
  "filename": "text"
}

Convert HTML to PDF.

POST/pdf/html

Header parameters

Body

urlstring

The URL of the website.

htmlstring

The HTML source. Can be specified instead of url

getAsUrlboolean

Whether the result PDF should be returned as a URL. Default is false.

Example: true

fileNamestring

The PDF file name. Default is a random ID.

optionsobject

Response

Success

Body

url*string

Request

const response = await fetch('/pdf/html', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "url": "text"
}

Convert Markdown to PDF.

POST/pdf/markdownstringtopdf

Header parameters

Body

markdownString*string

The Markdown source that will be converted to a PDF.

cssstring

Custom CSS to change the Markdown look.

getAsUrlboolean

Whether the result PDF should be returned as a URL. Default is false.

Example: true

fileNamestring

The PDF file name. Default is a random ID.

Response

Success

Body

url*string

Request

const response = await fetch('/pdf/markdownstringtopdf', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "markdownString": "text"
    }),
});
const data = await response.json();

Response

{
  "url": "text"
}

Merge PDF files.

POST/pdf/merge

Header parameters

Body

files*array of object

getAsUrlboolean

Whether the result PDF should be returned as a URL. Default is false.

Example: true

fileNamestring

The file name the result PDF will have. Default is a random ID.

Response

Success

Body

url*string

The result PDF URL.

Request

const response = await fetch('/pdf/merge', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "files": [
        {}
      ]
    }),
});
const data = await response.json();

Response

{
  "url": "text"
}

Convert PDF to image.

POST/pdf/pdf-to-image

Header parameters

Body

urlstring

The PDF URL.

bufferstring

The PDF as a Base64-encoded buffer. Can be specified instead of url.

fileNamestring

The file name prefix of the result images. Default is a random ID.

Response

Success

Body

Other propertiesstring

Request

const response = await fetch('/pdf/pdf-to-image', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "status": 0,
  "errorMessage": "text"
}

Split PDF file.

POST/pdf/split

Header parameters

Body

urlstring

The PDF URL.

bufferstring

The PDF as a Base64-encoded buffer. Can be specified instead of url.

pagesarray of string

The page ranges that should be contained in the new PDF files. Every subdocument is given as a comma-separated range of pages, where 1 means the first page and ^1 means the last page.

intervalnumber

The number of pages that should be contained in every split PDF file. Can be specified instead of pages.

fileNamestring

The file name prefix the result PDFs will have. Default is a random ID.

Response

Success

Body

pdfUrls*array of string

The URLs of all split PDF files.

Request

const response = await fetch('/pdf/split', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "pdfUrls": [
    "text"
  ]
}

Create shortened URL.

POST/add

Header parameters

Body

sendToWebhook*string

data*string

intervalType*enum

The type of scheduler that will be set up. The different options are:

1: One time execution. intervalOptions must be a unix timestamp or ISO 8601 date.
2: Multiple specific executions. intervalOptions must be an array of unix timestamps or ISO 8601 dates.
3: Cron job. intervalOptions must be a cron string.
4: Regular execution every n hours / days / weeks / months. intervalOptions must be a string of the format period;n.

1234

intervalOptions*any of

endDatestring

destination*string

The destination URL which the shortened URL will point to.

Example: "https://0codekit.com"

customstring

The shortened URL identifier. This is the part that comes after lyl.ai, and which is used for managing the shortened URL. It must be globally unique. Default is a random 8 letter string.

Example: "to4w5vyb"

Response

Success

Body

taskId*string

nextExecution*string

endDatestring

shortenedUrl*string

The complete shortened URL.

Example: "https://lyl.ai/custom"

identifier*string

The shortened URL identifier. If one was provided, it is simply returned.

Example: "to4w5vyb"

Request

const response = await fetch('/add', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sendToWebhook": "text",
      "data": "text",
      "intervalType": 1,
      "intervalOptions": "text",
      "destination": "https://0codekit.com"
    }),
});
const data = await response.json();

Response

{
  "taskId": "text",
  "nextExecution": "text",
  "endDate": "text",
  "shortenedUrl": "https://lyl.ai/custom",
  "identifier": "to4w5vyb"
}

Delete shortened URL.

POST/del

Header parameters

Body

taskId*string

identifier*string

The shortened URL identifier that was returned by /add.

Example: "to4w5vyb"

Response

Success

Body

message*string

The success message.

Example: "Successfully deleted shortened URL with id to4w5vyb."

Request

const response = await fetch('/del', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "taskId": "text",
      "identifier": "to4w5vyb"
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully deleted shortened URL with id to4w5vyb."
}

List shortened URLs.

POST/list

Header parameters

Body

object

Response

Success

Body

tasks*array of object

shortenedUrls*array of object

A list of all shortened URLs the user has created.

Request

const response = await fetch('/list', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "tasks": [
    {
      "taskId": "text",
      "webhook": "text",
      "nextExecution": "text",
      "data": "text"
    }
  ],
  "shortenedUrls": [
    {
      "identifier": "to4w5vyb",
      "createdAt": "text",
      "destination": "https://0codekit.com"
    }
  ]
}

Get shortened URL.

POST/get

Header parameters

Body

identifier*string

The shortened URL identifier that was returned by /add.

Example: "to4w5vyb"

Response

Success

Body

destination*string

The destination URL.

Example: "https://0codekit.com"

Request

const response = await fetch('/get', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "identifier": "to4w5vyb"
    }),
});
const data = await response.json();

Response

{
  "destination": "https://0codekit.com"
}

Update shortened URL.

POST/put

Header parameters

Body

identifier*string

The shortened URL identifier that was returned by /add.

Example: "to4w5vyb"

destination*string

The new destination URL which the shortened URL will point to.

Example: "https://example.com"

Response

Success

Body

newDestination*string

The new destination URL which was provided in the request body.

Example: "https://example.com"

identifier*string

The shortened URL identifier. Nothing is changed about this.

Example: "to4w5vyb"

Request

const response = await fetch('/put', {
    method: 'POST',
    headers: {
      "auth": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "identifier": "to4w5vyb",
      "destination": "https://example.com"
    }),
});
const data = await response.json();

Response

{
  "newDestination": "https://example.com",
  "identifier": "to4w5vyb"
}

PreviousHelp Desk NextExamples and Use Cases

Last updated 14 days ago