API Documentation

Up-to-date API Documentation of 0CodeKit.

Remarks

This document is no longer maintained. Please, use this URL to visit our up-to-date OpenAPI documentation.

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

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.

PreviousHelp Desk NextExamples and Use Cases

Last updated 1 month ago

Was this helpful?

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

authstringrequired

Body

videostringrequired

The URL of the video file.

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

audiostringrequired

The URL of the audio file.

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

fileNamestring

The name of the merged video.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/operator/merge-video-audio' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"video":"https://example.com/video.mp4","audio":"https://example.com/audio.mp3"}'

200

400

{
  "outputUrl": "https://example.com/output.mp4"
}

Success

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

authstringrequired

The API key that can be retrieved from 0codekit.com.

Body

urlstring

The PDF URL.

bufferstring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/business/facturx/validate' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

{
  "valid": true,
  "invoice": "text",
  "errors": [
    "text"
  ]
}

Success

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

authstringrequired

The API key that can be found on 0codekit.com.

Body

urlstring

The PDF URL.

bufferstring

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

xmlstringrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/business/facturx/embed' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"xml":"text"}'

200

400

{}

Success

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

authstringrequired

Body

textstringrequired

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.

contextstringrequired

Prompt that contextualizes the text.

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

fieldsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/extract-from-text' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"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.","validationRegex":"^(?:[1-9][0-9]?|1[0-9]{2}|200)$"}]}'

200

400

No body

Success

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

authstringrequired

Body

queryStringstringrequired

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

targetListstring[]required

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

Example: ["Willie Tanner","Gordon Shumway","Kate Tanner","Trevor Ochmonek"]

optionsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/fuzzy-match' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"queryString":"Alf from Melmac","context":"Names of people","targetList":["Willie Tanner","Gordon Shumway","Kate Tanner","Trevor Ochmonek"],"options":{"maxResults":2}}'

200

400

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

Success

Redact sensitive information from pdf.

post

/ai/redact-pdf

Header parameters

authstringrequired

Body

urlstring

The PDF URL.

bufferstring

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

sensitiveContentstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/redact-pdf' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"sensitiveContent":"All people names and addresses should be considered sensitive data.","getAsUrl":true,"language":"de"}'

200

400

application/octet-stream

application/json

No body

Success

Extract text from given PDF (Advanced OCR)

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

post

/ai/advancedocr

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com.

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.

workflowstringrequired

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.

resultTypestring · enumrequired

Result type specifies the output type.

Options: ocr, extractions

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://v2.1saas.co/ai/advancedocr' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"url":"https://icseindia.org/document/sample.pdf","workflow":"text","resultType":"ocr"}'

200

400

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Success

Check rate limit.

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

post

/operator/trafficlight

Header parameters

authstringrequired

Body

namestringrequired

An arbitrary name for this traffic light.

intervalnumberrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://v2.1saas.co/operator/trafficlight' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","interval":1}'

200

400

{
  "ok": true
}

Success

Detect adult content.

Check if the content is appropriate for all audiences.

post

/ai/detectadultcontent

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

imageUrlstringrequired

The URL of the image to be checked.

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/detectadultcontent' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"imageUrl":"https://example.com/image.jpg"}'

200

400

{}

Success

Detect text in an image.

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

post

/ai/picturetextrecognition

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com.

Body

imageUrlstringrequired

The URL of the image to analyze.

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/picturetextrecognition' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"imageUrl":"https://example.com/image.jpg"}'

200

400

{
  "recognizedTexts": [
    "text"
  ]
}

Success

Text Entity Detection.

Identities Entities From Input Text.

post

/ai/entitydetection

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

textstringrequired

Text for entity detection.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/entitydetection' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"text":"text"}'

200

400

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

Success

Remove image background.

Remove background from image url or buffer.

post

/ai/removebg

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

urlstring

bufferstring

getAsUrlbooleanrequired

fileNamestring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/removebg' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"getAsUrl":true}'

200

400

{}

Success

Detect brand

Detect brand from given image.

post

/ai/detectbrand

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

imageUrlstringrequired

Image for brand detection.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/detectbrand' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"imageUrl":"text"}'

200

400

{
  "brands": [
    "text"
  ]
}

Success

Generate python code.

Generate python code based on provided prompt.

post

/ai/generatepythoncode

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

promptstringrequired

Prompt to generate python code.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/generatepythoncode' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"prompt":"text"}'

200

400

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

Success

Detect color.

Detect color from given image.

post

/ai/detectcolor

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

imageUrlstringrequired

Image for color detection.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/detectcolor' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"imageUrl":"text"}'

200

400

{}

Success

Too Long To Read

Creates a summary of the given text.

post

/ai/toolongtoread

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

promptstringrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/toolongtoread' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"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."}'

200

400

{
  "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."
  }
}

Success

Detect language.

Detect language of given text.

post

/ai/languagedetection

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

textstringrequired

Text for language detection.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/languagedetection' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"text":"text"}'

200

400

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

Success

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

authstringrequired

The API key that can be retrieved from 0codekit.com

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/transcribe' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"url":"https://www.pacdv.com/sounds/voices/am-i-totally-screwed-or.wav","lang":"en"}'

200

400

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

Success

Detect labels in an image.

Detects labels in an image using the Google Vision API.

post

/ai/pictureobjectrecognition

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

