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

Extract text from given PDF (Advanced OCR)

post

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

Header parameters

authstringrequired

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

Body

urlstringoptional

The URL to the document.

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

bufferstringoptional

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

resultTypestring · enumrequired

Result type specifies the output type.

Available options:

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.

languagestringoptional

The language of the uploaded document.

documentTypestringoptional

The type of the uploaded document.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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",
    "buffer": "text",
    "resultType": "ocr",
    "workflow": "text",
    "language": "text",
    "documentType": "text"
  }'

200

400

200

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Success

Extract a custom object from a given text.

post

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.

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

No body

Success

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

post

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.

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

contextstringoptional

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"]

optionsobjectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

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

Success

Redact sensitive information from pdf.

post

Header parameters

authstringrequired

Body

urlstringoptional

The PDF URL.

bufferstringoptional

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.

fileNamestringoptional

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

getAsUrlbooleanoptional

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

Example: true

languagestringoptional

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

Example: de

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

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

Success

Detect adult content.

post

Check if the content is appropriate for all audiences.

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{}

Success

Detect text in an image.

post

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

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "recognizedTexts": [
    "text"
  ]
}

Success

Text Entity Detection.

post

Identities Entities From Input Text.

Header parameters

authstringrequired

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

Body

textstringrequired

Text for entity detection.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Remove image background.

post

Remove background from image url or buffer.

Header parameters

authstringrequired

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

Body

urlstringoptional

bufferstringoptional

getAsUrlbooleanrequired

fileNamestringoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{}

Success

Detect brand

post

Detect brand from given image.

Header parameters

authstringrequired

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

Body

imageUrlstringrequired

Image for brand detection.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "brands": [
    "text"
  ]
}

Success

Generate python code.

post

Generate python code based on provided prompt.

Header parameters

authstringrequired

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

Body

promptstringrequired

Prompt to generate python code.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Detect color.

post

Detect color from given image.

Header parameters

authstringrequired

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

Body

imageUrlstringrequired

Image for color detection.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{}

Success

Too Long To Read

post

Creates a summary of the given text.

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

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

post

Detect language of given text.

Header parameters

authstringrequired

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

Body

textstringrequired

Text for language detection.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Transcribe audio.

post

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.

Header parameters

authstringrequired

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

Body

urlstringoptional

The URL to the audio file.

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

bufferstringoptional

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

langstringoptional

The audio language. Default is en.

Example: en

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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",
    "buffer": "text",
    "lang": "en"
  }'

200

400

200

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

Success

Detect labels in an image.

post

Detects labels in an image using the Google Vision API.

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "recognizedLabels": [
    "text"
  ]
}

Success

Generate an image.

post

Generate an image based on prompt.

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

Available options:

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Extract contact information.

post

Extract contact information from given prompt.

Header parameters

authstringrequired

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

Body

promptstringrequired

Prompt for contact info extraction.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Generate javascript code.

post

Generate javascript code based on provided prompt.

Header parameters

authstringrequired

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

Body

promptstringrequired

Prompt to generate javascript code.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Detect mood.

post

Detect mood from given text.

Header parameters

authstringrequired

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

Body

textstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Detect face.

post

Detect face from given image.

Header parameters

authstringrequired

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

Body

imageUrlstringrequired

Image for face detection.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Detect email type.

post

Detect email type from provided subject and body.ß

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

PDF Optical Character Recognition.

post

Header parameters

authstringrequired

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

Body

pdfUrlstringrequired

PDF URL.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "recognizedText": "text"
}

Success

Check content policy.

post

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

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Translate text to a specified language.

post

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

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "translation": "text"
}

Success

Hash a message.

post

Header parameters

authstringrequired

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

Body

hashTypestring · enumrequired

Available options:

messagestringrequired

secretKeystringoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "hashedText": "text"
}

Success

Decrypt ciphertext.

post

Header parameters

authstringrequired

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

Body

cryptoTypestring · enumrequired

Available options:

ciphertextstringrequired

The ciphertext.

secretKeystringrequired

The encryption key.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "decryptedText": "text"
}

Success

Encrypt plaintext.

post

Header parameters

authstringrequired

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

Body

cryptoTypestring · enumrequired

Available options:

messagestringrequired

The plaintext.

secretKeystringrequired

The encryption key.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "encryptedText": "text"
}

Success

Calculate geographical distance.

post

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.

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

Available options:

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

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

Success

Calculate the BMI.

post

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

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Find gender of name.

post

Header parameters

authstringrequired

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

Body

firstnamestringoptional

The first name.

fullnamestringoptional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Retrieve credits.

post

Header parameters

authstringrequired

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

Body

objectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "credits": 1
}

Success

Remove duplicates from the list.

post

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "list": []
}

Success

Parse URL query parameters.

post

Header parameters

authstringrequired

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

Body

urlstringrequired

The URL.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Success

Get website logo URL.

post

Header parameters

authstringrequired

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

Body

urlstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Get thumbnail for video.

post

Header parameters

authstringrequired

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

Body

urlstringrequired

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

getAsUrlbooleanoptional

fileNamestringoptional

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

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

Success

Get JSON values from keys.

post

Header parameters

authstringrequired

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

Body

externalbooleanrequired

jsonany ofrequired

keyany ofrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "found": []
}

Success

Check rate limit.

post

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

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

{
  "ok": true
}

Success

Split name.

post

Split a full name into its first and last name.

Header parameters

authstringrequired

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

Body

namestringrequired

The full name that will be split.

reversedbooleanoptional

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Expand URL.

post

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

Header parameters

authstringrequired

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

Body

urlstringrequired

The URL.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "unshortenedUrl": "text"
}

Success

Build UTM link.

post

Header parameters

authstringrequired

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

Body

urlstringrequired

The base URL.

utmobjectrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "url": "text"
}

Success

Parse UTM link.

post

Header parameters

authstringrequired

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

Body

urlstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Parse HTML.

post

Header parameters

authstringrequired

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

Body

htmlstringoptional

urlstringoptional

allbooleanoptional

selectorstringoptional

tagSelectorstringoptional

idSelectorstringoptional

classSelectorstringoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/operator/htmlparser/get' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "html": "text",
    "url": "text",
    "all": true,
    "selector": "text",
    "tagSelector": "text",
    "idSelector": "text",
    "classSelector": "text"
  }'

200

400

200

{
  "data": "text"
}

Success

Merge audio into a video file with optional customizations.

post

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

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

fileNamestringoptional

The name of the merged video.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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",
    "fileName": "text"
  }'

200

400

200

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

Success

Convert between ISO and nation name.

post

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

Header parameters

authstringrequired

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

Body

isostringoptional

The ISO code of the nation.

nationstringoptional

The English name of the nation.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/convert/nationiso' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "iso": "text",
    "nation": "text"
  }'

200

400

200

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

Success

Convert Outlook item files.

post

Header parameters

authstringrequired

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

Body

urlstringoptional

bufferstringoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

No body

Success

Convert between currencies.

post

Header parameters

authstringrequired

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

Body

sourceCurrencystringrequired

targetCurrencystringrequired

amountnumberrequired

dateFormatstringoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Convert IP to location.

post

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Convert CSV to JSON.

post

Header parameters

authstringrequired

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

Body

csvstringrequired

The CSV string that will be converted.

noheaderbooleanoptional

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

delimiterany ofoptional

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

trimbooleanoptional

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

ignoreEmptybooleanoptional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "json": []
}

Success

Convert CSV to array.

post

Header parameters

authstringrequired

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

Body

csvstringrequired

The CSV string that will be parsed.

omitFirstRowbooleanoptional

Whether to omit the first row. Default is false.

delimiterstringrequired

The delimiter by which the rows will be split.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Look up VAT rate.

post

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

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

post

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

Header parameters

authstringrequired

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

Body

emailstringrequired

The email address that should be checked.

Example: [e-mail]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/business/isfreemail' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "[e-mail]"
  }'

200

400

200

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

Success

Validate Geolocation.

post

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

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Validate the phone number.

post

Checks whether the phone number is valid.

Header parameters

authstringrequired

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

Body

phoneNumberstringrequired

The phone number to validate.

Example: ([phone]

countryCodestringoptional

Short abbreviation of a country.

Example: JP

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/business/validate/phonenumber' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "phoneNumber": "([phone]",
    "countryCode": "JP"
  }'

200

400

200

{
  "phoneNumber": "([phone]",
  "internationNumber": "\"[phone]",
  "number": "[phone]",
  "nationalNumber": "9012345678",
  "countryCode": "JP",
  "possibleNumber": true,
  "isValid": true
}

Success

Validate IBAN

post

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

Header parameters

authstringrequired

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

Body

ibanstringrequired

The IBAN

Example: DE02120300000000202051

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "valid": true
}

Success