imageUrlstringrequired

The URL of the image to analyze.

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/pictureobjectrecognition' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"imageUrl":"https://example.com/image.jpg"}'

200

400

{
  "recognizedLabels": [
    "text"
  ]
}

Success

Generate an image.

Generate an image based on prompt.

post

/ai/generateimage

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

promptstringrequired

Prompt to generate image.

nnumber · max: 10required

Number of output image's to be generated.

sizestring · enumrequired

Options: 256x256, 512x512, 1024x1024, 1024x1024, 1792x1024, 1024x1792

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/generateimage' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"prompt":"text","n":1,"size":"256x256"}'

200

400

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

Success

Extract contact information.

Extract contact information from given prompt.

post

/ai/extractcontactinformation

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

promptstringrequired

Prompt for contact info extraction.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/extractcontactinformation' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"prompt":"text"}'

200

400

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

Success

Generate javascript code.

Generate javascript code based on provided prompt.

post

/ai/generatejavascriptcode

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

promptstringrequired

Prompt to generate javascript code.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/generatejavascriptcode' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"prompt":"text"}'

200

400

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

Success

Detect mood.

Detect mood from given text.

post

/ai/mooddetection

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

textstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/mooddetection' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"text":"text"}'

200

400

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

Success

Detect face.

Detect face from given image.

post

/ai/detectface

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

imageUrlstringrequired

Image for face detection.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/detectface' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"imageUrl":"text"}'

200

400

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

Success

Detect email type.

Detect email type from provided subject and body.ß

post

/ai/detectemailtype

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

subjectstringrequired

Subject of email.

bodystringrequired

Body of email.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/detectemailtype' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"subject":"text","body":"text"}'

200

400

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

Success

PDF Optical Character Recognition.

post

/ai/pdfocr

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com.

Body

pdfUrlstringrequired

PDF URL.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/pdfocr' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"pdfUrl":"text"}'

200

400

{
  "recognizedText": "text"
}

Success

Check content policy.

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

post

/ai/checkcontentpolicy

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

promptstringrequired

The text containing the content to be checked.

Example: Hello world!

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/checkcontentpolicy' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"prompt":"Hello world!"}'

200

400

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

Success

Translate text to a specified language.

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

post

/ai/translate

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

textstringrequired

The text to be translated.

Example: Hello, world!

resultLangstringrequired

The target language code to translate the text into.

Example: es

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/ai/translate' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"text":"Hello, world!","resultLang":"es"}'

200

400

{
  "translation": "text"
}

Success

Hash a message.

post

/crypto/hash

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

messagestringrequired

secretKeystring

hashTypestring · enumrequired

Options: MD5, SHA1, SHA224, SHA256, SHA3, SHA384, SHA512, RIPEMD160, HmacMD5, HmacSHA1, HmacSHA224, HmacSHA256, HmacSHA3, HmacSHA384, HmacSHA512, HmacRIPEMD160

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/crypto/hash' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"message":"text","hashType":"MD5"}'

200

400

{
  "hashedText": "text"
}

Success

Decrypt ciphertext.

post

/crypto/decrypt

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

ciphertextstringrequired

The ciphertext.

secretKeystringrequired

The encryption key.

cryptoTypestring · enumrequired

Options: AES, DES, TripleDES, Rabbit, RC4, RC4Drop

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/crypto/decrypt' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"ciphertext":"text","secretKey":"text","cryptoType":"AES"}'

200

400

{
  "decryptedText": "text"
}

Success

Encrypt plaintext.

post

/crypto/encrypt

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

messagestringrequired

The plaintext.

secretKeystringrequired

The encryption key.

cryptoTypestring · enumrequired

Options: AES, DES, TripleDES, Rabbit, RC4, RC4Drop

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/crypto/encrypt' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"message":"text","secretKey":"text","cryptoType":"AES"}'

200

400

{
  "encryptedText": "text"
}

Success

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

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

startPointstringrequired

The start point.

Example: Flensburg

endPointstringrequired

The end point.

Example: Istanbul

modestring · enumrequired

The mode of travel.

Example: walking

Options: driving, walking, bicycling, transit

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/calculate/geodistance-v2' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"startPoint":"Flensburg","endPoint":"Istanbul","mode":"walking"}'

200

400

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

Success

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

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

weightnumberrequired

The weight in kilograms.

Example: 80

heightnumberrequired

The height in centimeters.

Example: 180

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/calculate/bmi' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"weight":80,"height":180}'

200

400

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

Success

Find gender of name.

post

/operator/gender

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

firstnamestring

The first name.

fullnamestring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/operator/gender' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

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

Success

Retrieve credits.

post

/user/retrievecredits

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

object

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/user/retrievecredits' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

{
  "credits": 1
}

Success

Remove duplicates from the list.

post

/operator/duplicate

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com.

Body

listany[]required

The List that contains duplicate values.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/operator/duplicate' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"list":[]}'

200

400

{
  "list": []
}

Success

Parse URL query parameters.

post

/operator/parseurlquery

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

urlstringrequired

The URL.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/operator/parseurlquery' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"url":"text"}'

200

400

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Success

Get website logo URL.

post

/operator/logo

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

urlstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/operator/logo' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"url":"text"}'

200

400

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

Success

Get thumbnail for video.

post

/operator/thumbnail

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

urlstringrequired

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