Validate a VAT ID.

post

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

Header parameters

authstringrequired

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

Body

vatIdstringoptional

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

Example: DE123456789

countryCodestring · enumoptional

The country code of the VAT ID.

Example: IT

Available options:

idstringoptional

The number part of the VAT ID.

Example: 07643520567

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Validate a BIC.

post

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

Header parameters

authstringrequired

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

Body

bicstringrequired

The BIC.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "valid": true
}

Success

Verify domain.

post

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

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Validate a Factur-X/Zugferd PDF.

post

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.

Header parameters

authstringrequired

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

Body

urlstringoptional

The PDF URL.

bufferstringoptional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

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

post

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.

Header parameters

authstringrequired

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

Body

urlstringoptional

The PDF URL.

bufferstringoptional

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

xmlstringrequired

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

getAsUrlbooleanoptional

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

fileNamestringoptional

The PDF file name. Default is a random ID.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{}

Success

Upload a temporary file.

post

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

Header parameters

authstringrequired

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

Body

fileNamestringoptional

The file name. Default is a random string.

Example: my-file.txt

bufferstringrequired

The Base64-encoded file buffer.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Delete from permanent storage.

post

Header parameters

authstringrequired

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

Body

fileIdstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "message": "text"
}

Success

Get permanent file.

post

Header parameters

authstringrequired

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

Body

fileNamestringoptional

fileIdstringoptional

getAsUrlbooleanoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{}

Success

List permanent files.

post

Header parameters

authstringrequired

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

Body

objectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Upload to permanent storage.

post

Header parameters

authstringrequired

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

Body

fileUrlstringoptional

fileBufferstringoptional

uploadNamestringoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/storage/perm/add' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "fileUrl": "text",
    "fileBuffer": "text",
    "uploadName": "text"
  }'

200

400

200

{
  "fileId": "text"
}

Success

Delete a global variable.

post

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

Header parameters

authstringrequired

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

Body

variableIdstringrequired

The variable name.

Example: myVariable

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Update a global variable.

post

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

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Get a global variable.

post

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

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

List all variables.

post

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

Header parameters

authstringrequired

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

Body

objectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Add a global variable.

post

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

Header parameters

authstringrequired

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

Body

variableNamestringoptional

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Delete a JSON bin.

post

Header parameters

authstringrequired

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

Body

binIdstringrequired

The ID of the JSON bin.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "message": "text"
}

Success

Put data into JSON bin.

post

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

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "binId": "text"
}

Success

Get a JSON bin.

post

Header parameters

authstringrequired

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

Body

binIdstringrequired

The ID of the JSON bin.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

List JSON bins.

post

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

Header parameters

authstringrequired

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

Body

objectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Add a JSON bin.

post

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Retrieve calendar weeks

post

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

Header parameters

authstringrequired

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

Body

datestringoptional

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

weekNumbernumberoptional

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

Example: 5

yearnumberoptional

The year parameter provides year of the given weekNumber.

Example: 2023

unixTimestampnumberoptional

The date in unixTimestamp format.

Example: 1642918727

dateFormatstringoptional

Format of provided date.

Example: DD.MM.YYYY

outputFormatstringoptional

Format of the output date

Example: DD.MM.YYYY

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

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

Success

Check weekend date.

post

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

Header parameters

authstringrequired

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

Body

datestringrequired

The date for which information is requested.

dateFormatstringoptional

The format of the input date.

timeZonestringoptional

The timezone

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Convert between timezones.

post

Converts a date and time from one timezone to another.

Header parameters

authstringrequired

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

Body

inputTimeany ofrequired

The time that will be converted.

Example: 08-12-2024 12:00

inputTimeZonestringrequired

The timezone of the input time.

Example: Europe/Berlin

formatPatternstringoptional

The format of the output time.

destinationTimeZonestringrequired

The timezone of the output time.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Retrieve holidays.

post

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

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

statestringoptional

The state within the country (if applicable).

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "holidays": [
    {
      "date": "text",
      "start": "2025-04-02T14:05:13.515Z",
      "end": "2025-04-02T14:05:13.515Z",
      "name": "text",
      "type": "text",
      "rule": "text"
    }
  ]
}

Success

Retrieve date range details.

post

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

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Monthly date details

post

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

Header parameters

authstringrequired

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

Body

datestringoptional

Date parameter

dateFormatstringoptional

Format of the input date

monthnumber · min: 1 · max: 12optional

Number of the month.

yearnumberoptional