getAsUrlboolean

fileNamestring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/operator/thumbnail' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"url":"text"}'

200

400

application/octet-stream

application/json

No body

Success

Get JSON values from keys.

post

/operator/advancedswitch

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

externalbooleanrequired

keyany ofrequired

jsonany ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/operator/advancedswitch' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"external":true}'

200

400

{
  "found": []
}

Success

Split name.

Split a full name into its first and last name.

post

/operator/splitname

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

namestringrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/operator/splitname' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text"}'

200

400

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

Success

Expand URL.

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

post

/operator/urlexpander

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

urlstringrequired

The URL.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/operator/urlexpander' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"url":"text"}'

200

400

{
  "unshortenedUrl": "text"
}

Success

Build UTM link.

post

/operator/utm/build

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

urlstringrequired

The base URL.

utmobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/operator/utm/build' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"url":"text","utm":{}}'

200

400

{
  "url": "text"
}

Success

Parse UTM link.

post

/operator/utm/parse

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

urlstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/operator/utm/parse' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"url":"text"}'

200

400

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

Success

Parse HTML.

post

/operator/htmlparser/get

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

htmlstring

urlstring

allboolean

selectorstring

tagSelectorstring

idSelectorstring

classSelectorstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/operator/htmlparser/get' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

{
  "data": "text"
}

Success

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

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

isostring

The ISO code of the nation.

nationstring

The English name of the nation.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/convert/nationiso' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

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

Success

Convert Outlook item files.

post

/convert/msgtojson

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

urlstring

bufferstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/convert/msgtojson' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

No body

Success

Convert between currencies.

post

/convert/currency

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

sourceCurrencystringrequired

targetCurrencystringrequired

amountnumberrequired

dateFormatstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/convert/currency' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"sourceCurrency":"text","targetCurrency":"text","amount":1}'

200

400

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

Success

Convert IP to location.

post

/convert/iptogeo

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

ipstringrequired

The IP address.

Example: 87.155.190.147

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/convert/iptogeo' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"ip":"87.155.190.147"}'

200

400

{
  "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",
  "status": "success"
}

Success

Convert CSV to JSON.

post

/convert/csv/json

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

csvstringrequired

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.

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.

delimiterany of

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/convert/csv/json' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"csv":"text","delimiter":"auto"}'

200

400

{
  "json": []
}

Success

Convert CSV to array.

post

/convert/csv/array

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

csvstringrequired

The CSV string that will be parsed.

omitFirstRowboolean

Whether to omit the first row. Default is false.

delimiterstringrequired

The delimiter by which the rows will be split.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/convert/csv/array' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"csv":"text","delimiter":"text"}'

200

400

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

Success

Look up VAT rate.

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

post

/business/lookupvatrates

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

countryCodestringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/business/lookupvatrates' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"countryCode":"text"}'

200

400

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

Success

Check for freemail.

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

post

/business/isfreemail

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

emailstringrequired

The email address that should be checked.

Example: pa1928sch@hotmail.com

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/business/isfreemail' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"email":"pa1928sch@hotmail.com"}'

200

400

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

Success

Validate Geolocation.

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

post

/business/validate/geolocation

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

addressstringrequired

The location. Can be an address or coordinates.

Example: Bavaria Donau 11, Passau

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/business/validate/geolocation' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"address":"Bavaria Donau 11, Passau"}'

200

400

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

Success

Validate the phone number.

Checks whether the phone number is valid.

post

/business/validate/phonenumber

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

phoneNumberstringrequired

The phone number to validate.

Example: (+81) 090-1234-5678

countryCodestring

Short abbreviation of a country.

Example: JP

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/business/validate/phonenumber' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"phoneNumber":"(+81) 090-1234-5678","countryCode":"JP"}'

200

400

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

Success

Validate IBAN

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

post

/business/validate/iban

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

ibanstringrequired

The IBAN

Example: DE02120300000000202051

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/business/validate/iban' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"iban":"DE02120300000000202051"}'

200

400

{
  "valid": true
}

Success

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

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

vatIdstring

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

Example: DE123456789

idstring

The number part of the VAT ID.

Example: 07643520567

countryCodestring · enum

The country code of the VAT ID.

Example: IT

Options: AT, BE, BG, HR, CY, CZ, DK, EE, FI, FR, DE, EL, HU, IE, IT, LV, LT, LU, MT, NL, PL, PT, RO, SK, SI, ES, SE, XI

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/business/validate/vat' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"vatId":"DE123456789","id":"07643520567","countryCode":"IT"}'

200

400

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

Success

Validate a BIC.

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

post

/business/validate/bic

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

bicstringrequired

The BIC.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/business/validate/bic' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"bic":"text"}'

200

400

{
  "valid": true
}

Success

Verify domain.

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

post

/business/verify/domain

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

domainstringrequired

The domain name.

Example: https://www.google.com

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/business/verify/domain' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"domain":"https://www.google.com"}'

200

400

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

Success

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

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

fileNamestring

The file name. Default is a random string.

Example: my-file.txt

bufferstringrequired

The Base64-encoded file buffer.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/storage/temp' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"fileName":"my-file.txt","buffer":"text"}'

200

400

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

Success

Delete from permanent storage.

post

/storage/perm/del

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

fileIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/storage/perm/del' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"fileId":"text"}'

200

400