Year

outputFormatstringoptional

Format of the output date

optionsobjectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/dateandtime/month' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "date": "text",
    "dateFormat": "text",
    "month": 1,
    "year": 1,
    "outputFormat": "text",
    "options": {
      "timeStamp": true
    }
  }'

200

400

200

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

Success

Check auth status.

post

Header parameters

authstringrequired

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

Body

objectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Generate a city.

post

Header parameters

authstringrequired

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

Body

objectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Generate a number.

post

Header parameters

authstringrequired

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

Body

rangenumber[] · min: 2 · max: 2required

The range of the generated number.

typestring · enumoptional

The type of generated number. Default is integer.

Available options:

roundnumberoptional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "randomNumber": 1
}

Success

Generate random string.

post

Generate random string based on type and length.

Header parameters

authstringrequired

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

Body

typestring · enumoptional

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

Available options:

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.

customstring[]optional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "randomString": "text"
}

Success

Generate a name.

post

Header parameters

authstringrequired

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

Body

genderstring · enumoptional

Available options:

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Generate a color.

post

Header parameters

authstringrequired

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

Body

hueany ofoptional

The hue of the generated color. Default is random.

luminositystring · enumoptional

The luminosity of the generated color. Default is random.

Available options:

seedany ofoptional

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

formatstring · enumoptional

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.

Available options:

alphanumber · max: 1optional

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.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "color": "text"
}

Success

Generate user mockdata.

post

Header parameters

authstringrequired

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

Body

amountnumber · max: 100optional

The amount of users to generate. Default is 1.

emailRequiredbooleanoptional

avatarRequiredbooleanoptional

passwordRequiredbooleanoptional

birthDateRequiredbooleanoptional

usernameRequiredbooleanoptional

addressRequiredbooleanoptional

cityRequiredbooleanoptional

countryRequiredbooleanoptional

phoneRequiredbooleanoptional

createdAtRequiredbooleanoptional

balanceRequiredbooleanoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/generate/mockdata/user' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 1,
    "emailRequired": true,
    "avatarRequired": true,
    "passwordRequired": true,
    "birthDateRequired": true,
    "usernameRequired": true,
    "addressRequired": true,
    "cityRequired": true,
    "countryRequired": true,
    "phoneRequired": true,
    "createdAtRequired": true,
    "balanceRequired": true
  }'

200

400

200

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

Header parameters

authstringrequired

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

Body

urlstringrequired

textOnlybooleanoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "data": "text"
}

Success

Encode JWT.

post

Header parameters

authstringrequired

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

Body

dataanyrequired

secretstringrequired

optionsobjectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

{
  "token": "text"
}

Success

Decode JWT.

post

Header parameters

authstringrequired

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

Body

tokenstringrequired

verifybooleanoptional

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

secretstringoptional

The HMAC secret or PEM-encoded public key.

optionsobjectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

No body

Success

Generate a QR code.

post

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

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

widthnumberoptional

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

Example: 500

heightnumberoptional

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

Example: 500

imagestringoptional

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

marginnumberoptional

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

Example: 15

qrOptionsobjectoptional

Options for the QR code data.

imageOptionsobjectoptional

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

dotsOptionsobjectoptional

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

cornersSquareOptionsobjectoptional

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

cornersDotOptionsobjectoptional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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,
    "qrOptions": {
      "typeNumber": 5,
      "mode": "Byte",
      "errorCorrectionLevel": "Q"
    },
    "imageOptions": {
      "hideBackgroundDots": true,
      "margin": 0
    },
    "dotsOptions": {
      "type": "square",
      "color": "#000000",
      "gradient": {
        "type": "linear",
        "rotation": 1,
        "colorStops": [
          {
            "offset": 0,
            "color": "#FF0000"
          }
        ]
      }
    },
    "cornersSquareOptions": {
      "type": "square",
      "color": "#000000",
      "gradient": {
        "type": "linear",
        "rotation": 1,
        "colorStops": [
          {
            "offset": 0,
            "color": "#FF0000"
          }
        ]
      }
    },
    "cornersDotOptions": {
      "type": "square",
      "color": "#000000",
      "gradient": {
        "type": "linear",
        "rotation": 1,
        "colorStops": [
          {
            "offset": 0,
            "color": "#FF0000"
          }
        ]
      }
    }
  }'

200

400

200

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

Success

Decode a QR code.

post

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

Header parameters

authstringrequired

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

Body

urlstringoptional

The URL to the QR code.