{
  "message": "text"
}

Success

Get permanent file.

post

/storage/perm/get

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

fileNamestring

fileIdstring

getAsUrlboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/storage/perm/get' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

{}

Success

List permanent files.

post

/storage/perm/list

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

object

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/storage/perm/list' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

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

Success

Upload to permanent storage.

post

/storage/perm/add

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

fileUrlstring

fileBufferstring

uploadNamestring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/storage/perm/add' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

{
  "fileId": "text"
}

Success

Delete a global variable.

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

post

/storage/globalvariables/del

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

variableIdstringrequired

The variable name.

Example: myVariable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/storage/globalvariables/del' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"variableId":"myVariable"}'

200

400

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

Success

Update a global variable.

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

post

/storage/globalvariables/update

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

variableNamestringrequired

The name of the variable to update.

Example: myVariable

variableValuestringrequired

The new value of the variable.

Example: myValue

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/storage/globalvariables/update' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"variableName":"myVariable","variableValue":"myValue"}'

200

400

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

Success

Get a global variable.

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

post

/storage/globalvariables/get

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

variableNamestringrequired

The name of the variable to get.

Example: myVariable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/storage/globalvariables/get' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"variableName":"myVariable"}'

200

400

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

Success

List all variables.

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

post

/storage/globalvariables/list

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

object

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/storage/globalvariables/list' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

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

Success

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

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

variableNamestring

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

Example: myVariable

variableValuestringrequired

The value to assign to the variable.

Example: myValue

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/storage/globalvariables/add' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"variableName":"myVariable","variableValue":"myValue"}'

200

400

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

Success

Delete a JSON bin.

post

/storage/json/del

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

binIdstringrequired

The ID of the JSON bin.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/storage/json/del' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"binId":"text"}'

200

400

{
  "message": "text"
}

Success

Put data into JSON bin.

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

post

/storage/json/put

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

jsonanyrequired

The JSON data to put into the bin.

binIdstringrequired

The ID of the JSON bin that will be modified.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/storage/json/put' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"json":null,"binId":"text"}'

200

400

{
  "binId": "text"
}

Success

Get a JSON bin.

post

/storage/json/get

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

binIdstringrequired

The ID of the JSON bin.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/storage/json/get' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"binId":"text"}'

200

400

{
  "binId": "text",
  "data": null
}

Success

List JSON bins.

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

post

/storage/json/list

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

object

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/storage/json/list' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

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

Success

Add a JSON bin.

post

/storage/json/add

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

jsonanyrequired

The JSON data to store in the bin.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/storage/json/add' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"json":null}'

200

400

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

Success

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

authstringrequired

The API key that can be retrieved from 0codekit.com

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/dateandtime/calendarweek' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"date":"20.01.2022","weekNumber":5,"year":2023,"unixTimestamp":1642918727,"dateFormat":"DD.MM.YYYY","outputFormat":"DD.MM.YYYY"}'

200

400

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

Success

Check weekend date.

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

post

/dateandtime/isweekend

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

datestringrequired

The date for which information is requested.

dateFormatstring

The format of the input date.

timeZonestring

The timezone

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/dateandtime/isweekend' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"date":"text"}'

200

400

{
  "dayNumber": 1,
  "weekDay": "text",
  "isWeekend": true
}

Success

Convert between timezones.

Converts a date and time from one timezone to another.

post

/dateandtime/switchtimezone

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

inputTimeZonestringrequired

The timezone of the input time.

Example: Europe/Berlin

formatPatternstring

The format of the output time.

destinationTimeZonestringrequired

The timezone of the output time.

inputTimeany ofrequired

The time that will be converted.

Example: 08-12-2024 12:00

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/dateandtime/switchtimezone' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"inputTimeZone":"Europe/Berlin","destinationTimeZone":"text","inputTime":"08-12-2024 12:00"}'

200

400

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

Success

Retrieve holidays.

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

post

/dateandtime/holidays

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

yearnumberrequired

The year for which holidays are requested.

Example: 2022

countryCodestringrequired

The ISO 3166-1 alpha-2 country code.

Example: AT

statestring

The state within the country (if applicable).

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/dateandtime/holidays' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"year":2022,"countryCode":"AT"}'

200

400

{
  "holidays": [
    {
      "date": "text",
      "start": "2025-02-21T18:09:24.467Z",
      "end": "2025-02-21T18:09:24.467Z",
      "name": "text",
      "type": "text",
      "rule": "text"
    }
  ]
}

Success

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

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

startDatestringrequired

Starting date.

Example: 2023-06-07

durationnumberrequired

Duration of days for which the detail period is retrieved.

Example: 41

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/dateandtime/detailperiod' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"startDate":"2023-06-07","duration":41}'

200

400

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

Success

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

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

datestring

Date parameter

dateFormatstring

Format of the input date

monthnumber · min: 1 · max: 12

Number of the month.

yearnumber

Year

outputFormatstring

Format of the output date

optionsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/dateandtime/month' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"options":{}}'

200

400

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

Success

Check auth status.

post

/1saas/auth

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

object

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/1saas/auth' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

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

Success

Generate a city.

post

/generate/city

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

object

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/generate/city' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

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

Success

Generate a number.

post

/generate/number

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

roundnumber

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

typestring · enum

The type of generated number. Default is integer.

Options: decimal, float, integer

rangenumber[]required

The range of the generated number.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/generate/number' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"type":"decimal","range":[null]}'

200

400

{
  "randomNumber": 1
}

Success

Generate random string.

Generate random string based on type and length.

post

/generate/string

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

lengthnumberrequired

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.

typestring · enum

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

Options: 1, 2, 3, 4, 5, 6, 7, 8

customstring[]

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/generate/string' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"length":1,"type":1,"custom":[null]}'

200

400

{
  "randomString": "text"
}

Success

Generate a name.

post

/generate/name

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

genderstring · enum

Options: male, female

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/generate/name' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"gender":"male"}'

200

400

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

Success

Generate a color.

post

/generate/color

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

alphanumber · max: 1

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.

luminositystring · enum

The luminosity of the generated color. Default is random.

Options: bright, light, dark

formatstring · enum

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.

Options: rgb, rgba, hsl, hsla, hex

seedany of

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

hueany of

The hue of the generated color. Default is random.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/generate/color' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"luminosity":"bright","format":"rgb","hue":"red"}'

200

400

{
  "color": "text"
}

Success

Generate user mockdata.

post

/generate/mockdata/user

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

amountnumber · max: 100

The amount of users to generate. Default is 1.

emailRequiredboolean

avatarRequiredboolean

passwordRequiredboolean

birthDateRequiredboolean

usernameRequiredboolean

addressRequiredboolean

cityRequiredboolean

countryRequiredboolean

phoneRequiredboolean

createdAtRequiredboolean

balanceRequiredboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/generate/mockdata/user' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

{
  "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": 1
    }
  ]
}

Success

Scrape website.

post

/generate/html-scrape

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

urlstringrequired

textOnlyboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/generate/html-scrape' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"url":"text"}'

200

400

{
  "data": "text"
}

Success

Encode JWT.

post

/generate/jsonwebtoken/encode

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

dataanyrequired

secretstringrequired

optionsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/generate/jsonwebtoken/encode' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"data":null,"secret":"text","options":{"algorithm":"HS256"}}'

200

400

{
  "token": "text"
}

Success

Decode JWT.

post

/generate/jsonwebtoken/decode

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

tokenstringrequired

verifyboolean

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

secretstring

The HMAC secret or PEM-encoded public key.

optionsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/generate/jsonwebtoken/decode' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"token":"text","options":{"algorithms":["HS256"]}}'

200

400

No body

Success

Generate a QR code.

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

post

/generate/qrcode/encode

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

datastringrequired

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

imageOptionsobject

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

qrOptionsobject

Options for the QR code data.

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/generate/qrcode/encode' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"data":"https://wemakefuture.com","width":500,"height":500,"image":"https://pbs.twimg.com/profile_images/1325818753842618384/I9aD7jAt_400x400.jpg","margin":15,"imageOptions":{"hideBackgroundDots":true,"margin":0},"qrOptions":{"typeNumber":5,"mode":"Byte","errorCorrectionLevel":"Q"},"dotsOptions":{"color":"#000000","type":"square","gradient":{"type":"linear","colorStops":[{"offset":0,"color":"#FF0000"}]}},"cornersSquareOptions":{"color":"#000000","type":"square","gradient":{"type":"linear","colorStops":[{"offset":0,"color":"#FF0000"}]}},"cornersDotOptions":{"color":"#000000","type":"square","gradient":{"type":"linear","colorStops":[{"offset":0,"color":"#FF0000"}]}}}'

200

400

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

Success

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

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

urlstring

The URL to the QR code.

bufferstring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/generate/qrcode/decode' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

{
  "data": "text"
}

Success

Decode barcode.

post

/generate/barcode/decode

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

urlstring

bufferstring

barcodestring · enumrequired

The barcode format.

Options: code-128, code-2of5, code-39, code-93, ean-13, ean-8, coabar

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/generate/barcode/decode' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"barcode":"code-128"}'

200

400

{
  "code": "text"
}

Success

Generate barcode.

post

/generate/barcode/encode

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

datastringrequired

getAsUrlboolean

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

fileNamestring

formatstring · enum

The generated file type. Default is svg.

Options: svg, png, jpeg

optionsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/generate/barcode/encode' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"data":"text","format":"svg","options":{}}'

200

400

application/octet-stream

application/json

No body

Success

Evaluate text against a regex.

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

post

/text/regex

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

textstringrequired

The text to be evaluated.

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

expressionstringrequired

The regular expression to evaluate against the text.

Example: \b\w{4}\b

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/text/regex' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"text":"The quick brown fox jumps over the lazy dog.","expression":"\\b\\w{4}\\b"}'

200

400

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

Success

Keyword search in text.

Searches text for keywords and returns their positions.

post

/text/contains

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

textstringrequired

Text from which you want to find keywords.

keywordstring

Single keyword.

keywordListstring[]

Multiple keywords.

optionsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/text/contains' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"text":"text","keywordList":[null],"options":{}}'

200

400

{
  "findings": [
    {
      "keyword": "text",
      "contains": true,
      "foundPositions": [
        1
      ]
    }
  ]
}

Success

Compare two strings.

Calculate similarity score between two strings

post

/text/comparestring

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

string1stringrequired

First String.

string2stringrequired

Second String.

algorithmstring

Similarity algorithm.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/text/comparestring' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"string1":"text","string2":"text"}'

200

400