bufferstringoptional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/generate/qrcode/decode' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "text",
    "buffer": "text"
  }'

200

400

200

{
  "data": "text"
}

Success

Decode barcode.

post

Header parameters

authstringrequired

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

Body

urlstringoptional

bufferstringoptional

barcodestring · enumrequired

The barcode format.

Available options:

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "code": "text"
}

Success

Generate barcode.

post

Header parameters

authstringrequired

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

Body

datastringrequired

optionsobjectoptional

formatstring · enumoptional

The generated file type. Default is svg.

Available options:

getAsUrlbooleanoptional

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

fileNamestringoptional

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/generate/barcode/encode' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "data": "text",
    "options": {
      "format": "text",
      "width": 1,
      "height": 1,
      "displayValue": true,
      "fontOptions": "text",
      "font": "text",
      "text": "text",
      "textAlign": "text",
      "textPosition": "text",
      "textMargin": 1,
      "fontSize": 1,
      "background": "text",
      "lineColor": "text",
      "margin": 1,
      "marginTop": 1,
      "marginBottom": 1,
      "marginLeft": 1,
      "marginRight": 1
    },
    "format": "svg",
    "getAsUrl": true,
    "fileName": "text"
  }'

200

400

200

application/json

application/octet-stream

application/json

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

Success

Evaluate text against a regex.

post

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

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

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

Success

Keyword search in text.

post

Searches text for keywords and returns their positions.

Header parameters

authstringrequired

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

Body

textstringrequired

Text from which you want to find keywords.

keywordstringoptional

Single keyword.

keywordListstring[]optional

Multiple keywords.

optionsobjectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Compare two strings.

post

Calculate similarity score between two strings

Header parameters

authstringrequired

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

Body

string1stringrequired

First String.

string2stringrequired

Second String.

algorithmstringoptional

Similarity algorithm.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Extract text from body.

post

Extracts text from body between given start and end markers

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

greedybooleanoptional

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

caseSensitivebooleanoptional

When true, It make the body case sensitive.

returnEmptyIfNotFoundbooleanoptional

When true, Return error if markers not found.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "text": "text"
}

Success

Execute Python code.

post

Header parameters

authstringrequired

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

Body

codestringrequired

The Python code that will be executed.

requirementsstring[]optional

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "result": null
}

Success

Note on the Asynchronous Python Code Executor Pricing

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

• Charges are applied every 3 minutes, which is the standard execution time increment for the synchronous Python executor.

• You are charged for each 3-minute interval (or part thereof) that your code runs asynchronously.

Execute async Python.

post

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

Header parameters

authstringrequired

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

Body

codestringrequired

The Python script that will be executed.

requirementsstring[]optional

The PyPI libraries your Python code requires.

sendTostringoptional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Execute JavaScript code.

post

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

No body

Success

Get async task status.

post

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Generate Bar Chart

post

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

Header parameters

authstringrequired

Body

datanumber[]required

Data points for the bar chart.

labelsstring[]required

Labels corresponding to the data points.

getAsUrlbooleanoptional

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

widthnumberoptional

Width of the chart image.

heightnumberoptional

Height of the chart image.

backgroundColorstringoptional

Background color of the chart image.

bordersColorsstring[]optional

Colors for the borders of the bars.

barsColorsstring[]optional

Colors for the bars in the chart.

borderWidthnumberoptional

Width of the borders around the bars.

titlestringoptional

Title of the chart.

optionsobjectoptional

Additional configuration options for Chart.js.

fileNamestringoptional

Optional filename for the generated chart image.

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/chart/bars' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "data": [
      1
    ],
    "labels": [
      "text"
    ],
    "getAsUrl": true,
    "width": 1,
    "height": 1,
    "backgroundColor": "text",
    "bordersColors": [
      "text"
    ],
    "barsColors": [
      "text"
    ],
    "borderWidth": 1,
    "title": "text",
    "options": {},
    "fileName": "text"
  }'

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Generate Doughnut Chart

post

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

Header parameters

authstringrequired

Body

datanumber[]required

Data points for the doughnut chart.

labelsstring[]required

Labels corresponding to the data points.

getAsUrlbooleanoptional

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

widthnumberoptional

Width of the chart image.

heightnumberoptional

Height of the chart image.

backgroundColorstringoptional

Background color of the chart image.

bordersColorsstring[]optional

Colors for the borders of the doughnut.

barsColorsstring[]optional

Colors for the doughnut in the chart.