{
  "similarity": 1,
  "distance": 1
}

Success

Extract text from body.

Extracts text from body between given start and end markers

post

/text/extractor

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com

Body

startstringrequired

Start marker.

endstringrequired

End marker.

bodystringrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/text/extractor' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"start":"text","end":"text","body":"text"}'

200

400

{
  "text": "text"
}

Success

Execute Python code.

post

/python

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com.

Body

codestringrequired

The Python code that will be executed.

requirementsstring[]

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/python' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"code":"text","requirements":[null]}'

200

400

{
  "result": null
}

Success

Execute async Python.

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

post

/async-python

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com.

Body

codestringrequired

The Python script that will be executed.

sendTostring

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

requirementsstring[]

The PyPI libraries your Python code requires.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/async-python' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"code":"text","requirements":[null]}'

200

400

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

Success

Execute JavaScript code.

post

/javascript

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com.

Body

codestringrequired

The JavaScript code that will be executed.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/javascript' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"code":"text"}'

200

400

No body

Success

Get async task status.

post

/taskstatus

Header parameters

authstringrequired

The API key that can be retrieved from 0codekit.com.

Body

taskIdstringrequired

The ID of the task that will be checked.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/taskstatus' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"taskId":"text"}'

200

400

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

Success

Generate Bar Chart

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

post

/chart/bars

Header parameters

authstringrequired

Body

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.

borderWidthnumber

Width of the borders around the bars.

titlestring

Title of the chart.

fileNamestring

Optional filename for the generated chart image.

optionsobject

Additional configuration options for Chart.js.

datanumber[]required

Data points for the bar chart.

labelsstring[]required

Labels corresponding to the data points.

bordersColorsstring[]

Colors for the borders of the bars.

barsColorsstring[]

Colors for the bars in the chart.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/chart/bars' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"options":{},"data":[null],"labels":[null],"bordersColors":[null],"barsColors":[null]}'

200

400

application/octet-stream

application/json

No body

Success

Generate Doughnut Chart

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

post

/chart/doughnut

Header parameters

authstringrequired

Body

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.

borderWidthnumber

Width of the borders around the doughnut.

titlestring

Title of the chart.

fileNamestring

Optional filename for the generated chart image.

optionsobject

Additional configuration options for Chart.js.

datanumber[]required

Data points for the doughnut chart.

labelsstring[]required

Labels corresponding to the data points.

bordersColorsstring[]

Colors for the borders of the doughnut.

barsColorsstring[]

Colors for the doughnut in the chart.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/chart/doughnut' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"options":{},"data":[null],"labels":[null],"bordersColors":[null],"barsColors":[null]}'

200

400

application/octet-stream

application/json

No body

Success

Generate Line Chart

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

post

/chart/line

Header parameters

authstringrequired

Body

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.

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.

fileNamestring

Optional filename for the generated chart image.

optionsobject

Additional configuration options for Chart.js.

datanumber[]required

Data points for the line chart.

labelsstring[]required

Labels corresponding to the data points.

bordersColorsstring[]

Colors for the borders of the line.

barsColorsstring[]

Colors for the line in the chart.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/chart/line' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"options":{},"data":[null],"labels":[null],"bordersColors":[null],"barsColors":[null]}'

200

400

application/octet-stream

application/json

No body

Success

Blur an image.

post

/image/blur

Header parameters

authstringrequired

Body

urlstring

The image URL

bufferstring

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

sigmanumber · min: 0.3 · max: 1000

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/image/blur' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

application/octet-stream

application/json

No body

Success

Convert an image.

post

/image/convert

Header parameters

authstringrequired

Body

urlstring

The image URL

bufferstring

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

withMetaDataboolean

Whether the image metadata should be converted, too.

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.

outputFormatstring · enumrequired

The output format of the conversion.

Options: jpeg, jpg, png, gif, tiff, webp

optionsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/image/convert' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"outputFormat":"jpeg","options":{"quality":80,"alphaQuality":100,"lossless":false,"nearLossless":false,"smartSubsample":false,"progressive":false,"trellisQuanitsation":false,"overshootDeringing":false,"optimiseScans":false,"optimiseCoding":true,"quanitsationTable":0,"mozjpeg":false,"compressionLevel":6,"adaptiveFiltering":false,"effort":7,"palette":false,"colours":256,"dither":1,"pyramid":false,"tile":false,"tileWidth":256,"tileHeight":256,"xres":1,"yres":1,"miniswhite":false,"reuse":false,"interFrameMaxError":0,"interPaletteMaxError":3,"chromaSubsampling":"4:2:0","preset":"default","compression":"jpeg","predictor":"horizontal","bitdepth":8,"resolutionUnit":"inch"}}'

200

400

application/octet-stream

application/json

No body

Success

Get EXIF data.

post

/image/exif

Header parameters

authstringrequired

Body

urlstring

The image URL

bufferstring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/image/exif' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

{
  "exifData": null
}

Success

Crop an image.

post

/image/crop

Header parameters

authstringrequired

Body

urlstring

The image URL

bufferstring

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

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.

optionsobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/image/crop' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"options":{"left":100,"top":100,"width":500,"height":500}}'

200

400

application/octet-stream

application/json

No body

Success

Flip an image.

post

/image/flip

Header parameters

authstringrequired

Body

urlstring

The image URL