borderWidthnumberoptional

Width of the borders around the doughnut.

titlestringoptional

Title of the chart.

optionsobjectoptional

Additional configuration options for Chart.js.

fileNamestringoptional

Optional filename for the generated chart image.

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/chart/doughnut' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "data": [
      1
    ],
    "labels": [
      "text"
    ],
    "getAsUrl": true,
    "width": 1,
    "height": 1,
    "backgroundColor": "text",
    "bordersColors": [
      "text"
    ],
    "barsColors": [
      "text"
    ],
    "borderWidth": 1,
    "title": "text",
    "options": {},
    "fileName": "text"
  }'

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Generate Line Chart

post

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

Header parameters

authstringrequired

Body

datanumber[]required

Data points for the line chart.

labelsstring[]required

Labels corresponding to the data points.

getAsUrlbooleanoptional

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

widthnumberoptional

Width of the chart image.

heightnumberoptional

Height of the chart image.

backgroundColorstringoptional

Background color of the chart image.

bordersColorsstring[]optional

Colors for the borders of the line.

barsColorsstring[]optional

Colors for the line in the chart.

fillbooleanoptional

Fill the color under the line.

tensionnumberoptional

Tension of the line.

borderWidthnumberoptional

Width of the borders around the line.

titlestringoptional

Title of the chart.

optionsobjectoptional

Additional configuration options for Chart.js.

fileNamestringoptional

Optional filename for the generated chart image.

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/chart/line' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "data": [
      1
    ],
    "labels": [
      "text"
    ],
    "getAsUrl": true,
    "width": 1,
    "height": 1,
    "backgroundColor": "text",
    "bordersColors": [
      "text"
    ],
    "barsColors": [
      "text"
    ],
    "fill": true,
    "tension": 1,
    "borderWidth": 1,
    "title": "text",
    "options": {},
    "fileName": "text"
  }'

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Blur an image.

post

Header parameters

authstringrequired

Body

urlstringoptional

The image URL

bufferstringoptional

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

sigmanumber · min: 0.3 · max: 1000optional

How strongly the image will be blurred.

getAsUrlbooleanoptional

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

fileNamestringoptional

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

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/image/blur' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "text",
    "buffer": "text",
    "sigma": 1,
    "getAsUrl": true,
    "fileName": "text"
  }'

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Convert an image.

post

Header parameters

authstringrequired

Body

urlstringoptional

The image URL

bufferstringoptional

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

outputFormatstring · enumrequired

The output format of the conversion.

Available options:

withMetaDatabooleanoptional

Whether the image metadata should be converted, too.

optionsobjectoptional

getAsUrlbooleanoptional

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

fileNamestringoptional

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

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Get EXIF data.

post

Header parameters

authstringrequired

Body

urlstringoptional

The image URL

bufferstringoptional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/image/exif' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "text",
    "buffer": "text"
  }'

200

400

200

{
  "exifData": null
}

Success

Crop an image.

post

Header parameters

authstringrequired

Body

urlstringoptional

The image URL

bufferstringoptional

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

optionsobjectrequired

getAsUrlbooleanoptional

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

fileNamestringoptional

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

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Flip an image.

post

Header parameters

authstringrequired

Body

urlstringoptional

The image URL

bufferstringoptional

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

axisstring · enumrequired

The axis the image will be flipped about.

Available options:

getAsUrlbooleanoptional

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

fileNamestringoptional

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

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Convert HTML to image.

post

Header parameters

authstringrequired

Body

urlstringoptional

The image URL

htmlstringoptional

The HTML source. Can be specified instead of url.

optionsobjectoptional

getAsUrlbooleanoptional

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

fileNamestringoptional

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

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Overlay two images.

post

Header parameters

authstringrequired

Body

frontImageUrlstringrequired

The URL of the front image.

backImageUrlstringrequired

The URL of the background image.

positionstring · enumoptional

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

Available options:

getAsUrlbooleanoptional

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

optionsobjectoptional

fileNamestringoptional

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

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/image/overlay' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "frontImageUrl": "text",
    "backImageUrl": "text",
    "position": "center",
    "getAsUrl": true,
    "options": {
      "horizontalPosition": 1,
      "verticalPosition": 1,
      "opacity": 1,
      "type": "text"
    },
    "fileName": "text"
  }'

200

400

200

application/json

application/octet-stream

application/json

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

Success

Resize an image.

post

Header parameters

authstringrequired

Body