bufferstring

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

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.

axisstring · enumrequired

The axis the image will be flipped about.

Options: X, x, Y, y

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/image/flip' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"axis":"X"}'

200

400

application/octet-stream

application/json

No body

Success

Convert HTML to image.

post

/image/html

Header parameters

authstringrequired

Body

urlstring

The image URL

htmlstring

The HTML source. Can be specified instead of url.

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.

optionsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/image/html' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"options":{"quality":80,"fullPage":true,"width":1920,"height":1080,"scaleFactor":1,"type":"png","clip":{"x":1,"y":1,"width":1,"height":1}}}'

200

400

application/octet-stream

application/json

No body

Success

Overlay two images.

post

/image/overlay

Header parameters

authstringrequired

Body

frontImageUrlstringrequired

The URL of the front image.

backImageUrlstringrequired

The URL of the background image.

getAsUrlboolean

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

fileNamestring

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

positionstring · enum

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

Options: center, top-left, top-right, bottom-left, bottom-right

optionsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/image/overlay' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"frontImageUrl":"text","backImageUrl":"text","position":"center","options":{}}'

200

400

application/octet-stream

application/json

No body

Success

Resize an image.

post

/image/resize

Header parameters

authstringrequired

Body

urlstring

bufferstring

widthnumber

heightnumber

getAsUrlboolean

fileNamestring

optionsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/image/resize' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"options":{"fit":"contain","position":"center","kernel":"nearest"}}'

200

400

{}

Success

Rotate an image.

post

/image/rotate

Header parameters

authstringrequired

Body

urlstring

The image URL

bufferstring

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

anglenumberrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/image/rotate' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"angle":1,"background":"#000000"}'

200

400

application/octet-stream

application/json

No body

Success

Sharpen an image.

post

/image/sharpen

Header parameters

authstringrequired

Body

urlstring

The image URL

bufferstring

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

sigmanumber · min: 0.3 · max: 1000

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/image/sharpen' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

application/octet-stream

application/json

No body

Success

Draw image on PDF.

post

/pdf/draw/image

Header parameters

authstringrequired

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.

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.

anchorstring · enum

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

Example: center

Options: bottom-left, bottom, bottom-right, left, center, right, top-left, top, top-right

alignstring · enum

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

Example: center

Options: bottom-left, bottom, bottom-right, left, center, right, top-left, top, top-right

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/draw/image' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"getAsUrl":true,"x":0,"y":0,"width":200,"height":100,"rotate":45,"anchor":"center","align":"center"}'

200

400

{}

Success

Draw text on PDF.

post

/pdf/draw/text

Header parameters

authstringrequired

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

textstringrequired

The text to draw.

Example: Hello, world!

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.

fontstring · enum

The font to use. Default is Helvetica.

Example: Helvetica

Options: Helvetica, Courier, TimesRoman

anchorstring · enum

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

Example: center

Options: bottom-left, bottom, bottom-right, left, center, right, top-left, top, top-right

alignstring · enum

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

Example: center

Options: bottom-left, bottom, bottom-right, left, center, right, top-left, top, top-right

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/draw/text' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"getAsUrl":true,"text":"Hello, world!","x":0,"y":0,"rotate":45,"size":32,"color":"FFFF00","pages":"1,3-5,^3-^1","font":"Helvetica","anchor":"center","align":"center"}'

200

400

application/octet-stream

application/json

No body

Success

Edit PDF metadata.

post

/pdf/metadata/edit

Header parameters

authstringrequired

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.

fileNamestring

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

keywordsstring[]

The new keywords of the PDF.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/metadata/edit' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"getAsUrl":true,"keywords":[null]}'

200

400

application/octet-stream

application/json

No body

Success

Get PDF metadata.

post

/pdf/metadata/info

Header parameters

authstringrequired

Body

urlstring

The PDF URL.

bufferstring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/metadata/info' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

{
  "title": "text",
  "author": "text",
  "subject": "text",
  "creator": "text",
  "creationDate": "2025-02-21T18:09:24.467Z",
  "modificationDate": "2025-02-21T18:09:24.467Z",
  "isEncrypted": true,
  "pageCount": 1,
  "keywords": [
    "text"
  ],
  "pages": [
    {
      "width": 1,
      "height": 1,
      "rotation": 1
    }
  ]
}

Success

Add PDF pages.

post

/pdf/pages/add

Header parameters

authstringrequired

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

fileNamestring

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

pagesnumber[]required

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/pages/add' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"getAsUrl":true,"width":595,"height":842,"pages":[null]}'

200

400

application/octet-stream

application/json

No body

Success

Remove PDF pages.

post

/pdf/pages/remove

Header parameters

authstringrequired

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

pagesstringrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/pages/remove' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"getAsUrl":true,"pages":"1,3-5,^3-^1"}'

200

400

application/octet-stream

application/json

No body

Success

Resize PDF pages.

post

/pdf/pages/resize

Header parameters

authstringrequired

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

widthnumberrequired

The new width in points.

heightnumberrequired

The new height in points.

pagesstringrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/pages/resize' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"getAsUrl":true,"width":1,"height":1,"pages":"1,3-5,^3-^1"}'

200

400

application/octet-stream

application/json

No body

Success

Rotate PDF pages.

post

/pdf/pages/rotate

Header parameters

authstringrequired

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

rotatenumberrequired

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