urlstringoptional

bufferstringoptional

widthnumberoptional

heightnumberoptional

optionsobjectoptional

getAsUrlbooleanoptional

fileNamestringoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/image/resize' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "text",
    "buffer": "text",
    "width": 1,
    "height": 1,
    "options": {
      "fit": "contain",
      "position": "center",
      "background": "text",
      "kernel": "nearest"
    },
    "getAsUrl": true,
    "fileName": "text"
  }'

200

400

200

{}

Success

Rotate an image.

post

Header parameters

authstringrequired

Body

urlstringoptional

The image URL

bufferstringoptional

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

anglenumberrequired

The clockwise rotation.

backgroundstringoptional

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

getAsUrlbooleanoptional

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

fileNamestringoptional

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

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Sharpen an image.

post

Header parameters

authstringrequired

Body

urlstringoptional

The image URL

bufferstringoptional

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

sigmanumber · min: 0.3 · max: 1000optional

How strongly the image will be sharpened.

getAsUrlbooleanoptional

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

fileNamestringoptional

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

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/image/sharpen' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "text",
    "buffer": "text",
    "sigma": 1,
    "getAsUrl": true,
    "fileName": "text"
  }'

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Draw image on PDF.

post

Header parameters

authstringrequired

Body

urlstringoptional

The PDF URL.

bufferstringoptional

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

getAsUrlbooleanoptional

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

Example: true

imageUrlstringoptional

The URL of the image to draw.

imageBufferstringoptional

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

anchorstring · enumoptional

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

Example: center

Available options:

alignstring · enumoptional

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

Example: center

Available options:

xnumberoptional

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

Example: 0

ynumberoptional

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

Example: 0

widthnumberoptional

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

heightnumberoptional

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

rotatenumberoptional

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

Example: 45

pagesstringoptional

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.

fileNamestringoptional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{}

Success

Draw text on PDF.

post

Header parameters

authstringrequired

Body

urlstringoptional

The PDF URL.

bufferstringoptional

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

getAsUrlbooleanoptional

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

Example: true

textstringrequired

The text to draw.

Example: Hello, world!

fontstring · enumoptional

The font to use. Default is Helvetica.

Example: Helvetica

Available options:

anchorstring · enumoptional

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

Example: center

Available options:

alignstring · enumoptional

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

Example: center

Available options:

xnumberoptional

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

Example: 0

ynumberoptional

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

Example: 0

rotatenumberoptional

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

Example: 45

sizenumberoptional

The font size in points. Default is 32.

Example: 32

colorstringoptional

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

Example: FFFF00

pagesstringoptional

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

fileNamestringoptional

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

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Edit PDF metadata.

post

Header parameters

authstringrequired

Body

urlstringoptional

The PDF URL.

bufferstringoptional

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

getAsUrlbooleanoptional

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

Example: true

titlestringoptional

The new title of the PDF.

authorstringoptional

The new author of the PDF.

subjectstringoptional

The new subject of the PDF.

keywordsstring[]optional

The new keywords of the PDF.

fileNamestringoptional

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

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Get PDF metadata.

post

Header parameters

authstringrequired

Body

urlstringoptional

The PDF URL.

bufferstringoptional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "title": "text",
  "author": "text",
  "subject": "text",
  "keywords": [
    "text"
  ],
  "creator": "text",
  "creationDate": "2025-04-02T14:05:13.515Z",
  "modificationDate": "2025-04-02T14:05:13.515Z",
  "isEncrypted": true,
  "pageCount": 1,
  "pages": [
    {
      "width": 1,
      "height": 1,
      "rotation": 1
    }
  ]
}

Success

Add PDF pages.

post

Header parameters

authstringrequired

Body

urlstringoptional

The PDF URL.

bufferstringoptional

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

getAsUrlbooleanoptional

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

Example: true

widthnumberoptional

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

Example: 595

heightnumberoptional

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

Example: 842

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.

fileNamestringoptional

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

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Remove PDF pages.

post

Header parameters

authstringrequired

Body

urlstringoptional

The PDF URL.

bufferstringoptional

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

getAsUrlbooleanoptional

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

fileNamestringoptional

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

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Resize PDF pages.

post

Header parameters

authstringrequired

Body

urlstringoptional

The PDF URL.

bufferstringoptional

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

getAsUrlbooleanoptional

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

fileNamestringoptional

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

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Rotate PDF pages.

post

Header parameters

authstringrequired

Body

urlstringoptional

The PDF URL.

bufferstringoptional

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

getAsUrlbooleanoptional

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

fileNamestringoptional

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

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Convert PDF to Base64.

post

Header parameters

authstringrequired

Body

pdfstringrequired

The PDF URL.

fileNamestringoptional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Compress PDF.

post

Header parameters

authstringrequired

Body

urlstringoptional

bufferstringoptional

getAsUrlbooleanoptional

fileNamestringoptional

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Count PDF pages.

post

Header parameters

authstringrequired

Body

urlstringoptional

The PDF URL.

bufferstringoptional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "pageCount": 1
}

Success

Decrypt PDF.

post

Header parameters

authstringrequired

Body

urlstringoptional

The PDF URL.

bufferstringoptional

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

getAsUrlbooleanoptional

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/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Create empty PDF.

post

Header parameters

authstringrequired

Body

getAsUrlbooleanoptional

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

Example: true

pagesnumber · min: 1optional

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

Example: 10

widthnumberoptional

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

Example: 595

heightnumberoptional

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

Example: 842

fileNamestringoptional

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

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Convert DOCX to PDF.

post

Header parameters

authstringrequired

Body

urlstringoptional

The DOCX URL.

bufferstringoptional

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

getAsUrlbooleanoptional

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

Example: true

fileNamestringoptional

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

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Encrypt PDF.

post

Header parameters

authstringrequired

Body

urlstringoptional

The PDF URL.

bufferstringoptional

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

getAsUrlbooleanoptional

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

Example: true

userPasswordstringrequired

The user password.

ownerPasswordstringoptional

The owner password. Default is the user password.

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Get PDF metadata.

post

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

Header parameters

authstringrequired

Body

pdfstringrequired

The PDF URL or Base64-encoded buffer.

filenamestringoptional

The PDF file name. Default is a random ID.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "title": "text",
  "author": "text",
  "producer": "text",
  "creator": "text",
  "creationDate": "2025-04-02T14:05:13.515Z",
  "modificationDate": "2025-04-02T14:05:13.515Z",
  "pageCount": 1,
  "filename": "text"
}

Success

Convert HTML to PDF.

post

Header parameters

authstringrequired

Body

urlstringoptional

The URL of the website.

htmlstringoptional

The HTML source. Can be specified instead of url

getAsUrlbooleanoptional

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

Example: true

fileNamestringoptional

The PDF file name. Default is a random ID.

optionsobjectoptional

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Convert Markdown to PDF.

post

Header parameters

authstringrequired

Body

markdownStringstringrequired

The Markdown source that will be converted to a PDF.

cssstringoptional

Custom CSS to change the Markdown look.

getAsUrlbooleanoptional

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

Example: true

fileNamestringoptional

The PDF file name. Default is a random ID.

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Merge PDF files.

post

Header parameters

authstringrequired

Body

filesobject[]required

getAsUrlbooleanoptional

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

Example: true

fileNamestringoptional

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

Responses

application/jsonapplication/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

application/json

application/octet-stream

application/json

{
  "url": "text"
}

Success

Convert PDF to image.

post

Header parameters

authstringrequired

Body

urlstringoptional

The PDF URL.

bufferstringoptional

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

fileNamestringoptional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/pdf/pdf-to-image' \
  --header 'auth: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "text",
    "buffer": "text",
    "fileName": "text"
  }'

200

400

200

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Success

Split PDF file.

post

Header parameters

authstringrequired

Body

urlstringoptional

The PDF URL.

bufferstringoptional

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

pagesstring[]optional

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.

intervalnumberoptional

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

fileNamestringoptional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "pdfUrls": [
    "text"
  ]
}

Success

Create shortened URL.

post

Header parameters

authstringrequired

Body

sendToWebhookstringrequired

datastringrequired

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.

Available options:

intervalOptionsany ofrequired

endDatestringoptional

destinationstringrequired

The destination URL which the shortened URL will point to.

Example: https://0codekit.com

customstringoptional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Delete shortened URL.

post

Header parameters

authstringrequired

Body

taskIdstringrequired

identifierstringrequired

The shortened URL identifier that was returned by /add.

Example: to4w5vyb

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

List shortened URLs.

post

Header parameters

authstringrequired

Body

objectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Get shortened URL.

post

Header parameters

authstringrequired

Body

identifierstringrequired

The shortened URL identifier that was returned by /add.

Example: to4w5vyb

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success

Update shortened URL.

post

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Success