Example: 90

pagesstringrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/pages/rotate' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"getAsUrl":true,"rotate":90,"pages":"1,3-5,^3-^1"}'

200

400

application/octet-stream

application/json

No body

Success

Convert PDF to Base64.

post

/pdf/base64

Header parameters

authstringrequired

Body

pdfstringrequired

The PDF URL.

fileNamestring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/base64' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"pdf":"text"}'

200

400

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

Success

Compress PDF.

post

/pdf/compress

Header parameters

authstringrequired

Body

urlstring

bufferstring

getAsUrlboolean

fileNamestring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/compress' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

application/octet-stream

application/json

No body

Success

Count PDF pages.

post

/pdf/count

Header parameters

authstringrequired

Body

urlstring

The PDF URL.

bufferstring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/count' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

{
  "pageCount": 1
}

Success

Decrypt PDF.

post

/pdf/decrypt

Header parameters

authstringrequired

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

passwordstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/decrypt' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"getAsUrl":true,"password":"text"}'

200

400

application/octet-stream

application/json

No body

Success

Create empty PDF.

post

/pdf/create

Header parameters

authstringrequired

Body

getAsUrlboolean

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

Example: true

pagesnumber · min: 1

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/create' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"getAsUrl":true,"pages":10,"width":595,"height":842}'

200

400

application/octet-stream

application/json

No body

Success

Convert DOCX to PDF.

post

/pdf/docx-to-pdf

Header parameters

authstringrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/docx-to-pdf' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"getAsUrl":true}'

200

400

application/octet-stream

application/json

No body

Success

Encrypt PDF.

post

/pdf/encrypt

Header parameters

authstringrequired

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

userPasswordstringrequired

The user password.

ownerPasswordstring

The owner password. Default is the user password.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/encrypt' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"getAsUrl":true,"userPassword":"text"}'

200

400

application/octet-stream

application/json

No body

Success

Get PDF metadata.

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

post

/pdf/getinfometadata

Header parameters

authstringrequired

Body

pdfstringrequired

The PDF URL or Base64-encoded buffer.

filenamestring

The PDF file name. Default is a random ID.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/getinfometadata' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"pdf":"text"}'

200

400

{
  "title": "text",
  "author": "text",
  "producer": "text",
  "creator": "text",
  "creationDate": "2025-02-21T18:09:24.467Z",
  "modificationDate": "2025-02-21T18:09:24.467Z",
  "pageCount": 1,
  "filename": "text"
}

Success

Convert HTML to PDF.

post

/pdf/html

Header parameters

authstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/html' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"getAsUrl":true,"options":{"scale":1,"displayHeaderFooter":false,"printBackground":false,"landscape":false,"pageRanges":"1-3,8,15-20","preferCSSPageSize":false,"omitBackground":false,"tagged":true,"format":"a4","margin":{}}}'

200

400

application/octet-stream

application/json

No body

Success

Convert Markdown to PDF.

post

/pdf/markdownstringtopdf

Header parameters

authstringrequired

Body

markdownStringstringrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/markdownstringtopdf' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"markdownString":"text","getAsUrl":true}'

200

400

application/octet-stream

application/json

No body

Success

Merge PDF files.

post

/pdf/merge

Header parameters

authstringrequired

Body

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.

filesobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/merge' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"getAsUrl":true,"files":[{"pages":"1-3,5,^15-^13,^6-"}]}'

200

400

application/octet-stream

application/json

No body

Success

Convert PDF to image.

post

/pdf/pdf-to-image

Header parameters

authstringrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/pdf-to-image' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Success

Split PDF file.

post

/pdf/split

Header parameters

authstringrequired

Body

urlstring

The PDF URL.

bufferstring

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

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.

pagesstring[]

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pdf/split' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"pages":[null]}'

200

400

{
  "pdfUrls": [
    "text"
  ]
}

Success

Create shortened URL.

post

/add

Header parameters

authstringrequired

Body

sendToWebhookstringrequired

datastringrequired

endDatestring

destinationstringrequired

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

intervalTypestring · enumrequired

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.

Options: 1, 2, 3, 4

intervalOptionsany ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/add' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"sendToWebhook":"text","data":"text","destination":"https://0codekit.com","custom":"to4w5vyb","intervalType":1}'

200

400

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

Success

Delete shortened URL.

post

/del

Header parameters

authstringrequired

Body

taskIdstringrequired

identifierstringrequired

The shortened URL identifier that was returned by /add.

Example: to4w5vyb

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/del' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"taskId":"text","identifier":"to4w5vyb"}'

200

400

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

Success

List shortened URLs.

post

/list

Header parameters

authstringrequired

Body

object

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/list' \
  --header 'auth: text' \
  --header 'Content-Type: application/json'

200

400

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

Success

Get shortened URL.

post

/get

Header parameters

authstringrequired

Body

identifierstringrequired

The shortened URL identifier that was returned by /add.

Example: to4w5vyb

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/get' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"identifier":"to4w5vyb"}'

200

400

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

Success

Update shortened URL.

post

/put

Header parameters

authstringrequired

Body

identifierstringrequired

The shortened URL identifier that was returned by /add.

Example: to4w5vyb

destinationstringrequired

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

Example: https://example.com

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/put' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{"identifier":"to4w5vyb","destination":"https://example.com"}'

200

400

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

Success