{"openapi":"3.0.2","info":{"title":"0CodeKit API","description":"The API documentation for 0CodeKit, a low- and no-code platform for automation using Make, Zapier or n8n.","version":"2.0.0"},"components":{"securitySchemes":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"auth"},"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{}},"servers":[{"description":"The production 0CodeKit API server.","url":"https://prod.0codekit.com"}],"paths":{"/ai/detectadultcontent":{"post":{"tags":["AI"],"summary":"Detect adult content.","description":"Check if the content is appropriate for all audiences.","operationId":"ai_detectadultcontent_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"imageUrl":{"description":"The URL of the image to be checked.","example":"https://example.com/image.jpg","type":"string"}},"additionalProperties":true,"required":["imageUrl"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"isAdultContent":{"description":"Boolean value indicating if the content is adult content.","example":true,"type":"boolean"},"isRacyContent":{"description":"Boolean value indicating if the content is racy content.","example":true,"type":"boolean"},"isGoryContent":{"description":"Boolean value indicating if the content is gory content.","example":true,"type":"boolean"},"adultScore":{"description":"Score from 0 to 1 indicating how much the content is considered adult content.","example":0.9203029870986938,"type":"number"},"racyScore":{"description":"Score from 0 to 1 indicating how much the content is considered racy content.","example":0.9937777519226074,"type":"number"},"goreScore":{"description":"Score from 0 to 1 indicating how much the content is considered gory content.","example":0.0024742891546338797,"type":"number"}},"additionalProperties":false,"required":["isAdultContent","isRacyContent","isGoryContent","adultScore","racyScore","goreScore"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/picturetextrecognition":{"post":{"tags":["AI"],"summary":"Detect text in an image.","description":"Detects text in an image using the Azure Computer Vision API.","operationId":"ai_picturetextrecognition_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"imageUrl":{"description":"The URL of the image to analyze.","example":"https://example.com/image.jpg","type":"string"}},"additionalProperties":true,"required":["imageUrl"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"recognizedTexts":{"description":"List of recognized text strings in the image.","type":"array","items":{"type":"string"}}},"additionalProperties":false,"required":["recognizedTexts"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/entitydetection":{"post":{"tags":["AI"],"summary":"Text Entity Detection.","description":"Identities Entities From Input Text.","operationId":"ai_entitydetection_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"description":"Text for entity detection.","type":"string"}},"additionalProperties":true,"required":["text"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"detections":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"category":{"type":"string"},"subCategory":{"type":"string"},"offset":{"type":"number"},"length":{"type":"number"},"confidenceScore":{"type":"number"}},"additionalProperties":false,"required":["text","category","offset","length","confidenceScore"]}}},"additionalProperties":false,"required":["detections"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/removebg":{"post":{"tags":["AI"],"summary":"Remove image background.","description":"Remove background from image url or buffer.","operationId":"ai_removebg_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The URL of the image that will be processed.","type":"string"},"buffer":{"description":"A Base64-encoded image. Can be specified instead of `body.url`.","type":"string"},"getAsUrl":{"description":"If true, returns the result image as a URL. Otherwise, it will be returned directly.","type":"boolean"},"fileName":{"description":"If `body.getAsUrl` is true, specifies the file name that will be used when downloading the result.","type":"string"}},"additionalProperties":true,"required":["getAsUrl"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/detectbrand":{"post":{"tags":["AI"],"summary":"Detect brand","description":"Detect brand from given image.","operationId":"ai_detectbrand_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"imageUrl":{"description":"Image for brand detection.","type":"string"}},"additionalProperties":true,"required":["imageUrl"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"brands":{"type":"array","items":{"type":"string"}}},"additionalProperties":false,"required":["brands"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/generatepythoncode":{"post":{"tags":["AI"],"summary":"Generate python code.","description":"Generate python code based on provided prompt.","operationId":"ai_generatepythoncode_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}},{"name":"x-0ck-frontend-token","in":"header","description":"Internal header of the 0CodeKit app. Not needed for API requests.","required":false,"schema":{"description":"Internal header of the 0CodeKit app. Not needed for API requests.","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"prompt":{"description":"Prompt to generate python code.","type":"string"}},"additionalProperties":true,"required":["prompt"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"}},"additionalProperties":true,"required":["id","code"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/detectcolor":{"post":{"tags":["AI"],"summary":"Detect color.","description":"Detect color from given image.","operationId":"ai_detectcolor_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"imageUrl":{"description":"Image for color detection.","type":"string"}},"additionalProperties":true,"required":["imageUrl"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"dominantColorForeground":{"type":"string"},"dominantColorBackground":{"type":"string"},"dominantColors":{"type":"array","items":{"type":"string"}},"isBwImg":{"type":"boolean"},"accentColor":{"type":"string"}},"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/toolongtoread":{"post":{"tags":["AI"],"summary":"Too Long To Read","description":"Creates a summary of the given text.","operationId":"ai_toolongtoread_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"prompt":{"description":"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.","type":"string"}},"additionalProperties":true,"required":["prompt"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"description":"The ID of the generated content.","example":"cmpl-2iZ3t9nGQ4aJ7Qb4Q7Xq8Zn5","type":"string"},"data":{"description":"The summarized text.","example":"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.","type":"string"}},"additionalProperties":true,"required":["id","data"]}},"additionalProperties":true,"required":["result"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/languagedetection":{"post":{"tags":["AI"],"summary":"Detect language.","description":"Detect language of given text.","operationId":"ai_languagedetection_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"description":"Text for language detection.","type":"string"}},"additionalProperties":true,"required":["text"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"iso6391Name":{"type":"string"},"confidenceScore":{"type":"number"}},"additionalProperties":true,"required":["name","iso6391Name","confidenceScore"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/transcribe":{"post":{"tags":["AI"],"summary":"Transcribe audio.","description":"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.","operationId":"ai_transcribe_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The URL to the audio file.","example":"https://www.pacdv.com/sounds/voices/am-i-totally-screwed-or.wav","type":"string"},"buffer":{"description":"The Base64-encoded audio file. Can be provided instead of `url`.","type":"string"},"lang":{"description":"The audio language. Default is `en`.","example":"en","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"text":{"description":"The transcription result.","example":"Ladies and gentlemen, am I totally screwed, or what?","type":"string"}},"additionalProperties":true,"required":["text"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/pictureobjectrecognition":{"post":{"tags":["AI"],"summary":"Detect labels in an image.","description":"Detects labels in an image using the OpenAI Vision model.","operationId":"ai_pictureobjectrecognition_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"imageUrl":{"description":"The URL of the image to analyze.","example":"https://example.com/image.jpg","type":"string"}},"additionalProperties":true,"required":["imageUrl"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"recognizedLabels":{"description":"List of recognized labels in the image.","type":"array","items":{"type":"string"}}},"additionalProperties":false,"required":["recognizedLabels"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/generateimage":{"post":{"tags":["AI"],"summary":"Generate an image.","description":"Generate an image based on prompt.","operationId":"ai_generateimage_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"prompt":{"description":"Prompt to generate image.","type":"string","maxLength":4000},"n":{"description":"Number of output image's to be generated.","type":"number","maximum":10},"size":{"description":"Size of the output image.","type":"string","enum":["auto","1024x1024","1536x1024","1024x1536"]}},"additionalProperties":true,"required":["prompt","n","size"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"image":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"}},"additionalProperties":true}}},"additionalProperties":true,"required":["id"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/extractcontactinformation":{"post":{"tags":["AI"],"summary":"Extract contact information.","description":"Extract contact information from given prompt.","operationId":"ai_extractcontactinformation_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"prompt":{"description":"Prompt for contact info extraction.","type":"string"}},"additionalProperties":true,"required":["prompt"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"data":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":true,"required":["name","phone","email","address","website"]}},"additionalProperties":true,"required":["id","data"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/generatejavascriptcode":{"post":{"tags":["AI"],"summary":"Generate JavaScript code.","description":"Generate JavaScript code based on provided prompt.","operationId":"ai_generatejavascriptcode_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}},{"name":"x-0ck-frontend-token","in":"header","description":"Internal header of the 0CodeKit app. Not needed for API requests.","required":false,"schema":{"description":"Internal header of the 0CodeKit app. Not needed for API requests.","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"prompt":{"description":"Prompt to generate JavaScript code.","type":"string"}},"additionalProperties":true,"required":["prompt"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"}},"additionalProperties":true,"required":["id","code"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/mooddetection":{"post":{"tags":["AI"],"summary":"Detect mood.","description":"Detect mood from given text.","operationId":"ai_mooddetection_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string"}},"additionalProperties":true,"required":["text"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"moodOverall":{"type":"string"},"moodScore":{"type":"object","properties":{"positive":{"type":"number"},"neutral":{"type":"number"},"negative":{"type":"number"}},"additionalProperties":false,"required":["positive","neutral","negative"]},"moodPerSentence":{"type":"array","items":{"type":"object","properties":{"mood":{"type":"string"},"text":{"type":"string"}},"additionalProperties":false,"required":["mood","text"]}}},"additionalProperties":false,"required":["moodOverall","moodScore","moodPerSentence"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/detectface":{"post":{"tags":["AI"],"summary":"Detect face.","description":"Detect face from given image.","operationId":"ai_detectface_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"imageUrl":{"description":"Image for face detection.","type":"string"}},"additionalProperties":true,"required":["imageUrl"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"totalFaces":{"type":"number"},"facesPosition":{"type":"array","items":{"type":"object","properties":{"left":{"type":"number"},"top":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}},"additionalProperties":false}}},"additionalProperties":false,"required":["totalFaces","facesPosition"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/pdfocr":{"post":{"tags":["AI"],"summary":"PDF Optical Character Recognition.","operationId":"ai_pdfocr_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pdfUrl":{"description":"PDF URL.","type":"string"}},"additionalProperties":true,"required":["pdfUrl"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"recognizedText":{"description":"The text that was recognized in the PDF.","type":"string"}},"additionalProperties":true,"required":["recognizedText"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/detectemailtype":{"post":{"tags":["AI"],"summary":"Detect email type.","description":"Detect email type from provided subject and body.ß","operationId":"ai_detectemailtype_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"subject":{"description":"Subject of email.","type":"string"},"body":{"description":"Body of email.","type":"string"}},"additionalProperties":true,"required":["subject","body"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"additionalProperties":true,"required":["id","type"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/checkcontentpolicy":{"post":{"tags":["AI"],"summary":"Check content policy.","description":"Check if the content is appropriate to be posted on the internet.","operationId":"ai_checkcontentpolicy_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"prompt":{"description":"The text containing the content to be checked.","example":"Hello world!","type":"string"}},"additionalProperties":true,"required":["prompt"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the content.","example":"cmpl-2iZ3t9nGQ4aJ7Qb4Q7Xq8Zn5","type":"string"},"safe":{"description":"Boolean value indicating if the content is safe.","example":true,"type":"boolean"},"data":{"description":"The message containing the result of the content check.","example":"Content is safe.","type":"string"}},"additionalProperties":true,"required":["id","safe","data"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/translate":{"post":{"tags":["AI"],"summary":"Translate text to a specified language.","description":"Translates the provided text into the specified target language using OpenAI.","operationId":"ai_translate_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"description":"The text to be translated.","example":"Hello, world!","type":"string"},"resultLang":{"description":"The target language code to translate the text into.","example":"es","type":"string"}},"additionalProperties":true,"required":["text","resultLang"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"translation":{"description":"The translated text.","type":"string"}},"additionalProperties":false,"required":["translation"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/crypto/hash":{"post":{"tags":["Crypto"],"summary":"Hash a message.","operationId":"crypto_hash_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hashType":{"type":"string","enum":["MD5","SHA1","SHA224","SHA256","SHA3","SHA384","SHA512","RIPEMD160","HmacMD5","HmacSHA1","HmacSHA224","HmacSHA256","HmacSHA3","HmacSHA384","HmacSHA512","HmacRIPEMD160"]},"message":{"type":"string"},"secretKey":{"type":"string"}},"additionalProperties":true,"required":["hashType","message"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"hashedText":{"type":"string"}},"additionalProperties":true,"required":["hashedText"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/crypto/decrypt":{"post":{"tags":["Crypto"],"summary":"Decrypt ciphertext.","operationId":"crypto_decrypt_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cryptoType":{"type":"string","enum":["AES","DES","TripleDES","Rabbit","RC4","RC4Drop"]},"ciphertext":{"description":"The ciphertext.","type":"string"},"secretKey":{"description":"The encryption key.","type":"string"}},"additionalProperties":true,"required":["cryptoType","ciphertext","secretKey"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"decryptedText":{"description":"The plaintext.","type":"string"}},"additionalProperties":true,"required":["decryptedText"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/crypto/encrypt":{"post":{"tags":["Crypto"],"summary":"Encrypt plaintext.","operationId":"crypto_encrypt_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cryptoType":{"type":"string","enum":["AES","DES","TripleDES","Rabbit","RC4","RC4Drop"]},"message":{"description":"The plaintext.","type":"string"},"secretKey":{"description":"The encryption key.","type":"string"}},"additionalProperties":true,"required":["cryptoType","message","secretKey"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"encryptedText":{"description":"The ciphertext.","type":"string"}},"additionalProperties":true,"required":["encryptedText"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/calculate/geodistance-v2":{"post":{"tags":["Calculate"],"summary":"Calculate geographical distance.","description":"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.","operationId":"calculate_geodistance-v2_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"startPoint":{"description":"The start point.","example":"Flensburg","type":"string"},"endPoint":{"description":"The end point.","example":"Istanbul","type":"string"},"mode":{"description":"The mode of travel.","example":"walking","type":"string","enum":["driving","walking","bicycling","transit"]}},"additionalProperties":true,"required":["startPoint","endPoint","mode"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"distanceInKM":{"description":"The distance between start and end point in kilometers when traveling.","type":"number"},"duration":{"description":"The estimated amount of time it takes to travel from start to end point.","type":"object","properties":{"hours":{"description":"The number of hours","type":"number"},"minutes":{"description":"The number of minutes","type":"number"}},"additionalProperties":true,"required":["hours","minutes"]}},"additionalProperties":true,"required":["distanceInKM","duration"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/calculate/bmi":{"post":{"tags":["Calculate"],"summary":"Calculate the BMI.","description":"Uses the height and weight of a person to calculate their BMI as well as several other related values, including their recommended nutrients.","operationId":"calculate_bmi_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"weight":{"description":"The weight in kilograms.","example":80,"type":"number"},"height":{"description":"The height in centimeters.","example":180,"type":"number"}},"additionalProperties":true,"required":["weight","height"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"bmi":{"description":"The calculated BMI value.","example":24.69,"type":"number"},"bmiClassification":{"description":"The BMI classification","example":"normal","type":"string"},"dbw":{"description":"Desirable body weight (DBW) in kilograms.","example":72,"type":"number"},"kcal":{"description":"The amount of energy in kilocalories required per day.","example":2160,"type":"number"},"nutrients":{"type":"object","properties":{"carbohydrates":{"description":"The amount of carbohydrates in grams required per day.","example":324,"type":"number"},"protein":{"description":"The amount of proteins in grams required per day.","example":81,"type":"number"},"fat":{"description":"The amount of fat in grams required per day.","example":60,"type":"number"}},"additionalProperties":true,"required":["carbohydrates","protein","fat"]}},"additionalProperties":true,"required":["bmi","bmiClassification","dbw","kcal","nutrients"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/user/retrievecredits":{"post":{"tags":["User"],"summary":"Retrieve credits.","operationId":"user_retrievecredits_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"credits":{"description":"The number of credits you have left.","type":"number"}},"additionalProperties":true,"required":["credits"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/trafficlight":{"post":{"tags":["Operator"],"summary":"Check rate limit.","description":"A simple way to implement rate limiting by checking whether a new request is allowed now.","operationId":"operator_trafficlight_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"An arbitrary name for this traffic light.","type":"string"},"interval":{"description":"The minimum time that must pass after one request was allowed.","type":"number"}},"additionalProperties":true,"required":["name","interval"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"}},"additionalProperties":true,"required":["ok"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/duplicate":{"post":{"tags":["Operator"],"summary":"Remove duplicates from the list.","operationId":"operator_duplicate_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"list":{"description":"The List that contains duplicate values.","type":"array","items":{}}},"additionalProperties":true,"required":["list"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"list":{"description":"The List that removed all duplicate values.","type":"array","items":{}}},"additionalProperties":true,"required":["list"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/gender":{"post":{"tags":["Operator"],"summary":"Find gender of name.","operationId":"operator_gender_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"firstname":{"description":"The first name.","type":"string"},"fullname":{"description":"The full name. The first name is only used if `firstname` is not provided.","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"firstname":{"description":"The first name, either from `firstname` or `fullname`.","type":"string"},"lastname":{"description":"The last name, extracted from `fullname`.","type":"string"},"detectedGender":{"description":"The detected gender, either `male`, `female`, or `unisex`.","type":"string","enum":["male","female","unisex"]}},"additionalProperties":true,"required":["firstname","detectedGender"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/parseurlquery":{"post":{"tags":["Operator"],"summary":"Parse URL query parameters.","operationId":"operator_parseurlquery_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The URL.","type":"string"}},"additionalProperties":true,"required":["url"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"description":"The mapping from parameters to values.","type":"object","additionalProperties":{"type":"string"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/logo":{"post":{"tags":["Operator"],"summary":"Get website logo URL.","operationId":"operator_logo_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}},"additionalProperties":true,"required":["url"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string"},"size":{"type":"string"}},"additionalProperties":true,"required":["type","url","size"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/thumbnail":{"post":{"tags":["Operator"],"summary":"Get thumbnail for video.","operationId":"operator_thumbnail_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","pattern":"^(https?:\\/\\/)?([\\w-]+\\.)+[\\w-]+(\\/[\\w-./?%&=]*)?$"},"getAsUrl":{"type":"boolean"},"fileName":{"type":"string"}},"additionalProperties":true,"required":["url"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"fileName":{"type":"string"}},"additionalProperties":true,"required":["url","fileName"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/advancedswitch":{"post":{"tags":["Operator"],"summary":"Get JSON values from keys.","operationId":"operator_advancedswitch_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"external":{"type":"boolean"},"json":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}]},"key":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"additionalProperties":true,"required":["external","json","key"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"found":{"anyOf":[{"type":"array","items":{}},{}]}},"additionalProperties":true,"required":["found"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/splitname":{"post":{"tags":["Operator"],"summary":"Split name.","description":"Split a full name into its first and last name.","operationId":"operator_splitname_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The full name that will be split.","type":"string"},"reversed":{"description":"Whether first and last name should be reversed. Might be useful in languages where the last name comes first, e.g. Chinese.","type":"boolean"}},"additionalProperties":true,"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"description":"The first name. This might also be multiple first names.","type":"string"},"lastName":{"description":"The last name.","type":"string"}},"additionalProperties":true,"required":["firstName","lastName"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/urlexpander":{"post":{"tags":["Operator"],"summary":"Expand URL.","description":"Converts a shortened URL from any URL shortener to its expanded form.","operationId":"operator_urlexpander_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The URL.","type":"string"}},"additionalProperties":true,"required":["url"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"unshortenedUrl":{"description":"The expanded URL.","type":"string"}},"additionalProperties":true,"required":["unshortenedUrl"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/utm/build":{"post":{"tags":["Operator"],"summary":"Build UTM link.","operationId":"operator_utm_build_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The base URL.","type":"string"},"utm":{"type":"object","properties":{"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_content":{"type":"string"},"utm_term":{"type":"string"}},"additionalProperties":true}},"additionalProperties":true,"required":["url","utm"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The built UTM link.","type":"string"}},"additionalProperties":true,"required":["url"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/utm/parse":{"post":{"tags":["Operator"],"summary":"Parse UTM link.","operationId":"operator_utm_parse_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}},"additionalProperties":true,"required":["url"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_content":{"type":"string"},"utm_term":{"type":"string"}},"additionalProperties":true}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/htmlparser/get":{"post":{"tags":["Operator"],"summary":"Parse HTML.","operationId":"operator_htmlparser_get_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"html":{"type":"string"},"url":{"type":"string"},"all":{"type":"boolean"},"selector":{"type":"string"},"tagSelector":{"type":"string"},"idSelector":{"type":"string"},"classSelector":{"type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"additionalProperties":true,"required":["data"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/scheduler/add":{"post":{"tags":["Scheduler"],"summary":"Add scheduler task.","operationId":"operator_scheduler_add_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sendToWebhook":{"description":"The URL of the webhook that will be called with the specified data every time the task is run.","type":"string"},"data":{"description":"The JSON data that will be passed to the webhook.","type":"string"},"intervalType":{"description":"The type of scheduler that will be set up. The different options are:\n- `1`: One time execution. `intervalOptions` must be a unix timestamp or ISO 8601 date.\n- `2`: Multiple specific executions. `intervalOptions` must be an array of unix timestamps or ISO 8601 dates.\n- `3`: Cron job. `intervalOptions` must be a [cron string](https://crontab.cronhub.io/).\n- `4`: Regular execution every n hours / days / weeks / months. `intervalOptions` must be a string of the format `period;n`.","type":"string","enum":[1,2,3,4]},"intervalOptions":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"number"},{"type":"array","items":{"type":"number"}}]},"endDate":{"description":"The last date this task will be executed.","type":"string","format":"date-time"}},"additionalProperties":true,"required":["sendToWebhook","data","intervalType","intervalOptions"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"taskId":{"description":"The unique ID for this task, which can be used for managing the task later.","type":"string"},"nextExecution":{"description":"The date this task will be executed next.","type":"string","format":"date-time"},"endDate":{"description":"The end date that was provided.","type":"string","format":"date-time"}},"additionalProperties":true,"required":["taskId","nextExecution"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/scheduler/del":{"post":{"tags":["Scheduler"],"summary":"Delete scheduler task.","operationId":"operator_scheduler_del_post","security":[{"apiKeyAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"taskId":{"type":"string"}},"additionalProperties":true,"required":["taskId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"additionalProperties":true,"required":["message"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/scheduler/list":{"post":{"tags":["Scheduler"],"summary":"List scheduler tasks.","operationId":"operator_scheduler_list_post","security":[{"apiKeyAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"tasks":{"type":"array","items":{"type":"object","properties":{"taskId":{"type":"string"},"webhook":{"type":"string"},"nextExecution":{"type":"string","format":"date-time"},"data":{"type":"string"}},"additionalProperties":true,"required":["taskId","webhook","nextExecution","data"]}}},"additionalProperties":true,"required":["tasks"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/convert/nationiso":{"post":{"tags":["Convert"],"summary":"Convert between ISO and nation name.","description":"Takes a nation name or a nation ISO code and outputs the corresponding nation name and ISO code.","operationId":"convert_nationiso_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"iso":{"description":"The ISO code of the nation.","type":"string"},"nation":{"description":"The English name of the nation.","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"iso":{"description":"The ISO code of the nation.","type":"string"},"nation":{"description":"The English name of the nation.","type":"string"}},"additionalProperties":true,"required":["iso","nation"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/convert/msgtojson":{"post":{"tags":["Convert"],"summary":"Convert Outlook item files.","operationId":"convert_msgtojson_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"buffer":{"type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/convert/currency":{"post":{"tags":["Convert"],"summary":"Convert between currencies.","operationId":"convert_currency_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sourceCurrency":{"type":"string"},"targetCurrency":{"type":"string"},"amount":{"type":"number"},"dateFormat":{"type":"string"}},"additionalProperties":true,"required":["sourceCurrency","targetCurrency","amount"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"oldAmount":{"type":"number"},"oldCurrency":{"type":"string"},"convertedAmount":{"type":"number"},"currency":{"type":"string"},"dataDate":{"type":"string"}},"additionalProperties":true,"required":["oldAmount","oldCurrency","convertedAmount","currency","dataDate"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/convert/iptogeo":{"post":{"tags":["Convert"],"summary":"Convert IP to location.","operationId":"convert_iptogeo_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ip":{"description":"The IP address.","example":"87.155.190.147","type":"string"}},"additionalProperties":true,"required":["ip"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"Whether the operation succeeded.","example":"success","type":"string","enum":["success"]},"country":{"description":"The name of the country.","example":"Germany","type":"string"},"countryCode":{"description":"The country code.","example":"De","type":"string"},"region":{"description":"The region code.","example":"RP","type":"string"},"regionName":{"description":"The name of the region.","example":"Rheinland-Pfalz","type":"string"},"city":{"description":"The city the IP address comes from.","example":"Waldfischbach-Burgalben","type":"string"},"zip":{"description":"The zip code the IP address comes from.","example":"67714","type":"string"},"lat":{"description":"The latitude of the location.","example":49.2794,"type":"number"},"lon":{"description":"The longitude of the location.","example":7.6671,"type":"number"},"timezone":{"description":"The timezone the IP address is in.","example":"Europe/Berlin","type":"string"},"isp":{"description":"The internet service provider.","example":"Deutsche Telekom AG","type":"string"},"org":{"description":"The organization.","example":"Deutsche Telekom AG","type":"string"},"as":{"description":"The AS code.","example":"AS3320 Deutsche Telekom AG","type":"string"},"query":{"description":"The IP address that was queried.","example":"87.155.190.147","type":"string"}},"additionalProperties":true,"required":["status","country","countryCode","region","regionName","city","zip","lat","lon","timezone","isp","org","as","query"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/convert/csv/json":{"post":{"tags":["Convert"],"summary":"Convert CSV to JSON.","operationId":"convert_csv_json_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"csv":{"description":"The CSV string that will be converted.","type":"string"},"noheader":{"description":"If this is false, the first line will be interpreted as column names instead of data. Default is false.","type":"boolean"},"delimiter":{"description":"The delimiter between the different columns. Can be `auto` for automatic detection of delimiters, or an array of delimiters. Default is `auto`.","anyOf":[{"type":"string","enum":["auto"]},{"type":"array","items":{"type":"string"}}]},"trim":{"description":"Whether spaces around column values should be trimmed. Default is true.","type":"boolean"},"ignoreEmpty":{"description":"Whether empty column values should be ignored, instead of being output as empty. Default is false.","type":"boolean"}},"additionalProperties":true,"required":["csv"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"json":{"description":"An array of JSON objects parsed from the CSV.","type":"array","items":{}}},"additionalProperties":true,"required":["json"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/convert/csv/array":{"post":{"tags":["Convert"],"summary":"Convert CSV to array.","operationId":"convert_csv_array_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"csv":{"description":"The CSV string that will be parsed.","type":"string"},"omitFirstRow":{"description":"Whether to omit the first row. Default is false.","type":"boolean"},"delimiter":{"description":"The delimiter by which the rows will be split.","type":"string"}},"additionalProperties":true,"required":["csv","delimiter"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"array":{"description":"The array of rows, where each row is an array of fields.","type":"array","items":{"type":"array","items":{"type":"string"}}}},"additionalProperties":true,"required":["array"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/business/lookupvatrates":{"post":{"tags":["Business"],"summary":"Look up VAT rate.","description":"Looks up the VAT rate for the specified country in the European Union.","operationId":"business_lookupvatrates_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"countryCode":{"description":"The ISO 3166-1 alpha-2 code of the country.","type":"string"}},"additionalProperties":true,"required":["countryCode"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"description":"The name of the country.","type":"string"},"vat_name":{"description":"The name of VAT in the country.","type":"string"},"vat_abbr":{"description":"The VAT abbreviation.","type":"string"},"standard_rate":{"description":"The standard VAT rate.","type":"number"},"reduced_rate":{"description":"The reduced VAT rate, or false.","anyOf":[{"type":"number"},{"type":"boolean"}]},"reduced_rate_alt":{"description":"The alternative reduced VAT rate, or false.","anyOf":[{"type":"number"},{"type":"boolean"}]},"super_reduced_rate":{"description":"The super reduced VAT rate, or false.","anyOf":[{"type":"number"},{"type":"boolean"}]},"parking_rate":{"description":"The parking rate, or false.","anyOf":[{"type":"number"},{"type":"boolean"}]}},"additionalProperties":true,"required":["country","vat_name","vat_abbr","standard_rate","reduced_rate","reduced_rate_alt","super_reduced_rate","parking_rate"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/business/isfreemail":{"post":{"tags":["Business"],"summary":"Check for freemail.","description":"Checks whether the email address is from a free email provider.","operationId":"business_isfreemail_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"description":"The email address that should be checked.","example":"pa1928sch@hotmail.com","type":"string"}},"additionalProperties":true,"required":["email"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"freeEmailProvider":{"description":"Whether the email provider is free.","example":true,"type":"boolean"},"provider":{"description":"The provider domain extracted from the email address.","example":"hotmail.com","type":"string"}},"additionalProperties":true,"required":["freeEmailProvider","provider"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/business/validate/geolocation":{"post":{"tags":["Business"],"summary":"Validate Geolocation.","description":"This endpoint takes an address or coordinates, and checks whether it is valid.","operationId":"business_validate_geolocation_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"address":{"description":"The location. Can be an address or coordinates.","example":"Bavaria Donau 11, Passau","type":"string"}},"additionalProperties":true,"required":["address"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"valid":{"description":"Whether the location is valid.","example":true,"type":"boolean"},"address":{"description":"The address if the location is valid.","example":"Bavaria Donau 11, Passau","type":"string"}},"additionalProperties":true,"required":["valid"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/business/validate/phonenumber":{"post":{"tags":["Business"],"summary":"Validate the phone number.","description":"Checks whether the phone number is valid.","operationId":"business_validate_phonenumber_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumber":{"description":"The phone number to validate.","example":"(+81) 090-1234-5678","type":"string"},"countryCode":{"description":"Short abbreviation of a country.","example":"JP","type":"string"}},"additionalProperties":true,"required":["phoneNumber"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumber":{"description":"The given phone number to validate.","example":"(+81) 090-1234-5678","type":"string"},"internationNumber":{"description":"The international number formated.","example":"\"+81 90 1234 5678","type":"string"},"number":{"description":"The international based on E164Number Code.","example":"+819012345678","type":"string"},"nationalNumber":{"description":"The national number of the country.","example":"9012345678","type":"string"},"countryCode":{"description":"The country code based on the phone number.","example":"JP","type":"string"},"possibleNumber":{"description":"Checks if the given number is an possible phone number.","example":true,"type":"boolean"},"isValid":{"description":"Checks whether the phone number is valid.","example":true,"type":"boolean"}},"additionalProperties":true,"required":["phoneNumber"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/business/validate/iban":{"post":{"tags":["Business"],"summary":"Validate IBAN","description":"Checks whether the provided IBAN (International Bank Account Number) is valid.","operationId":"business_validate_iban_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"iban":{"description":"The IBAN","example":"DE02120300000000202051","type":"string"}},"additionalProperties":true,"required":["iban"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"valid":{"description":"Whether the IBAN is valid.","example":true,"type":"boolean"}},"additionalProperties":true,"required":["valid"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/business/validate/vat":{"post":{"tags":["Business"],"summary":"Validate a VAT ID.","description":"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","operationId":"business_validate_vat_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"vatId":{"description":"The VAT ID. Must start with a two-digit country code.","example":"DE123456789","type":"string"},"countryCode":{"description":"The country code of the VAT ID.","example":"IT","type":"string","enum":["AT","BE","BG","HR","CY","CZ","DK","EE","FI","FR","DE","EL","HU","IE","IT","LV","LT","LU","MT","NL","PL","PT","RO","SK","SI","ES","SE","XI"]},"id":{"description":"The number part of the VAT ID.","example":"07643520567","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"countryCode":{"description":"The country code.","type":"string"},"vatNumber":{"description":"The VAT number.","type":"string"},"requestDate":{"description":"The exact date and time the request was made.","type":"string"},"valid":{"description":"Whether the ID is valid.","type":"boolean"},"name":{"description":"The name. Only provided if the ID is valid.","type":"string"},"address":{"description":"The address. Only provided if the address is valid.","type":"string"}},"additionalProperties":true,"required":["countryCode","vatNumber","requestDate","valid"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/business/validate/email":{"post":{"tags":["Business"],"summary":"Validate an Email.","description":"Checks whether the E-Mail Adress is valid.","operationId":"business_validate_email_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"description":"The E-Mail address.","type":"string"}},"additionalProperties":true,"required":["email"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"valid":{"description":"Whether the E-Mail address is valid.","type":"boolean"},"emailCorrected":{"description":"The corrected E-Mail address.","type":"string"}},"additionalProperties":true,"required":["valid","emailCorrected"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/business/validate/bic":{"post":{"tags":["Business"],"summary":"Validate a BIC.","description":"Checks whether a BIC (Bank Identifier Code) is valid.","operationId":"business_validate_bic_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bic":{"description":"The BIC.","type":"string"}},"additionalProperties":true,"required":["bic"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"valid":{"description":"Whether the BIC is valid.","type":"boolean"}},"additionalProperties":true,"required":["valid"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/business/verify/domain":{"post":{"tags":["Business"],"summary":"Verify domain.","description":"Verifies a domain by performing an HTTP GET request against it.","operationId":"business_verify_domain_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"description":"The domain name.","example":"https://www.google.com","type":"string"}},"additionalProperties":true,"required":["domain"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"mainDomain":{"description":"The main domain name, without subdomain.","type":"string"},"isValid":{"description":"Whether the domain is valid.","type":"boolean"}},"additionalProperties":true,"required":["mainDomain","isValid"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/storage/temp":{"post":{"tags":["Storage"],"summary":"Upload a temporary file.","description":"Uploads a file buffer to temporary storage and provides a URL. The file is deleted after 24 hours.","operationId":"storage_temp_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"description":"The file name. Default is a random string.","example":"my-file.txt","type":"string"},"buffer":{"description":"The Base64-encoded file buffer.","type":"string"}},"additionalProperties":true,"required":["buffer"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The URL to download the file.","type":"string"},"fileName":{"description":"The file name used to upload the file.","type":"string"}},"additionalProperties":true,"required":["url","fileName"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/storage/globalvariables/add":{"post":{"tags":["Storage"],"summary":"Add a global variable.","description":"The global variable is only visible for the user that created it. If `variableName` is not provided, it is generated automatically.","operationId":"storage_globalvariables_add_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"variableName":{"description":"The name of the variable to create. Default is auto-generated.","example":"myVariable","type":"string"},"variableValue":{"description":"The value to assign to the variable.","example":"myValue","type":"string"}},"additionalProperties":true,"required":["variableValue"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"variableName":{"description":"The variable name that was actually used.","example":"myVariable","type":"string"},"variableValue":{"description":"The value that was assigned to the variable.","example":"myValue","type":"string"}},"additionalProperties":true,"required":["variableName","variableValue"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/storage/globalvariables/del":{"post":{"tags":["Storage"],"summary":"Delete a global variable.","description":"A global variable can only be deleted by the user that created it.","operationId":"storage_globalvariables_del_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"variableId":{"description":"The variable name.","example":"myVariable","type":"string"}},"additionalProperties":true,"required":["variableId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"The status message.","example":"Successfully deleted global variable with id myVariable.","type":"string"}},"additionalProperties":true,"required":["message"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/storage/globalvariables/get":{"post":{"tags":["Storage"],"summary":"Get a global variable.","description":"The user can only access a global variable that they created themselves.","operationId":"storage_globalvariables_get_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"variableName":{"description":"The name of the variable to get.","example":"myVariable","type":"string"}},"additionalProperties":true,"required":["variableName"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"variableName":{"description":"The variable name.","example":"myVariable","type":"string"},"variableValue":{"description":"The variable value.","example":"myValue","type":"string"}},"additionalProperties":true,"required":["variableName","variableValue"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/storage/globalvariables/list":{"post":{"tags":["Storage"],"summary":"List all variables.","description":"Lists all variables that the user has created before and not yet deleted.","operationId":"storage_globalvariables_list_post","security":[{"apiKeyAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"variables":{"description":"The list of variables for this user.","type":"array","items":{"type":"object","properties":{"variableName":{"description":"The name of the variable.","example":"myVariable","type":"string"},"variableValue":{"description":"The value of the variable.","example":"myValue","type":"string"}},"additionalProperties":true,"required":["variableName","variableValue"]}}},"additionalProperties":true,"required":["variables"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/storage/globalvariables/update":{"post":{"tags":["Storage"],"summary":"Update a global variable.","description":"Changes the value of the given global variable to the new value.","operationId":"storage_globalvariables_update_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"variableName":{"description":"The name of the variable to update.","example":"myVariable","type":"string"},"variableValue":{"description":"The new value of the variable.","example":"myValue","type":"string"}},"additionalProperties":true,"required":["variableName","variableValue"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"variableName":{"description":"The variable name.","example":"myVariable","type":"string"},"variableValue":{"description":"The new value of the variable.","example":"myValue","type":"string"}},"additionalProperties":true,"required":["variableName","variableValue"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/storage/json/add":{"post":{"tags":["Storage"],"summary":"Add a JSON bin.","operationId":"storage_json_add_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"json":{"description":"The JSON data to store in the bin."}},"additionalProperties":true,"required":["json"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the status.","type":"string"},"binId":{"description":"The ID that was assigned to this JSON bin.","type":"string"}},"additionalProperties":true,"required":["message","binId"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/storage/json/del":{"post":{"tags":["Storage"],"summary":"Delete a JSON bin.","operationId":"storage_json_del_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"binId":{"description":"The ID of the JSON bin.","type":"string"}},"additionalProperties":true,"required":["binId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the status.","type":"string"}},"additionalProperties":true,"required":["message"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/storage/json/get":{"post":{"tags":["Storage"],"summary":"Get a JSON bin.","operationId":"storage_json_get_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"binId":{"description":"The ID of the JSON bin.","type":"string"}},"additionalProperties":true,"required":["binId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"binId":{"description":"The ID of the JSON bin.","type":"string"},"data":{"description":"The content of the JSON bin."}},"additionalProperties":true,"required":["binId","data"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/storage/json/list":{"post":{"tags":["Storage"],"summary":"List JSON bins.","description":"Returns a list of the bin IDs of all JSON bins this user has created.","operationId":"storage_json_list_post","security":[{"apiKeyAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the status.","type":"string"},"bins":{"description":"The available JSON bins for this user.","type":"array","items":{"type":"object","properties":{"binId":{"description":"The ID of this JSON bin.","type":"string"}},"additionalProperties":true,"required":["binId"]}}},"additionalProperties":true,"required":["message","bins"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/storage/json/put":{"post":{"tags":["Storage"],"summary":"Put data into JSON bin.","description":"Replaces the data in the JSON bin with the new data.","operationId":"storage_json_put_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"json":{"description":"The JSON data to put into the bin."},"binId":{"description":"The ID of the JSON bin that will be modified.","type":"string"}},"additionalProperties":true,"required":["json","binId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"binId":{"description":"The ID of the JSON bin that was modified.","type":"string"}},"additionalProperties":true,"required":["binId"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/storage/perm/add":{"post":{"tags":["Storage"],"summary":"Upload to permanent storage.","operationId":"storage_perm_add_post","security":[],"parameters":[{"name":"auth","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileUrl":{"description":"The URL of the file you want to upload.","type":"string"},"fileBuffer":{"description":"The Base64-encoded file data. Can be specified instead of `fileUrl`.","type":"string"},"uploadName":{"description":"The file name that should be used when downloading the file.","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fileId":{"description":"The unique identifier for this file.","type":"string"},"url":{"description":"The permanent URL you can use to access this file.","type":"string"}},"additionalProperties":true,"required":["fileId","url"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/storage/perm/del":{"post":{"tags":["Storage"],"summary":"Delete from permanent storage.","operationId":"storage_perm_del_post","security":[],"parameters":[{"name":"auth","in":"header","required":true,"schema":{"type":"string"}},{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileId":{"type":"string"}},"additionalProperties":true,"required":["fileId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"additionalProperties":true,"required":["message"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/storage/perm/get":{"post":{"tags":["Storage"],"summary":"DEPRECATED: Get permanent file.","description":"Returns a URL to download the permanent file with the specified ID or name. If multiple files have the same name, which one is returned is unspecified. WARNING: This endpoint is deprecated. Please download permanent files using the URL provided when you create it.","operationId":"storage_perm_get_post","security":[],"parameters":[{"name":"auth","in":"header","required":true,"schema":{"type":"string"}},{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"type":"string"},"fileId":{"type":"string"},"getAsUrl":{"type":"boolean"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/storage/perm/list":{"post":{"tags":["Storage"],"summary":"List permanent files.","operationId":"storage_perm_list_post","security":[],"parameters":[{"name":"auth","in":"header","required":true,"schema":{"type":"string"}},{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"availableStorage":{"description":"The available storage remaining in KiB.","type":"integer"},"files":{"type":"array","items":{"type":"object","properties":{"fileId":{"description":"The ID of this file.","type":"string"},"fileName":{"description":"The name of this file.","type":"string"},"url":{"description":"The URL to download this permanent file.","type":"string"},"size":{"description":"The file size in KiB.","type":"integer"}},"additionalProperties":true,"required":["fileId","fileName","url","size"]}}},"additionalProperties":true,"required":["availableStorage","files"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/files/{id}/{name?}":{"get":{"tags":["Storage"],"summary":"Get file uploaded to 0CodeKit.","operationId":"files_{id}_{name?}_get","security":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/dateandtime/calendarweek":{"post":{"tags":["Dateandtime"],"summary":"Retrieve calendar weeks","description":"This endpoint can be used to return varied calendar-week information according to the data passed in the request.","operationId":"dateandtime_calendarweek_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"date":{"description":"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","type":"string"},"weekNumber":{"description":"The weekNumber parameter provides the workingDate of that week, along with the starting and ending day of the week.","example":5,"type":"number"},"year":{"description":"The year parameter provides year of the given weekNumber.","example":2023,"type":"number"},"unixTimestamp":{"description":"The date in unixTimestamp format.","example":1642918727,"type":"number"},"dateFormat":{"description":"Format of provided date.","example":"DD.MM.YYYY","type":"string"},"outputFormat":{"description":"Format of the output date","example":"DD.MM.YYYY","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"workingDate":{"type":"string"},"weekNumber":{"type":"number"},"firstDayOfWeek":{"type":"string"},"lastDayOfWeek":{"type":"string"}},"additionalProperties":true,"required":["workingDate","weekNumber","firstDayOfWeek","lastDayOfWeek"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/dateandtime/isweekend":{"post":{"tags":["Dateandtime"],"summary":"Check weekend date.","description":"Determine if a given date is a weekend, retrieve the day number, and get the weekday.","operationId":"dateandtime_isweekend_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"date":{"description":"The date for which information is requested.","type":"string"},"dateFormat":{"description":"The format of the input date.","type":"string"},"timeZone":{"description":"The timezone","type":"string"}},"additionalProperties":true,"required":["date"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"dayNumber":{"type":"number"},"weekDay":{"type":"string"},"isWeekend":{"type":"boolean"}},"additionalProperties":true,"required":["dayNumber","weekDay","isWeekend"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/dateandtime/switchtimezone":{"post":{"tags":["Dateandtime"],"summary":"Convert between timezones.","description":"Converts a date and time from one timezone to another.","operationId":"dateandtime_switchtimezone_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"inputTime":{"description":"The time that will be converted.","example":"08-12-2024 12:00","anyOf":[{"type":"string"},{"type":"number"}]},"inputTimeZone":{"description":"The timezone of the input time.","example":"Europe/Berlin","type":"string"},"formatPattern":{"description":"The format of the output time.","type":"string"},"destinationTimeZone":{"description":"The timezone of the output time.","type":"string"}},"additionalProperties":true,"required":["inputTime","inputTimeZone","destinationTimeZone"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"convertedTime":{"type":"string"},"timeZone":{"type":"string"}},"additionalProperties":true,"required":["convertedTime","timeZone"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/dateandtime/holidays":{"post":{"tags":["Dateandtime"],"summary":"Retrieve holidays.","description":"This API retrieve a list of holidays for a specific year, country code, and optionally state.","operationId":"dateandtime_holidays_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"year":{"description":"The year for which holidays are requested.","example":2022,"type":"number"},"countryCode":{"description":"The ISO 3166-1 alpha-2 country code.","example":"AT","type":"string"},"state":{"description":"The state within the country (if applicable).","type":"string"}},"additionalProperties":true,"required":["year","countryCode"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"holidays":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"name":{"type":"string"},"type":{"type":"string"},"rule":{"type":"string"}},"additionalProperties":true,"required":["date","start","end","name","type","rule"]}}},"additionalProperties":true,"required":["holidays"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/dateandtime/detailperiod":{"post":{"tags":["Dateandtime"],"summary":"Retrieve date range details.","description":"This API calculates month, year, start date, end date, and weekdays within a specified duration from a given start date.","operationId":"dateandtime_detailperiod_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"startDate":{"description":"Starting date.","example":"2023-06-07","type":"string"},"duration":{"description":"Duration of days for which the detail period is retrieved.","example":41,"type":"number"}},"additionalProperties":true,"required":["startDate","duration"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"monthArray":{"type":"array","items":{"type":"object","properties":{"month":{"type":"number"},"year":{"type":"number"},"startDate":{"type":"string"},"endDate":{"type":"string"},"weekDaysWithinPeriod":{"type":"number"}},"additionalProperties":true,"required":["month","year","startDate","endDate","weekDaysWithinPeriod"]}}},"additionalProperties":true,"required":["monthArray"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/dateandtime/month":{"post":{"tags":["Dateandtime"],"summary":"Monthly date details","description":"This retrieves all workdays, saturdays, sundays, and days in the month based on the month, year, and date provided.","operationId":"dateandtime_month_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"date":{"description":"Date parameter","type":"string"},"dateFormat":{"description":"Format of the input date","type":"string"},"month":{"description":"Number of the month.","type":"number","minimum":1,"maximum":12},"year":{"description":"Year","type":"number"},"outputFormat":{"description":"Format of the output date","type":"string"},"options":{"type":"object","properties":{"timeStamp":{"type":"boolean"}},"additionalProperties":true}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"daysInMonth":{"type":"number"},"lastDayOfMonth":{"anyOf":[{"type":"string"},{"type":"number"}]},"firstDayOfMonth":{"anyOf":[{"type":"string"},{"type":"number"}]},"workdays":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"saturdays":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"sundays":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"lastWorkdayOfMonth":{"anyOf":[{"type":"string"},{"type":"number"}]},"workdaysReversed":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"additionalProperties":true,"required":["daysInMonth","lastDayOfMonth","firstDayOfMonth","workdays","saturdays","sundays","lastWorkdayOfMonth","workdaysReversed"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/1saas/auth":{"post":{"tags":["1saas"],"summary":"Check auth status.","operationId":"1saas_auth_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"An explaining message.","example":"You are authorized.","type":"string"}},"additionalProperties":true,"required":["message"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/shortenedurl/add":{"post":{"tags":["Shorten URL"],"summary":"Create shortened URL.","operationId":"generate_shortenedurl_add_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination":{"description":"The destination URL which the shortened URL will point to.","example":"https://0codekit.com","type":"string"},"custom":{"description":"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","type":"string"}},"additionalProperties":true,"required":["destination"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"shortenedUrl":{"description":"The complete shortened URL.","example":"https://lyl.ai/custom","type":"string"},"identifier":{"description":"The shortened URL identifier. If one was provided, it is simply returned.","example":"to4w5vyb","type":"string"}},"additionalProperties":true,"required":["shortenedUrl","identifier"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/shortenedurl/del":{"post":{"tags":["Shorten URL"],"summary":"Delete shortened URL.","operationId":"generate_shortenedurl_del_post","security":[{"apiKeyAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identifier":{"description":"The shortened URL identifier that was returned by `/add`.","example":"to4w5vyb","type":"string"}},"additionalProperties":true,"required":["identifier"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"The success message.","example":"Successfully deleted shortened URL with id to4w5vyb.","type":"string"}},"additionalProperties":true,"required":["message"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/shortenedurl/get":{"post":{"tags":["Shorten URL"],"summary":"Get shortened URL.","operationId":"generate_shortenedurl_get_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identifier":{"description":"The shortened URL identifier that was returned by `/add`.","example":"to4w5vyb","type":"string"}},"additionalProperties":true,"required":["identifier"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"destination":{"description":"The destination URL.","example":"https://0codekit.com","type":"string"}},"additionalProperties":true,"required":["destination"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/shortenedurl/list":{"post":{"tags":["Shorten URL"],"summary":"List shortened URLs.","operationId":"generate_shortenedurl_list_post","security":[{"apiKeyAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"shortenedUrls":{"description":"A list of all shortened URLs the user has created.","type":"array","items":{"type":"object","properties":{"identifier":{"description":"The shortened URL identifier. This can be used for managing the shortened URL.","example":"to4w5vyb","type":"string"},"createdAt":{"description":"The creation date.","type":"string","format":"date-time"},"destination":{"description":"The destination URL which the shortened URL points to.","example":"https://0codekit.com","type":"string"}},"additionalProperties":true,"required":["identifier","createdAt","destination"]}}},"additionalProperties":true,"required":["shortenedUrls"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/shortenedurl/put":{"post":{"tags":["Shorten URL"],"summary":"Update shortened URL.","operationId":"generate_shortenedurl_put_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identifier":{"description":"The shortened URL identifier that was returned by `/add`.","example":"to4w5vyb","type":"string"},"destination":{"description":"The new destination URL which the shortened URL will point to.","example":"https://example.com","type":"string"}},"additionalProperties":true,"required":["identifier","destination"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"newDestination":{"description":"The new destination URL which was provided in the request body.","example":"https://example.com","type":"string"},"identifier":{"description":"The shortened URL identifier. Nothing is changed about this.","example":"to4w5vyb","type":"string"}},"additionalProperties":true,"required":["newDestination","identifier"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/shortenedurl/resolve/{id}":{"get":{"tags":["Shorten URL"],"summary":"Resolve shortened URL.","description":"This will redirect to the destination URL of the shortened URL. If the shortened URL is invalid, the redirect will point to a default URL.","operationId":"generate_shortenedurl_resolve_{id}_get","security":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/city":{"post":{"tags":["Generate"],"summary":"Generate a city.","operationId":"generate_city_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"city":{"description":"The random city name.","example":"Fort Marjorie","type":"string"},"country":{"description":"The random country name.","example":"Timor-Leste","type":"string"}},"additionalProperties":true,"required":["city","country"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/number":{"post":{"tags":["Generate"],"summary":"Generate a number.","operationId":"generate_number_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"range":{"description":"The range of the generated number. The first number is the minimum, the second is the maximum.","type":"array","items":{"type":"number"},"minItems":2,"maxItems":2},"type":{"description":"The type of generated number. Default is `integer`.","type":"string","enum":["decimal","float","integer"]},"round":{"description":"The number of decimal places the generated number has. This is only used if `type` is `decimal` or `float`.","type":"number"}},"additionalProperties":true,"required":["range"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"randomNumber":{"type":"number"}},"additionalProperties":true,"required":["randomNumber"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/string":{"post":{"tags":["Generate"],"summary":"Generate random string.","description":"Generate random string based on type and length.","operationId":"generate_string_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"description":"Type of randomness. Specifies the character set to use when generating the random string.","type":"string","enum":[1,2,3,4,5,6,7,8]},"length":{"description":"Type of randomness. Specifies the character set to use when generating the random string. The available types are: \n- **1**: Numbers only (0-9). \n- **2**: Alphabetical characters (both upper and lower case, A-Z, a-z). \n- **3**: Lowercase alphabetical characters only (a-z). \n- **4**: Uppercase alphabetical characters only (A-Z). \n- **5**: Alphanumeric characters with lowercase letters (a-z, 0-9). \n- **6**: Alphanumeric characters with uppercase letters (A-Z, 0-9). \n- **7**: Complex characters including special symbols (e.g., !, @, #, etc.). \n- **8**: Custom character set, which requires a custom array of characters to be provided.","type":"number"},"custom":{"description":"An array of custom characters to use for generating the random string. Required if type is set to 8.","type":"array","items":{"type":"string"}}},"additionalProperties":true,"required":["length"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"randomString":{"type":"string"}},"additionalProperties":true,"required":["randomString"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/name":{"post":{"tags":["Generate"],"summary":"Generate a name.","operationId":"generate_name_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"gender":{"type":"string","enum":["male","female"]}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"},"completeName":{"type":"string"},"completeNameWithMiddleName":{"type":"string"}},"additionalProperties":true,"required":["firstName","middleName","lastName","completeName","completeNameWithMiddleName"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/color":{"post":{"tags":["Generate"],"summary":"Generate a color.","operationId":"generate_color_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hue":{"description":"The hue of the generated color. Default is random.","anyOf":[{"type":"string","enum":["red","orange","yellow","green","purple","pink","monochrome"]},{"type":"string","pattern":"#[0-9a-fA-F]{6}"}]},"luminosity":{"description":"The luminosity of the generated color. Default is random.","type":"string","enum":["bright","light","dark"]},"seed":{"description":"A number or string that is used as a seed for the random number generator. By default, no seed is used.","anyOf":[{"type":"number"},{"type":"string"}]},"format":{"description":"The format of the returned color. These are the possible formats:\n- `rgb`: `rgb(0, 0, 0)`\n- `rgba`: `rgba(0, 0, 0, 0)`\n- `hsl`: `hsl(0, 0%, 0%)`\n- `hsla`: `hsla(0, 0%, 0%, 0)`\n- `hex`: `#000000`\n\nDefault is `hex`.","type":"string","enum":["rgb","rgba","hsl","hsla","hex"]},"alpha":{"description":"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.","type":"number","minimum":0,"maximum":1}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"color":{"type":"string"}},"additionalProperties":true,"required":["color"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/html-scrape":{"post":{"tags":["Generate"],"summary":"Scrape website.","operationId":"generate_html-scrape_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"textOnly":{"type":"boolean"}},"additionalProperties":true,"required":["url"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"string"}},"additionalProperties":true,"required":["data"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/mockdata/user":{"post":{"tags":["Generate"],"summary":"Generate user mockdata.","operationId":"generate_mockdata_user_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"description":"The amount of users to generate. Default is 1.","type":"number","maximum":100},"emailRequired":{"type":"boolean"},"avatarRequired":{"type":"boolean"},"passwordRequired":{"type":"boolean"},"birthDateRequired":{"type":"boolean"},"usernameRequired":{"type":"boolean"},"addressRequired":{"type":"boolean"},"cityRequired":{"type":"boolean"},"countryRequired":{"type":"boolean"},"phoneRequired":{"type":"boolean"},"createdAtRequired":{"type":"boolean"},"balanceRequired":{"type":"boolean"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"},"password":{"type":"string"},"birthDate":{"type":"string"},"username":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"phone":{"type":"string"},"createdAt":{"type":"string"},"balance":{"type":"number"}},"additionalProperties":true,"required":["id","name","lastName"]}}},"additionalProperties":true,"required":["users"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/jsonwebtoken/encode":{"post":{"tags":["Generate"],"summary":"Encode JWT.","operationId":"generate_jsonwebtoken_encode_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data":{},"secret":{"description":"The HMAC secret or PEM-encoded private key.","type":"string"},"options":{"type":"object","properties":{"header":{"description":"Advanced header values. Only use if you know what you are doing.","type":"object","properties":{"x5t#S256":{"type":"string"}},"additionalProperties":true},"algorithm":{"description":"The signature algorithm to use. Default is `HS256`.","type":"string","enum":["HS256","HS384","HS512","RS256","RS384","RS512","ES256","ES384","ES512","none"]}},"additionalProperties":true}},"additionalProperties":true,"required":["data","secret"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"description":"The encoded JWT.","type":"string"}},"additionalProperties":true,"required":["token"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/jsonwebtoken/decode":{"post":{"tags":["Generate"],"summary":"Decode JWT.","operationId":"generate_jsonwebtoken_decode_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"},"verify":{"description":"Whether to verify the JWT. This requires `secret`. Default is `false`.","type":"boolean"},"secret":{"description":"The HMAC secret or PEM-encoded public key.","type":"string"},"options":{"type":"object","properties":{"algorithms":{"description":"The signature algorithms that should be accepted. By default, all algorithms are accepted.","type":"array","items":{"type":"string","enum":["HS256","HS384","HS512","RS256","RS384","RS512","ES256","ES384","ES512","none"]}}},"additionalProperties":true}},"additionalProperties":true,"required":["token"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"description":"The JWT payload."}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/qrcode/encode":{"post":{"tags":["Generate"],"summary":"Generate a QR code.","description":"Returns a QR code as a PNG image, styled using the provided settings.","operationId":"generate_qrcode_encode_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"The data that should be encoded","example":"https://wemakefuture.com","type":"string"},"width":{"description":"The width of the QR code in pixels. Default is 500.","example":500,"type":"number"},"height":{"description":"The height of the QR code in pixels. Default is 500.","example":500,"type":"number"},"image":{"description":"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","type":"string"},"margin":{"description":"The size of the space between the QR code and the border of the image in pixels. Default is 15.","example":15,"type":"number"},"qrOptions":{"description":"Options for the QR code data.","type":"object","properties":{"typeNumber":{"description":"The type of the QR code. This must be an integer between 1 and 40. The number of dots on each side of th\t\tconst typeNumber = req.body.qrOptions?.typeNumber;e QR code is 4 * type number + 17. If the type is too low to encode all data, the request will fail. By default, the QR code is sized as small as possible.","example":5,"type":"integer","minimum":1,"maximum":40},"mode":{"description":"The mode of the QR code. This decides which characters are allowed in the QR code:\n\n- `Numeric`: Only numbers from 0 to 9.\n- `Alphanumeric`: Numbers from 0 to 9, latin letters from A to Z (only upper-case), spaces, and the following special characters: $, %, *, +, -, ., /, :.\n- `Byte`: Any bytes.\n\nFor almost all cases, `Byte` is the correct choice, including for URLs. Default is `Byte`.","example":"Byte","type":"string","enum":["Numeric","Alphanumeric","Byte"]},"errorCorrectionLevel":{"description":"The error correction level. The higher the level is, the more likely it becomes the QR code can still be read in bad conditions, e.g. bad lighting, shaking, or when part of the code is hidden or destroyed. However, error correction also requires more data to be stored in the QR code, meaning the `typeNumber` will be higher. These are the approximate percentages of data that can be restored with the respective error correction levels:\n\n- `L`: 7%\n- `M`: 15%\n- `Q`: 25%\n- `H`: 30%\n\nDefault is `Q`.","example":"Q","type":"string","enum":["L","M","Q","H"]}},"additionalProperties":true},"imageOptions":{"description":"Options for the image in the center of the QR code.","type":"object","properties":{"hideBackgroundDots":{"description":"Whether the dots covered by the image should be hidden. Default is `true`.","example":true,"type":"boolean"},"margin":{"description":"The size of the empty space around the image in pixels. Increasing the margin will decrease the image size. Default is 0.","example":0,"type":"number"}},"additionalProperties":true},"dotsOptions":{"description":"Options for the dots that make up most of the QR code.","type":"object","properties":{"type":{"description":"The style of the dots. Default is `square`.","example":"square","type":"string","enum":["dots","rounded","classy","classy-rounded","square","extra-rounded"]},"color":{"description":"The color of the dots as a hexcode. Can only be used if `gradient` is not used. Default is `#000000`, i.e. black.","example":"#000000","type":"string","pattern":"#[A-Fa-f0-9]{6}"},"gradient":{"description":"Options for a color gradient of the dots. Can only be used if `color` is not used.","type":"object","properties":{"type":{"description":"The type of gradient. This can be one of two options:\n\n- `radial`: The gradient starts at the center of the image and moves outwards.\n- `linear`: The gradient starts at one side and moves to the other.\n\n","example":"linear","type":"string","enum":["radial","linear"]},"rotation":{"description":"The clockwise rotation of the gradient in degrees. Can only be used when `type` is linear. Default is no rotation.","type":"number"},"colorStops":{"description":"The color stops in the gradient.","type":"array","items":{"type":"object","properties":{"offset":{"description":"The offset where this color should be used. Must be between 0 and 1.","example":0,"type":"number"},"color":{"description":"The color of this color stop as a hexcode.","example":"#FF0000","type":"string","pattern":"#[A-Fa-f0-9]{6}"}},"additionalProperties":true,"required":["offset","color"]}}},"additionalProperties":true,"required":["type","colorStops"]}},"additionalProperties":true},"cornersSquareOptions":{"description":"Options for the corner squares. This does not influence the smaller dots inside the corner squares.","type":"object","properties":{"type":{"description":"The style of the corner squares. Default is `square`.","example":"square","type":"string","enum":["square","extra-rounded","dot"]},"color":{"description":"The color of the corner squares as a hexcode. Can only be used if `gradient` is not used. Default is `#000000`, i.e. black.","example":"#000000","type":"string","pattern":"#[A-Fa-f0-9]{6}"},"gradient":{"description":"Options for a color gradient of the corner squares. Can only be used if `color` is not used.","type":"object","properties":{"type":{"description":"The type of gradient. This can be one of two options:\n\n- `radial`: The gradient starts at the center of the image and moves outwards.\n- `linear`: The gradient starts at one side and moves to the other.\n\n","example":"linear","type":"string","enum":["radial","linear"]},"rotation":{"description":"The clockwise rotation of the gradient in degrees. Can only be used when `type` is linear. Default is no rotation.","type":"number"},"colorStops":{"description":"The color stops in the gradient.","type":"array","items":{"type":"object","properties":{"offset":{"description":"The offset where this color should be used. Must be between 0 and 1.","example":0,"type":"number"},"color":{"description":"The color of this color stop as a hexcode.","example":"#FF0000","type":"string","pattern":"#[A-Fa-f0-9]{6}"}},"additionalProperties":true,"required":["offset","color"]}}},"additionalProperties":true,"required":["type","colorStops"]}},"additionalProperties":true},"cornersDotOptions":{"description":"Options for the corner dots. This does not influence the square border around the corner dots.","type":"object","properties":{"type":{"description":"The style of the corner dots. Default is `square`.","example":"square","type":"string","enum":["square","dot"]},"color":{"description":"The color of the corner dots as a hexcode. Can only be used if `gradient` is not used. Default is `#000000`, i.e. black.","example":"#000000","type":"string","pattern":"#[A-Fa-f0-9]{6}"},"gradient":{"description":"Options for a color gradient of the corner squares. Can only be used if `color` is not used.","type":"object","properties":{"type":{"description":"The type of gradient. This can be one of two options:\n\n- `radial`: The gradient starts at the center of the image and moves outwards.\n- `linear`: The gradient starts at one side and moves to the other.\n\n","example":"linear","type":"string","enum":["radial","linear"]},"rotation":{"description":"The clockwise rotation of the gradient in degrees. Can only be used when `type` is linear. Default is no rotation.","type":"number"},"colorStops":{"description":"The color stops in the gradient.","type":"array","items":{"type":"object","properties":{"offset":{"description":"The offset where this color should be used. Must be between 0 and 1.","example":0,"type":"number"},"color":{"description":"The color of this color stop as a hexcode.","example":"#FF0000","type":"string","pattern":"#[A-Fa-f0-9]{6}"}},"additionalProperties":true,"required":["offset","color"]}}},"additionalProperties":true,"required":["type","colorStops"]}},"additionalProperties":true}},"additionalProperties":true,"required":["data"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"imageUrl":{"type":"string"},"fileName":{"type":"string"}},"additionalProperties":true,"required":["imageUrl","fileName"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/qrcode/decode":{"post":{"tags":["Generate"],"summary":"Decode a QR code.","description":"Decodes a QR code from a URL or buffer and returns the encoded data. The supported file formats are `jpg`, `png`, `bmp`, `tiff`, `gif`.","operationId":"generate_qrcode_decode_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The URL to the QR code.","type":"string"},"buffer":{"description":"The QR code as a Base64-encoded buffer. Can be used instead of `url`.","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"The data contained in the QR code.","type":"string"}},"additionalProperties":true,"required":["data"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/barcode/encode":{"post":{"tags":["Generate"],"summary":"Generate barcode.","operationId":"generate_barcode_encode_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"string"},"options":{"type":"object","properties":{"format":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"displayValue":{"type":"boolean"},"fontOptions":{"type":"string"},"font":{"type":"string"},"text":{"type":"string"},"textAlign":{"type":"string"},"textPosition":{"type":"string"},"textMargin":{"type":"number"},"fontSize":{"type":"number"},"background":{"type":"string"},"lineColor":{"type":"string"},"margin":{"type":"number"},"marginTop":{"type":"number"},"marginBottom":{"type":"number"},"marginLeft":{"type":"number"},"marginRight":{"type":"number"}},"additionalProperties":true},"format":{"description":"The generated file type. Default is `svg`.","type":"string","enum":["svg","png","jpeg"]},"getAsUrl":{"description":"Whether to get as URL or buffer. Default is buffer.","type":"boolean"},"fileName":{"type":"string"}},"additionalProperties":true,"required":["data"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The barcode URL.","type":"string"},"fileName":{"type":"string"}},"additionalProperties":true,"required":["url","fileName"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/barcode/decode":{"post":{"tags":["Generate"],"summary":"Decode barcode.","operationId":"generate_barcode_decode_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"buffer":{"type":"string"},"barcode":{"description":"The barcode format.","type":"string","enum":["code-128","code-2of5","code-39","code-93","ean-13","ean-8","coabar"]}},"additionalProperties":true,"required":["barcode"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"The code extracted from the barcode.","type":"string"}},"additionalProperties":true,"required":["code"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/text/regex":{"post":{"tags":["Text"],"summary":"Evaluate text against a regex.","description":"Evaluates a given text against a provided regular expression and returns the matches.","operationId":"text_regex_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"description":"The text to be evaluated.","example":"The quick brown fox jumps over the lazy dog.","type":"string"},"expression":{"description":"The regular expression to evaluate against the text.","example":"\\b\\w{4}\\b","type":"string"}},"additionalProperties":true,"required":["text","expression"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"matches":{"description":"The list of matches found in the text.","type":"array","items":{"type":"string"}},"isValidRegex":{"description":"Whether the provided regular expression was valid.","type":"boolean"}},"additionalProperties":true,"required":["matches","isValidRegex"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/text/contains":{"post":{"tags":["Text"],"summary":"Keyword search in text.","description":"Searches text for keywords and returns their positions.","operationId":"text_contains_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"description":"Text from which you want to find keywords.","type":"string"},"keyword":{"description":"Single keyword.","type":"string"},"keywordList":{"description":"Multiple keywords.","type":"array","items":{"type":"string"}},"options":{"type":"object","properties":{"caseSensitive":{"type":"boolean"},"onlyCompleteWords":{"type":"boolean"}},"additionalProperties":true}},"additionalProperties":true,"required":["text"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"findings":{"type":"array","items":{"type":"object","properties":{"keyword":{"type":"string"},"contains":{"type":"boolean"},"foundPositions":{"type":"array","items":{"type":"number"}}},"additionalProperties":true,"required":["keyword","contains"]}}},"additionalProperties":true,"required":["findings"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/text/comparestring":{"post":{"tags":["Text"],"summary":"Compare two strings.","description":"Calculate similarity score between two strings","operationId":"text_comparestring_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"string1":{"description":"First String.","type":"string"},"string2":{"description":"Second String.","type":"string"},"algorithm":{"description":"Similarity algorithm.","type":"string"}},"additionalProperties":true,"required":["string1","string2"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"similarity":{"type":"number"},"distance":{"type":"number"}},"additionalProperties":true,"required":["similarity","distance"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/text/extractor":{"post":{"tags":["Text"],"summary":"Extract text from body.","description":"Extracts text from body between given start and end markers","operationId":"text_extractor_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"start":{"description":"Start marker.","type":"string"},"end":{"description":"End marker.","type":"string"},"body":{"description":"Body from which to extract the text","type":"string"},"greedy":{"description":"When true, It include start and end marker in result.","type":"boolean"},"caseSensitive":{"description":"When true, It make the body case sensitive.","type":"boolean"},"returnEmptyIfNotFound":{"description":"When true, Return error if markers not found.","type":"boolean"}},"additionalProperties":true,"required":["start","end","body"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string"}},"additionalProperties":true,"required":["text"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/advancedocr":{"post":{"tags":["AI"],"summary":"Extract text from given image","description":"Extracts text and specific data from documents, supporting OCR and specialized workflows.","operationId":"ai_advancedocr_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The URL to the document.","example":"https://icseindia.org/document/sample.pdf","type":"string"},"buffer":{"description":"The Base64-encoded buffer. Can be provided instead of `url`.","type":"string"},"resultType":{"description":"Result type specifies the output type.","example":"ocr","type":"string","enum":["ocr","extractions"]},"workflow":{"description":"A workflow outlines steps for processing documents, including analysis, extraction, and transformation. It uses unique identifiers to track and retrieve results for each document.","example":"invoice_extraction","type":"string"},"language":{"description":"The language of the uploaded document.","example":"en","type":"string","enum":["cs","de","en","fr","pl","es","nl","ja","sk"]},"documentType":{"description":"The type of the uploaded document.","example":"invoice","type":"string"}},"additionalProperties":true,"required":["resultType","workflow"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/chart/bars":{"post":{"tags":["Chart"],"summary":"Generate Bar Chart","description":"This endpoint generates a bar chart image based on the provided data, labels, and customization options.","operationId":"generate_chart_bars_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"Data points for the bar chart.","type":"array","items":{"type":"number"}},"labels":{"description":"Labels corresponding to the data points.","type":"array","items":{"type":"string"}},"getAsUrl":{"description":"If true, returns a URL instead of the chart image.","type":"boolean"},"width":{"description":"Width of the chart image.","type":"number"},"height":{"description":"Height of the chart image.","type":"number"},"backgroundColor":{"description":"Background color of the chart image.","type":"string"},"bordersColors":{"description":"Colors for the borders of the bars.","type":"array","items":{"type":"string"}},"barsColors":{"description":"Colors for the bars in the chart.","type":"array","items":{"type":"string"}},"borderWidth":{"description":"Width of the borders around the bars.","type":"number"},"title":{"description":"Title of the chart.","type":"string"},"options":{"description":"Additional configuration options for Chart.js.","type":"object","properties":{},"additionalProperties":true},"fileName":{"description":"Optional filename for the generated chart image.","type":"string"}},"additionalProperties":true,"required":["data","labels"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result image URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/chart/doughnut":{"post":{"tags":["Chart"],"summary":"Generate Doughnut Chart","description":"This endpoint generates a doughnut chart image based on the provided data, labels, and customization options.","operationId":"generate_chart_doughnut_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"Data points for the doughnut chart.","type":"array","items":{"type":"number"}},"labels":{"description":"Labels corresponding to the data points.","type":"array","items":{"type":"string"}},"getAsUrl":{"description":"If true, returns a URL instead of the chart image.","type":"boolean"},"width":{"description":"Width of the chart image.","type":"number"},"height":{"description":"Height of the chart image.","type":"number"},"backgroundColor":{"description":"Background color of the chart image.","type":"string"},"bordersColors":{"description":"Colors for the borders of the doughnut.","type":"array","items":{"type":"string"}},"barsColors":{"description":"Colors for the doughnut in the chart.","type":"array","items":{"type":"string"}},"borderWidth":{"description":"Width of the borders around the doughnut.","type":"number"},"title":{"description":"Title of the chart.","type":"string"},"options":{"description":"Additional configuration options for Chart.js.","type":"object","properties":{},"additionalProperties":true},"fileName":{"description":"Optional filename for the generated chart image.","type":"string"}},"additionalProperties":true,"required":["data","labels"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result image URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/generate/chart/line":{"post":{"tags":["Chart"],"summary":"Generate Line Chart","description":"This endpoint generates a line chart image based on the provided data, labels, and customization options.","operationId":"generate_chart_line_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"Data points for the line chart.","type":"array","items":{"type":"number"}},"labels":{"description":"Labels corresponding to the data points.","type":"array","items":{"type":"string"}},"getAsUrl":{"description":"If true, returns a URL instead of the chart image.","type":"boolean"},"width":{"description":"Width of the chart image.","type":"number"},"height":{"description":"Height of the chart image.","type":"number"},"backgroundColor":{"description":"Background color of the chart image.","type":"string"},"bordersColors":{"description":"Colors for the borders of the line.","type":"array","items":{"type":"string"}},"barsColors":{"description":"Colors for the line in the chart.","type":"array","items":{"type":"string"}},"fill":{"description":"Fill the color under the line.","type":"boolean"},"tension":{"description":"Tension of the line.","type":"number"},"borderWidth":{"description":"Width of the borders around the line.","type":"number"},"title":{"description":"Title of the chart.","type":"string"},"options":{"description":"Additional configuration options for Chart.js.","type":"object","properties":{},"additionalProperties":true},"fileName":{"description":"Optional filename for the generated chart image.","type":"string"}},"additionalProperties":true,"required":["data","labels"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result image URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/image/blur":{"post":{"tags":["Image"],"summary":"Blur an image.","operationId":"image_blur_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The image URL","type":"string"},"buffer":{"description":"The image as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"sigma":{"description":"How strongly the image will be blurred.","type":"number","minimum":0.3,"maximum":1000},"getAsUrl":{"description":"Whether the result image should be returned as a URL. Default is `false`.","type":"boolean"},"fileName":{"description":"The file name of the result image. Default is a random ID.","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result image URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/image/convert":{"post":{"tags":["Image"],"summary":"Convert an image.","operationId":"image_convert_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The image URL","type":"string"},"buffer":{"description":"The image as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"outputFormat":{"description":"The output format of the conversion.","type":"string","enum":["jpeg","jpg","png","gif","tiff","webp"]},"withMetaData":{"description":"Whether the image metadata should be converted, too.","type":"boolean"},"options":{"type":"object","properties":{"quality":{"description":"Quality. Applies to JPEG, PNG, WEBP, TIFF. Default for JPEG, WEBP, TIFF is 80. Default for PNG is 100.","example":80,"type":"number","minimum":1,"maximum":100},"alphaQuality":{"description":"Quality of alpha layer. Applies to WEBP. Default is 100.","example":100,"type":"number","minimum":0,"maximum":100},"lossless":{"description":"Whether to use lossless compression. Applies to WEBP. Default is `false`.","example":false,"type":"boolean"},"nearLossless":{"description":"Whether to use near_lossless compression. Applies to WEBP. Default is `false`.","example":false,"type":"boolean"},"smartSubsample":{"description":"Whether to use high quality chroma subsampling. Applies to WEBP. Default is `false`.","example":false,"type":"boolean"},"progressive":{"description":"Progressive (interlace) scan. Applies to JPEG, PNG, GIF. Default is false.","example":false,"type":"boolean"},"chromaSubsampling":{"description":"Chroma subsampling settings. `4:4:4` prevents subsampling if `quality` is at most 90. Applies to JPEG. Default is `4:2:0`.","example":"4:2:0","type":"string","enum":["4:4:4","4:2:0"]},"trellisQuanitsation":{"description":"Whether to use trellis quantization. Applies to JPEG. Default is `false`.","example":false,"type":"boolean"},"overshootDeringing":{"description":"Whether to apply overshoot deringing. Applies to JPEG. Default is `false`.","example":false,"type":"boolean"},"optimiseScans":{"description":"Whether to use optimized progressive scans. This enables `progressive`. Applies to JPEG. Default is `false`.","example":false,"type":"boolean"},"optimizeScans":{"description":"Alternative spelling of `optimiseScans`.","type":"boolean"},"optimiseCoding":{"description":"Whether to use optimized Huffman coding tables. Applies to JPEG. Default is `true`.","example":true,"type":"boolean"},"optimizeCoding":{"description":"Alternative spelling of `optimiseCoding`.","type":"boolean"},"quanitsationTable":{"description":"The quantization table that will be used. Applies to JPEG. Default is 0.","example":0,"type":"number","minimum":0,"maximum":8},"quantizationTable":{"description":"Alternative spelling of `quantisationTable`.","type":"number","minimum":0,"maximum":8},"mozjpeg":{"description":"Whether to use mozjpeg defaults. Default is `false`.","example":false,"type":"boolean"},"compressionLevel":{"description":"The zlib compression level. Applies to PNG. Default is 6.","example":6,"type":"number","minimum":0,"maximum":9},"adaptiveFiltering":{"description":"Whether adaptive row filtering should be used. Applies to PNG. Default is `false`.","example":false,"type":"boolean"},"effort":{"description":"CPU effort for compression. For PNG and GIF, 1 is fastest, 10 is slowest, and enables `palette`. Default is 7. For WEBP, 0 is fastest, 6 is slowest. Default is 4.","example":7,"type":"number"},"palette":{"description":"Use a palette-based image with an alpha channel. Applies to PNG. Default is `false`.","example":false,"type":"boolean"},"colours":{"description":"Maximum number of colors in palette. Applies to PNG and GIF. Default is 256.","example":256,"type":"number"},"colors":{"description":"Alternative spelling of `colours`.","type":"number"},"dither":{"description":"Level of Floyd-Steinberg error diffusion. Applies to PNG and GIF. Default is 1.0.","example":1,"type":"number"},"preset":{"description":"Preset option. Applies to WEBP. Default is `default`.","example":"default","type":"string","enum":["default","photo","picture","drawing","icon","text"]},"compression":{"description":"Compression option. Applies to TIFF. Default is `jpeg`.","example":"jpeg","type":"string","enum":["none","jpeg","deflate","packbits","ccittfax4","lzw","webp","zstd","jp2k"]},"predictor":{"description":"Compression predictor setting. Applies to TIFF. Default is `horizontal`.","example":"horizontal","type":"string","enum":["none","horizontal","float"]},"pyramid":{"description":"Write an image pyramid. Applies to TIFF. Default is `false`.","example":false,"type":"boolean"},"tile":{"description":"Enable tiling mode. Applies to TIFF. Deault is `false`.","example":false,"type":"boolean"},"tileWidth":{"description":"Horizontal tile size. Only applies when `tile` is true. Applies to TIFF. Default is 256.","example":256,"type":"number"},"tileHeight":{"description":"Vertical tile size. Only applies when `tile` is true. Applies to TIFF. Default is 256.","example":256,"type":"number"},"xres":{"description":"Horizontal resolution in px/mm. Applies to TIFF. Default is 1.0.","example":1,"type":"number"},"yres":{"description":"Vertical resolution in px/mm. Applies to TIFF. Default is 1.0.","example":1,"type":"number"},"bitdepth":{"description":"Reduce bitdepth. Applies to TIFF. Default is 8.","example":8,"type":"string","enum":[1,2,4,8]},"miniswhite":{"description":"Write 1-bit images as miniswhite. Applies to TIFF. Default is `false`.","example":false,"type":"boolean"},"resolutionUnit":{"description":"Resolution unit. Applies to TIFF. Default is `inch`.","example":"inch","type":"string","enum":["inch","cm"]},"reuse":{"description":"Re-use existing palette, otherwise generate new (slow). Applies to GIF. Default is `false`.","example":false,"type":"boolean"},"interFrameMaxError":{"description":"Maximum inter-frame error for transparency. 0 means lossless. Applies to GIF. Default is 0.","example":0,"type":"number","minimum":0,"maximum":32},"interPaletteMaxError":{"description":"Maximum inter-palette error for palette reuse. Default is 3.","example":3,"type":"number","minimum":0,"maximum":256}},"additionalProperties":true},"getAsUrl":{"description":"Whether the result image should be returned as a URL. Default is `false`.","type":"boolean"},"fileName":{"description":"The file name of the result image. Default is a random ID.","type":"string"}},"additionalProperties":true,"required":["outputFormat"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result image URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/image/crop":{"post":{"tags":["Image"],"summary":"Crop an image.","operationId":"image_crop_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The image URL","type":"string"},"buffer":{"description":"The image as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"options":{"type":"object","properties":{"left":{"description":"The number of pixels that should be cropped on the left.","example":100,"type":"integer"},"top":{"description":"The number of pixels that should be cropped on the top.","example":100,"type":"integer"},"width":{"description":"The width of the crop.","example":500,"type":"integer"},"height":{"description":"The height of the crop.","example":500,"type":"integer"}},"additionalProperties":true,"required":["left","top","width","height"]},"getAsUrl":{"description":"Whether the result image should be returned as a URL. Default is `false`.","type":"boolean"},"fileName":{"description":"The file name of the result image. Default is a random ID.","type":"string"}},"additionalProperties":true,"required":["options"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result image URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/image/exif":{"post":{"tags":["Image"],"summary":"Get EXIF data.","operationId":"image_exif_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The image URL","type":"string"},"buffer":{"description":"The image as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"exifData":{"description":"The EXIF data of the image. For details, see https://exiv2.org/tags.html."}},"additionalProperties":true,"required":["exifData"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/image/flip":{"post":{"tags":["Image"],"summary":"Flip an image.","operationId":"image_flip_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The image URL","type":"string"},"buffer":{"description":"The image as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"axis":{"description":"The axis the image will be flipped about.","type":"string","enum":["X","x","Y","y"]},"getAsUrl":{"description":"Whether the result image should be returned as a URL. Default is `false`.","type":"boolean"},"fileName":{"description":"The file name of the result image. Default is a random ID.","type":"string"}},"additionalProperties":true,"required":["axis"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result image URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/image/html":{"post":{"tags":["Image"],"summary":"Convert HTML to image.","operationId":"image_html_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The image URL","type":"string"},"html":{"description":"The HTML source. Can be specified instead of `url`.","type":"string"},"options":{"type":"object","properties":{"type":{"description":"The output image format. Default is `png`.","example":"png","type":"string","enum":["png","jpg","jpeg","webp"]},"quality":{"description":"The screenshot quality between 0 and 100. Does not apply to PNG. Default is 80.","example":80,"type":"number","minimum":0,"maximum":100},"fullPage":{"description":"Whether to take a screenshot of the full page. Default is `false`.","example":true,"type":"boolean"},"defaultBackground":{"description":"Whether to use the default background. Default is `true`.","type":"boolean"},"emulateDevice":{"description":"The name of the device that should be emulated. By default, no device is emulated.","type":"string"},"width":{"description":"The width of the screenshot in pixels. Default is 1920.","example":1920,"type":"number"},"height":{"description":"The height of the screenshot in pixels. Default is 1080.","example":1080,"type":"number"},"scaleFactor":{"description":"The device-specific scale factor. Default is 1.","example":1,"type":"number"},"darkMode":{"description":"Whether to use dark mode. Default is `false`.","type":"boolean"},"clip":{"description":"The region the screenshot should capture.","type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}},"additionalProperties":true,"required":["x","y","width","height"]}},"additionalProperties":true},"getAsUrl":{"description":"Whether the result image should be returned as a URL. Default is `false`.","type":"boolean"},"fileName":{"description":"The file name of the result image. Default is a random ID.","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result image URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/image/overlay":{"post":{"tags":["Image"],"summary":"Overlay two images.","operationId":"image_overlay_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"frontImageUrl":{"description":"The URL of the front image.","type":"string"},"backImageUrl":{"description":"The URL of the background image.","type":"string"},"position":{"description":"The position of the front image on the back image. This overrides `options.horizontalPosition` and `options.verticalPosition`.","type":"string","enum":["center","top-left","top-right","bottom-left","bottom-right"]},"getAsUrl":{"description":"Whether to return the result as a buffer or a URL. Default is buffer.","type":"boolean"},"options":{"type":"object","properties":{"horizontalPosition":{"description":"The horizontal position of the front image on the back image.","type":"number"},"verticalPosition":{"description":"The vertical position of the front image on the back image.","type":"number"},"opacity":{"description":"The opacity of the front image. `1` means fully opaque, `0` means fully transparent. The value is multiplied with the existing alpha channel of the image, i.e. transparent images work without this setting. Default is `1`.","type":"number","minimum":0,"maximum":1},"type":{"description":"The output image format, e.g. `jpeg` or `png`. Default is `jpeg`.","type":"string"}},"additionalProperties":true},"fileName":{"description":"A custom file name. If this is not set, a randomly generated is used instead.","type":"string"}},"additionalProperties":true,"required":["frontImageUrl","backImageUrl"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The URL of the overlayed image. Only available if `getAsUrl` is true.","type":"string"},"fileName":{"description":"The filename of the image, if one was provided.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/image/resize":{"post":{"tags":["Image"],"summary":"Resize an image.","operationId":"image_resize_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"buffer":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"options":{"type":"object","properties":{"fit":{"description":"How to resize the image to fit if both `width` and `height` are specified. Must be one of:\n- `cover`: Crop the image so the entire dimensions are filled.\n- `contain`: Do not crop the image, so parts of the result will be empty and the entire image is contained.\n- `fill`: Stretch the image to fill the dimensions without cropping or empty space.\n- `inside`: Resize the image to be as large as possible without width or height being greater than the desired dimensions.\n- `outside`: Resize the image to be as small as possible without width or height being smaller than the desired dimensions.\nDefault is `cover`.","type":"string","enum":["contain","cover","fill","inside","outside"]},"position":{"type":"string","enum":["center","top","right top","right","right bottom","bottom","left bottom","left","left top","north","northeast","east","southeast","south","southwest","west","northwest","entropy","attention"]},"background":{"description":"The color for the space not covered by the resized image. Default is black.","anyOf":[{"type":"string"},{"type":"object","properties":{"r":{"type":"number"},"g":{"type":"number"},"b":{"type":"number"},"alpha":{"type":"number"}},"additionalProperties":true}]},"kernel":{"description":"The kernel that will be used for image reduction. Must be one of:\n- `nearest`: Use nearest neighbor interpolation.\n- `cubic`: Use a Catmull-Rom spline.\n- `lanczos2`: Use a Lanczos kernel with a = 2.\n- `lanczos3`: Use a Lanczos kernel with a = 3.\nDefault is `lanczos3`.","type":"string","enum":["nearest","cubic","lanczos2","lanczos3"]}},"additionalProperties":true},"getAsUrl":{"type":"boolean"},"fileName":{"type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/image/rotate":{"post":{"tags":["Image"],"summary":"Rotate an image.","operationId":"image_rotate_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The image URL","type":"string"},"buffer":{"description":"The image as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"angle":{"description":"The clockwise rotation.","type":"number"},"background":{"description":"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","type":"string"},"getAsUrl":{"description":"Whether the result image should be returned as a URL. Default is `false`.","type":"boolean"},"fileName":{"description":"The file name of the result image. Default is a random ID.","type":"string"}},"additionalProperties":true,"required":["angle"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result image URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/image/sharpen":{"post":{"tags":["Image"],"summary":"Sharpen an image.","operationId":"image_sharpen_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The image URL","type":"string"},"buffer":{"description":"The image as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"sigma":{"description":"How strongly the image will be sharpened.","type":"number","minimum":0.3,"maximum":1000},"getAsUrl":{"description":"Whether the result image should be returned as a URL. Default is `false`.","type":"boolean"},"fileName":{"description":"The file name of the result image. Default is a random ID.","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result image URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/draw/image":{"post":{"tags":["PDF"],"summary":"Draw image on PDF.","operationId":"pdf_draw_image_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The PDF as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"getAsUrl":{"description":"Whether the result PDF should be returned as a URL. Default is false.","example":true,"type":"boolean"},"imageUrl":{"description":"The URL of the image to draw.","type":"string"},"imageBuffer":{"description":"T?he image as a Base64-encoded buffer. Can be specified instead of `imageUrl`.","type":"string"},"anchor":{"description":"The part of the page on which the image should be drawn. Default is `center`.","example":"center","type":"string","enum":["bottom-left","bottom","bottom-right","left","center","right","top-left","top","top-right"]},"align":{"description":"The part of the image that should be aligned with the specified position. Default is the value of `anchor`.","example":"center","type":"string","enum":["bottom-left","bottom","bottom-right","left","center","right","top-left","top","top-right"]},"x":{"description":"The horizontal offset in points relative to the anchor. Default is 0.","example":0,"type":"number"},"y":{"description":"The vertical offset in points relative to the anchor. Default is 0.","example":0,"type":"number"},"width":{"description":"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,"type":"number"},"height":{"description":"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,"type":"number"},"rotate":{"description":"The counter-clockwise rotation of the image in degrees. Default is 0.","example":45,"type":"number"},"pages":{"description":"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.","type":"string"},"fileName":{"description":"The file name the result PDF will have. Default is a random ID.","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/draw/text":{"post":{"tags":["PDF"],"summary":"Draw text on PDF.","operationId":"pdf_draw_text_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The PDF as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"getAsUrl":{"description":"Whether the result PDF should be returned as a URL. Default is false.","example":true,"type":"boolean"},"text":{"description":"The text to draw.","example":"Hello, world!","type":"string"},"font":{"description":"The font to use. Default is Helvetica.","example":"Helvetica","type":"string","enum":["Helvetica","Courier","TimesRoman"]},"anchor":{"description":"The part of the page on which the text should be drawn. Default is `center`.","example":"center","type":"string","enum":["bottom-left","bottom","bottom-right","left","center","right","top-left","top","top-right"]},"align":{"description":"The part of the text that should be aligned with the specified position. Default is the value of `anchor`.","example":"center","type":"string","enum":["bottom-left","bottom","bottom-right","left","center","right","top-left","top","top-right"]},"x":{"description":"The horizontal offset in points relative to the anchor. Default is 0.","example":0,"type":"number"},"y":{"description":"The vertical offset in points relative to the anchor. Default is 0.","example":0,"type":"number"},"rotate":{"description":"The counter-clockwise rotation of the text in degrees. Default is 0.","example":45,"type":"number"},"size":{"description":"The font size in points. Default is 32.","example":32,"type":"number"},"color":{"description":"The font color as a six-digit hexcode, i.e. RRGGBB. Default is 000000, i.e. black.","example":"FFFF00","type":"string"},"pages":{"description":"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","type":"string"},"fileName":{"description":"The file name the result PDF will have. Default is a random ID.","type":"string"}},"additionalProperties":true,"required":["text"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result PDF URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/metadata/edit":{"post":{"tags":["PDF"],"summary":"Edit PDF metadata.","operationId":"pdf_metadata_edit_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The PDF as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"getAsUrl":{"description":"Whether the result PDF should be returned as a URL. Default is `false`.","example":true,"type":"boolean"},"title":{"description":"The new title of the PDF.","type":"string"},"author":{"description":"The new author of the PDF.","type":"string"},"subject":{"description":"The new subject of the PDF.","type":"string"},"keywords":{"description":"The new keywords of the PDF.","type":"array","items":{"type":"string"}},"fileName":{"description":"The file name of the result PDF. Default is a random ID.","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result PDF URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/metadata/info":{"post":{"tags":["PDF"],"summary":"Get PDF metadata.","operationId":"pdf_metadata_info_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The PDF as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"description":"The title of the PDF.","type":"string"},"author":{"description":"The author of the PDF.","type":"string"},"subject":{"description":"The subject of the PDF.","type":"string"},"keywords":{"description":"The keywords of the PDF.","type":"array","items":{"type":"string"}},"creator":{"description":"The creator of the PDF, which is the software used to design it.","type":"string"},"creationDate":{"description":"The creation date of the PDF.","type":"string","format":"date-time"},"modificationDate":{"description":"The last modification date of the PDF.","type":"string","format":"date-time"},"isEncrypted":{"description":"Whether the PDF is encrypted.","type":"boolean"},"pageCount":{"description":"The page count of the PDF.","type":"number"},"pages":{"type":"array","items":{"type":"object","properties":{"width":{"description":"The width of the page in points.","type":"number"},"height":{"description":"The height of the page in points.","type":"number"},"rotation":{"description":"The rotation of the page in degrees. This does not detect the actual rotation of the page content, but just returns the rotation value stored inside the PDF.","type":"number"}},"additionalProperties":true,"required":["width","height","rotation"]}}},"additionalProperties":true,"required":["isEncrypted","pageCount","pages"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/pages/add":{"post":{"tags":["PDF"],"summary":"Add PDF pages.","operationId":"pdf_pages_add_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The PDF as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"getAsUrl":{"description":"Whether the result PDF should be returned as a URL. Default is `false`.","example":true,"type":"boolean"},"width":{"description":"The width of the pages to add. Default is the width of the first page.","example":595,"type":"number"},"height":{"description":"The height of the pages to add. Default is the height of the first page.","example":842,"type":"number"},"pages":{"description":"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.","type":"array","items":{"type":"number"}},"fileName":{"description":"The file name of the result PDF. Default is a random ID.","type":"string"}},"additionalProperties":true,"required":["pages"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result PDF URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/pages/remove":{"post":{"tags":["PDF"],"summary":"Remove PDF pages.","operationId":"pdf_pages_remove_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The PDF as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"getAsUrl":{"description":"Whether the result PDF should be returned as a URL. Default is `false`.","example":true,"type":"boolean"},"pages":{"description":"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","type":"string"},"fileName":{"description":"The file name of the result PDF. Default is a random ID.","type":"string"}},"additionalProperties":true,"required":["pages"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result PDF URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/pages/resize":{"post":{"tags":["PDF"],"summary":"Resize PDF pages.","operationId":"pdf_pages_resize_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The PDF as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"getAsUrl":{"description":"Whether the result PDF should be returned as a URL. Default is `false`.","example":true,"type":"boolean"},"width":{"description":"The new width in points.","type":"number"},"height":{"description":"The new height in points.","type":"number"},"pages":{"description":"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","type":"string"},"fileName":{"description":"The file name of the result PDF. Default is a random ID.","type":"string"}},"additionalProperties":true,"required":["width","height","pages"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result PDF URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/pages/rotate":{"post":{"tags":["PDF"],"summary":"Rotate PDF pages.","operationId":"pdf_pages_rotate_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The PDF as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"getAsUrl":{"description":"Whether the result PDF should be returned as a URL. Default is `false`.","example":true,"type":"boolean"},"rotate":{"description":"Clockwise rotation of the pages in degrees. Must be a multiple of 90.","example":90,"type":"number"},"pages":{"description":"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","type":"string"},"fileName":{"description":"The file name of the result PDF. Default is a random ID.","type":"string"}},"additionalProperties":true,"required":["rotate","pages"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result PDF URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/base64":{"post":{"tags":["PDF"],"summary":"Convert PDF to Base64.","operationId":"pdf_base64_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pdf":{"description":"The PDF URL.","type":"string"},"fileName":{"description":"The file name will be returned again. If none is provided, one will be generated automatically.","type":"string"}},"additionalProperties":true,"required":["pdf"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pdfBase64":{"description":"The Base64-encoded PDF buffer.","type":"string"},"fileName":{"description":"The provided file name or an auto-generated one.","type":"string"}},"additionalProperties":true,"required":["pdfBase64","fileName"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/compress":{"post":{"tags":["PDF"],"summary":"Compress PDF.","description":"Attempt to reduce the size of a PDF file by optimizing its images and structure. Please note that 0CodeKit may not always be able to decrease the file size.","operationId":"pdf_compress_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"buffer":{"type":"string"},"getAsUrl":{"type":"boolean"},"fileName":{"type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/count":{"post":{"tags":["PDF"],"summary":"Count PDF pages.","operationId":"pdf_count_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The PDF as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pageCount":{"description":"The number of pages in the PDF.","type":"number"}},"additionalProperties":true,"required":["pageCount"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/create":{"post":{"tags":["PDF"],"summary":"Create empty PDF.","operationId":"pdf_create_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"getAsUrl":{"description":"Whether the result PDF should be returned as a URL. Default is `false`.","example":true,"type":"boolean"},"pages":{"description":"The number of pages the new PDF should have. Must be at least 1. Default is 1.","example":10,"type":"number","minimum":1},"width":{"description":"The width of the pages in points. Default is 595.","example":595,"type":"number"},"height":{"description":"The height of the pages in points. Default is 842.","example":842,"type":"number"},"fileName":{"description":"The file name the result PDF will have. Default is a random ID.","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result PDF URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/decrypt":{"post":{"tags":["PDF"],"summary":"Decrypt PDF.","operationId":"pdf_decrypt_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The PDF as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"getAsUrl":{"description":"Whether the result PDF should be returned as a URL. Default is `false`.","example":true,"type":"boolean"},"password":{"description":"The password used to decrypt the PDF. Can be either the user or the owner password.","type":"string"}},"additionalProperties":true,"required":["password"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result PDF URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/docx-to-pdf":{"post":{"tags":["PDF"],"summary":"Convert DOCX to PDF.","operationId":"pdf_docx-to-pdf_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The DOCX URL.","type":"string"},"buffer":{"description":"The DOCX as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"getAsUrl":{"description":"Whether the result PDF should be returned as a URL. Default is `false`.","example":true,"type":"boolean"},"fileName":{"description":"The file name of the result PDF. Default is a random ID.","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result PDF URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/encrypt":{"post":{"tags":["PDF"],"summary":"Encrypt PDF.","operationId":"pdf_encrypt_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The PDF as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"getAsUrl":{"description":"Whether the result PDF should be returned as a URL. Default is `false`.","example":true,"type":"boolean"},"userPassword":{"description":"The user password.","type":"string"},"ownerPassword":{"description":"The owner password. Default is the user password.","type":"string"}},"additionalProperties":true,"required":["userPassword"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result PDF URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/getinfometadata":{"post":{"tags":["PDF"],"summary":"Get PDF metadata.","description":"WARNING: This endpoint is deprecated. Please use `/pdf/metadata/info` instead.","operationId":"pdf_getinfometadata_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pdf":{"description":"The PDF URL or Base64-encoded buffer.","type":"string"},"filename":{"description":"The PDF file name. Default is a random ID.","type":"string"}},"additionalProperties":true,"required":["pdf"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"description":"The title of the PDF.","type":"string"},"author":{"description":"The author of the PDF.","type":"string"},"producer":{"description":"The producer of the PDF.","type":"string"},"creator":{"description":"The creator of the PDF, which is the software used to design it.","type":"string"},"creationDate":{"description":"The creation date of the PDF.","type":"string","format":"date-time"},"modificationDate":{"description":"The last modification date of the PDF.","type":"string","format":"date-time"},"pageCount":{"description":"The page count of the PDF.","type":"number"},"filename":{"description":"The file name that was passed in the request, or a random ID.","type":"string"}},"additionalProperties":true,"required":["pageCount","filename"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/html":{"post":{"tags":["PDF"],"summary":"Convert HTML to PDF.","operationId":"pdf_html_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The URL of the website.","type":"string"},"html":{"description":"The HTML source. Can be specified instead of `url`","type":"string"},"getAsUrl":{"description":"Whether the result PDF should be returned as a URL. Default is `false`.","example":true,"type":"boolean"},"fileName":{"description":"The PDF file name. Default is a random ID.","type":"string"},"options":{"type":"object","properties":{"scale":{"description":"The scale of the web app. Default is 1.","example":1,"type":"number","minimum":0.1,"maximum":2},"displayHeaderFooter":{"description":"Show header and footer. Default is false.","example":false,"type":"boolean"},"printBackground":{"description":"Whether to include the background in the PDF. Default is `false`.","example":false,"type":"boolean"},"landscape":{"description":"Whether the PDF should be in landscape orientation. Default is `false`.","example":false,"type":"boolean"},"pageRanges":{"description":"The page ranges to output.","example":"1-3,8,15-20","type":"string"},"format":{"description":"The format of the result PDF. This overwrites the `width` and `height` settings.","example":"a4","type":"string","enum":["letter","Letter","LETTER","legal","Legal","LEGAL","tabloid","Tabloid","TABLOID","ledger","Ledger","LEDGER","a0","A0","a1","A1","a2","A2","a3","A3","a4","A4","a5","A5","a6","A6"]},"width":{"description":"The width of the result PDF. Either a number in points or a string with a unit.","anyOf":[{"type":"string"},{"type":"number"}]},"height":{"description":"The height of the result PDF. Either a number in points or a string with a unit.","anyOf":[{"type":"string"},{"type":"number"}]},"preferCSSPageSize":{"description":"Overwrite the `format`, `width` and `height` settings with the page size defined by CSS. Default is `false`.","example":false,"type":"boolean"},"margin":{"description":"The margins of the output PDF. Default is no margins.","type":"object","properties":{"top":{"anyOf":[{"type":"number"},{"type":"string"}]},"bottom":{"anyOf":[{"type":"number"},{"type":"string"}]},"left":{"anyOf":[{"type":"number"},{"type":"string"}]},"right":{"anyOf":[{"type":"number"},{"type":"string"}]}},"additionalProperties":true},"omitBackground":{"description":"Do not use default white background, which makes the PDF transparent. Default is `false`.","example":false,"type":"boolean"},"tagged":{"description":"Generate accessible PDF. Default is `true`.","example":true,"type":"boolean"}},"additionalProperties":true}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/markdownstringtopdf":{"post":{"tags":["PDF"],"summary":"Convert Markdown to PDF.","operationId":"pdf_markdownstringtopdf_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"markdownString":{"description":"The Markdown source that will be converted to a PDF.","type":"string"},"css":{"description":"Custom CSS to change the Markdown look.","type":"string"},"getAsUrl":{"description":"Whether the result PDF should be returned as a URL. Default is `false`.","example":true,"type":"boolean"},"fileName":{"description":"The PDF file name. Default is a random ID.","type":"string"}},"additionalProperties":true,"required":["markdownString"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/merge":{"post":{"tags":["PDF"],"summary":"Merge PDF files.","operationId":"pdf_merge_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The PDF as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"pages":{"description":"The pages that should be included in the merged document. By default, all pages are included. This is specified as comma-separated page ranges, where 1 means the first page and ^1 the last page.","example":"1-3,5,^15-^13,^6-","anyOf":[{"type":"array","items":{"type":"number"}},{"type":"string"}]}},"additionalProperties":true}},"getAsUrl":{"description":"Whether the result PDF should be returned as a URL. Default is `false`.","example":true,"type":"boolean"},"fileName":{"description":"The file name the result PDF will have. Default is a random ID.","type":"string"}},"additionalProperties":true,"required":["files"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result PDF URL.","type":"string"}},"additionalProperties":true,"required":["url"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/pdf-to-image":{"post":{"tags":["PDF"],"summary":"Convert PDF to image.","operationId":"pdf_pdf-to-image_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The PDF as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"fileName":{"description":"The file name prefix of the result images. Default is a random ID.","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/split":{"post":{"tags":["PDF"],"summary":"Split PDF file.","operationId":"pdf_split_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The PDF as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"pages":{"description":"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.","type":"array","items":{"type":"string"}},"interval":{"description":"The number of pages that should be contained in every split PDF file. Can be specified instead of `pages`.","type":"number"},"fileName":{"description":"The file name prefix the result PDFs will have. Default is a random ID.","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pdfUrls":{"description":"The URLs of all split PDF files.","type":"array","items":{"type":"string"}}},"additionalProperties":true,"required":["pdfUrls"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/watermark/image":{"post":{"tags":["PDF"],"summary":"Draw a watermark image inside the PDF.","operationId":"pdf_watermark_image_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The PDF as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"getAsUrl":{"description":"Whether the result PDF should be returned as a URL. Default is false.","example":true,"type":"boolean"},"repeat":{"description":"Repeats the image across the entire specified range of the PDF. Default is false","example":true,"type":"boolean"},"imageUrl":{"description":"The URL of the image to draw.","type":"string"},"imageBuffer":{"description":"The image as a Base64-encoded buffer. Can be specified instead of `imageUrl`.","type":"string"},"anchor":{"description":"The part of the page on which the image should be drawn. Default is `center`.","example":"center","type":"string","enum":["bottom-left","bottom","bottom-right","left","center","right","top-left","top","top-right"]},"align":{"description":"The part of the image that should be aligned with the specified position. Default is the value of `anchor`.","example":"center","type":"string","enum":["bottom-left","bottom","bottom-right","left","center","right","top-left","top","top-right"]},"x":{"description":"The horizontal offset in points relative to the anchor. Default is 0.","example":0,"type":"number"},"y":{"description":"The vertical offset in points relative to the anchor. Default is 0.","example":0,"type":"number"},"width":{"description":"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,"type":"number"},"height":{"description":"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,"type":"number"},"rotate":{"description":"The counter-clockwise rotation of the image in degrees. Default is 0.","example":45,"type":"number"},"spacing":{"description":"The space between each image. It only applies if repeat is true. Default is 0.","example":45,"type":"number"},"opacity":{"description":"The opacity of the given image. The range must be between 0 and 1. Default is 1.","example":0.2,"type":"number"},"pages":{"description":"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. Default are all Pages.","type":"string"},"fileName":{"description":"The file name the result PDF will have. Default is a random ID.","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/pdf/watermark/text":{"post":{"tags":["PDF"],"summary":"Draw a watermark text inside the PDF.","operationId":"pdf_watermark_text_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The PDF as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"getAsUrl":{"description":"Whether the result PDF should be returned as a URL. Default is false.","example":true,"type":"boolean"},"repeat":{"description":"Repeats the text across the entire specified range of the PDF. Default is false","example":true,"type":"boolean"},"text":{"description":"The text to draw.","example":"Hello, world!","type":"string"},"font":{"description":"The font to use. Default is Helvetica.","example":"Helvetica","type":"string","enum":["Helvetica","Courier","TimesRoman"]},"anchor":{"description":"The part of the page on which the text should be drawn. Default is `center`.","example":"center","type":"string","enum":["bottom-left","bottom","bottom-right","left","center","right","top-left","top","top-right"]},"align":{"description":"The part of the text that should be aligned with the specified position. Default is the value of `anchor`.","example":"center","type":"string","enum":["bottom-left","bottom","bottom-right","left","center","right","top-left","top","top-right"]},"x":{"description":"The horizontal offset in points relative to the anchor. Default is 0.","example":0,"type":"number"},"y":{"description":"The vertical offset in points relative to the anchor. Default is 0.","example":0,"type":"number"},"spacing":{"description":"The space between each text. It only applies if repeat is true. Default is 0.","example":45,"type":"number"},"rotate":{"description":"The counter-clockwise rotation of the text in degrees. Default is 0.","example":45,"type":"number"},"size":{"description":"The font size in points. Default is 32.","example":32,"type":"number"},"color":{"description":"The font color as a six-digit hexcode, i.e. RRGGBB. Default is 000000, i.e. black.","example":"FFFF00","type":"string"},"pages":{"description":"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. Default are all Pages.","example":"1,3-5,^3-^1","type":"string"},"opacity":{"description":"The opacity of the text. Must be between 0 and 1. Default is 1","example":0.5,"type":"number"},"fileName":{"description":"The file name the result PDF will have. Default is a random ID.","type":"string"}},"additionalProperties":true,"required":["text"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/business/facturx/validate":{"post":{"tags":["Factur-X"],"summary":"Validate a Factur-X/Zugferd PDF.","description":"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.","operationId":"business_facturx_validate_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The PDF as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"}},"additionalProperties":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"valid":{"description":"Whether the PDF is a valid Factur-X/Zugferd invoice (level EN16931).","type":"boolean"},"errors":{"description":"The errors that were generated during the validation of the XML invoice. Only set if `valid` is false.","type":"array","items":{"type":"string"}},"invoice":{"description":"The attached Factur-X/Zugferd XML invoice.","type":"string"}},"additionalProperties":true,"required":["valid"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/business/facturx/embed":{"post":{"tags":["Factur-X"],"summary":"Embed a Factur-X/Zugferd XML into an existing PDF.","description":"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.","operationId":"business_facturx_embed_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The Base64-encoded PDF file. Can be specified instead of `url`.","type":"string"},"xml":{"description":"The Factur-X/Zugferd XML invoice that shall be embedded.","type":"string"},"getAsUrl":{"description":"Whether the PDF should be returned as a URL. Default is `false`.","type":"boolean"},"fileName":{"description":"The PDF file name. Default is a random ID.","type":"string"}},"additionalProperties":true,"required":["xml"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/fuzzy-match":{"post":{"tags":["AI"],"summary":"Find the best match for a query string from a list of targets.","description":"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.","operationId":"ai_fuzzy-match_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"queryString":{"description":"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","type":"string"},"context":{"description":"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","type":"string"},"targetList":{"description":"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"],"type":"array","items":{"type":"string"}},"options":{"type":"object","properties":{"maxResults":{"description":"The maximum number of matches to return. Defaults to 1 if not specified.","example":2,"type":"number"}},"additionalProperties":true}},"additionalProperties":true,"required":["queryString","targetList"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"matches":{"anyOf":[{"description":"An array of matched strings if `maxResults` is greater than 1.","example":["Gordon Shumway"],"type":"array","items":{"type":"string"}},{"description":"A single matched string if `maxResults` is 1.","example":"Gordon Shumway","type":"string"}]}},"additionalProperties":true,"required":["matches"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/extract-from-text":{"post":{"tags":["AI"],"summary":"Extract a custom object from a given text.","description":"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.","operationId":"ai_extract-from-text_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"description":"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.","type":"string"},"context":{"description":"Prompt that contextualizes the `text`.","example":"A brief self-introduction from an alien applying for an intergalactic research role.","type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"description":"Name (key) of the field.","example":"age","type":"string"},"description":{"description":"Prompt describing the kind of information that this field should contain.","example":"Age of the alien. Just a number, no other text.","type":"string"},"validationRegex":{"description":"A regular expression that will be used to validate the value.","example":"^(?:[1-9][0-9]?|1[0-9]{2}|200)$","type":"string"}},"additionalProperties":true,"required":["name","description"]}}},"additionalProperties":true,"required":["text","context","fields"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/ai/redact-pdf":{"post":{"tags":["PDF"],"summary":"Redact sensitive information from pdf.","operationId":"ai_redact-pdf_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The PDF URL.","type":"string"},"buffer":{"description":"The PDF as a Base64-encoded buffer. Can be specified instead of `url`.","type":"string"},"sensitiveContent":{"description":"A text prompt describing which data from the document should be covered.","example":"All people names and addresses should be considered sensitive data.","type":"string"},"fileName":{"description":"The file name the result PDF will have. Default is a random ID.","type":"string"},"getAsUrl":{"description":"Whether the result PDF should be returned as a URL. Default is false.","example":true,"type":"boolean"},"language":{"description":"The language of the document in ISO 639-1 nomenclature. Default is 'en' (English).","example":"de","type":"string"}},"additionalProperties":true,"required":["sensitiveContent"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The result PDF URL.","type":"string"},"fileName":{"description":"The name of the file.","type":"string"}},"additionalProperties":true,"required":["url","fileName"]}},"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/docs":{"get":{"tags":["Miscellaneous"],"summary":"DEPRECATED: Get OpenAPI documentation.","description":"This endpoint is deprecated, please use /openapi.json instead.","operationId":"docs_get","security":[],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/merge-video-audio":{"post":{"tags":["Operator"],"summary":"Merge audio into a video","operationId":"operator_merge-video-audio_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"video":{"description":"The URL of the video file.","example":"https://example.com/video.mp4","type":"string"},"audio":{"description":"The URL of the audio file.","example":"https://example.com/audio.mp3","type":"string"},"fileName":{"description":"The name of the merged video.","type":"string"}},"additionalProperties":true,"required":["video","audio"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"outputUrl":{"description":"The URL where the merged video can be downloaded.","example":"https://example.com/output.mp4","type":"string"}},"additionalProperties":true,"required":["outputUrl"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/extract-audio":{"post":{"tags":["Operator"],"summary":"Extract audio from video.","operationId":"operator_extract-audio_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"video":{"description":"The URL of the video file.","example":"https://example.com/video.mp4","type":"string"},"format":{"description":"The desired audio file format. Default is `mp3`.","type":"string","enum":["flac","m4a","mp3","ogg","wav"]},"fileName":{"description":"The name of the extracted audio file.","type":"string"}},"additionalProperties":false,"required":["video"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"outputUrl":{"description":"The URL of the extracted audio file.","example":"https://example.com/audio.mp3","type":"string"}},"additionalProperties":false,"required":["outputUrl"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/concat-audio":{"post":{"tags":["Operator"],"summary":"Concatenate audio files.","operationId":"operator_concat-audio_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"audio":{"description":"An array of URLs to the audio files to concatenate. Minimum 2 required.","example":["https://example.com/audio1.mp3","https://example.com/audio2.mp3"],"type":"array","items":{"type":"string"},"minItems":2},"format":{"description":"The desired output audio file format. Default is `mp3`.","type":"string","enum":["flac","m4a","mp3","ogg","wav"]},"fileName":{"description":"The name of the concatenated audio file.","type":"string"},"silence":{"description":"The amount of silence that should be inserted between the audio files in seconds.","type":"array","items":{"type":"number"}}},"additionalProperties":false,"required":["audio"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"outputUrl":{"description":"The URL of the concatenated audio file.","example":"https://example.com/audio.mp3","type":"string"}},"additionalProperties":false,"required":["outputUrl"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/operator/async-concat-audio":{"post":{"tags":["Operator"],"summary":"Concatenate audio files asynchronously.","description":"This endpoint concatenates audio files exactly like the normal concat audio endpoint. In contrast to that endpoint, it returns immediately with a task ID instead of waiting for the audio to be processed, which means it is not affected by the request timeout of your automation platform. The URL of the concatenated file is sent to the webhook given in `sendTo`, and can also be retrieved by passing the task ID to the `/code/taskstatus` endpoint. Use this endpoint whenever the combined length of your audio files is large enough that the synchronous endpoint runs into a timeout. The execution of this module costs 500 credits, and the credits are only deducted once the concatenation has succeeded.","operationId":"operator_async-concat-audio_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"audio":{"description":"An array of URLs to the audio files to concatenate. Minimum 2 required.","example":["https://example.com/audio1.mp3","https://example.com/audio2.mp3"],"type":"array","items":{"type":"string"},"minItems":2},"format":{"description":"The desired output audio file format. Default is `mp3`.","type":"string","enum":["flac","m4a","mp3","ogg","wav"]},"fileName":{"description":"The name of the concatenated audio file.","type":"string"},"silence":{"description":"The amount of silence that should be inserted between the audio files in seconds.","type":"array","items":{"type":"number"}},"sendTo":{"description":"The URL of the webhook the response will be sent to.","type":"string"}},"additionalProperties":false,"required":["audio"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"Always `pending`, since the task was queued.","type":"string"},"taskId":{"description":"The ID of the task, which can be passed to `/code/taskstatus`.","type":"string"}},"additionalProperties":false,"required":["status","taskId"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/code/async-python":{"post":{"tags":["Code"],"summary":"Execute async Python","description":"This endpoint runs Python code in a Linux sandbox using the CPython interpreter. In contrast to the normal Python endpoint, this endpoint returns immediately, and the result of your code is sent to a webhook. You can return data using the `print` statement. To import dependencies, first add all the dependencies to the `requirements` array, and then import them using the common `import` statement. All dependencies will be automatically downloaded and installed for you, with the exception of native system dependencies. There is a time limit of 30 minutes and a memory limit of 512MB applied to your code, which also includes the dependency download process. The execution of this module costs 50 credits for every started 3 minutes of execution, so at least 50 and at most 500 credits.","operationId":"code_async-python_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"The Python script that will be executed.","type":"string"},"requirements":{"description":"The PyPI libraries your Python code requires.","type":"array","items":{"type":"string"}},"dependencies":{"description":"The system dependencies your Python code requires. These will be installed using apk, the Alpine Package manager.","type":"array","items":{"type":"string"}},"sendTo":{"description":"The URL of the webhook the response will be sent to.","type":"string"}},"additionalProperties":true,"required":["code"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"taskId":{"type":"string"}},"additionalProperties":true,"required":["status","taskId"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/code/javascript":{"post":{"tags":["Code"],"summary":"Execute JavaScript code.","description":"This endpoint runs JavaScript code in a Linux sandbox using the Bun JavaScript runtime. You can return data from the code using a top-level `return` statement or by setting the global `result` variable. Logging something to the console has no effect. To import dependencies, use the `require` function. All dependencies will be automatically downloaded and installed for you, with the exception of native system dependencies. There is a time limit of 180s and a memory limit of 512MB applied to your code, which also includes the dependency download process. One execution of this module costs 50 credits.","operationId":"code_javascript_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"authorization","in":"header","description":"The API key that can be retrieved from 0codekit.com.","required":false,"schema":{"description":"The API key that can be retrieved from 0codekit.com.","type":"string"}},{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"The JavaScript code that will be executed.","example":"const _ = require('lodash');\nreturn { data: _.chunk(['a', 'b', 'c', 'd'], 2) };\n","type":"string"},"dependencies":{"description":"The system dependencies your JavaScript code requires. These will be installed using apk, the Alpine Package manager.","example":[],"type":"array","items":{"type":"string"}}},"additionalProperties":true,"required":["code"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"description":"The data returned by the JavaScript code."}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/code/python":{"post":{"tags":["Code"],"summary":"Execute Python code.","description":"This endpoint runs Python code in a Linux sandbox using the CPython interpreter. You can return data from the code by setting the global `result` variable. Logging something to the console has no effect. To import dependencies, first add all dependencies to the `requirements` array, and then import them using the common `import` statement. All dependencies will be automatically downloaded and installed for you, with the exception of native system dependencies. There is a time limit of 180s and a memory limit of 512MB applied to your code, which also includes the dependency download process. One execution of this module costs 50 credits.","operationId":"code_python_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"authorization","in":"header","description":"The API key that can be retrieved from 0codekit.com.","required":false,"schema":{"description":"The API key that can be retrieved from 0codekit.com.","type":"string"}},{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"The Python code that will be executed.","example":"import requests\nresult = { \"data\": requests.get(\"https://0codekit.com\").text }\n","type":"string"},"requirements":{"description":"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.","example":[],"type":"array","items":{"type":"string"}},"dependencies":{"description":"The system dependencies your Python code requires. These will be installed using apk, the Alpine Package manager.","example":[],"type":"array","items":{"type":"string"}}},"additionalProperties":true,"required":["code"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"description":"The data returned by the Python code."}},"additionalProperties":true,"required":["result"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/code/python-b2":{"post":{"tags":["Code"],"summary":"Execute Python code.","description":"This endpoint runs Python code in a Linux sandbox using the CPython interpreter. You can return data from the code by setting the global `result` variable. Logging something to the console has no effect. To import dependencies, first add all dependencies to the `requirements` array, and then import them using the common `import` statement. All dependencies will be automatically downloaded and installed for you, with the exception of native system dependencies. There is a time limit of 180s and a memory limit of 512MB applied to your code, which also includes the dependency download process. One execution of this module costs 50 credits.","operationId":"code_python-b2_post","security":[{"apiKeyAuth":[]}],"parameters":[{"name":"authorization","in":"header","description":"The API key that can be retrieved from 0codekit.com.","required":false,"schema":{"description":"The API key that can be retrieved from 0codekit.com.","type":"string"}},{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"The Python code that will be executed.","example":"import requests\nresult = { \"data\": requests.get(\"https://0codekit.com\").text }\n","type":"string"},"requirements":{"description":"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.","example":[],"type":"array","items":{"type":"string"}},"dependencies":{"description":"The system dependencies your Python code requires. These will be installed using apk, the Alpine Package manager.","example":[],"type":"array","items":{"type":"string"}}},"additionalProperties":true,"required":["code"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"description":"The data returned by the Python code."}},"additionalProperties":true,"required":["result"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/code/taskstatus":{"post":{"tags":["Code"],"summary":"Get async task status.","operationId":"code_taskstatus_post","security":[{"apiKeyAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"taskId":{"description":"The ID of the task that will be checked.","type":"string"}},"additionalProperties":true,"required":["taskId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"The current task status.","type":"string","enum":["pending","error","success"]},"result":{"description":"The result (output) of the task. Only available if the status is not `pending`.","type":"string"}},"additionalProperties":true,"required":["status"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/mcp":{"get":{"tags":["MCP"],"summary":"Establish MCP SSE connection.","description":"This endpoint is used to establish an SSE connection for the Model Context Protocol (MCP). It immediately returns an `endpoint` event with the URL to POST messages to. Responses will be delivered to the SSE connection.","operationId":"mcp_get","security":[],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/mcp/messages":{"post":{"tags":["MCP"],"summary":"MCP POST endpoint","operationId":"mcp_messages_post","security":[],"parameters":[{"name":"sessionId","in":"query","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"jsonrpc":{"type":"string","enum":["2.0"]},"id":{},"method":{"type":"string"},"params":{"type":"object","properties":{"protocolVersion":{"type":"string"},"name":{"type":"string"},"arguments":{}},"additionalProperties":true}},"additionalProperties":false,"required":["jsonrpc","method"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/mcp/list":{"get":{"tags":["MCP"],"summary":"List all 0CodeKit endpoints.","description":"These endpoints can be called via the `call_post` tool. 0CodeKit has many tools available, so before claiming that you cannot do something, check the result of this tool first. You do not need to ask the user before using this tool.","operationId":"mcp_list_get","security":[],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/mcp/info":{"post":{"tags":["MCP"],"summary":"Get description about 0CodeKit endpoint.","description":"Get a detailed description of the specified 0CodeKit endpoint. This tool should only be called with endpoints from the `list_get` tool. Do not forget the leading slash. The tool name must not be encoded in any way. You do not need to ask the user before using this tool.","operationId":"mcp_info_post","security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"endpoint":{"type":"string"}},"additionalProperties":false,"required":["endpoint"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"summary":{"type":"string"},"description":{"type":"string"},"body":{}},"additionalProperties":false,"required":["summary","body"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/mcp/call":{"post":{"tags":["MCP"],"summary":"Call 0CodeKit endpoint.","description":"Available endpoints can be retrieved using the `list_get` tool. Do not forget the leading slash. Always check the required structure using the `info_post` tool before attempting to call an endpoint. The `body` must be provided as a JSON object, and never formatted as a string. You do not need to ask the user before using this tool.","operationId":"mcp_call_post","security":[{"bearerAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"endpoint":{"type":"string"},"body":{}},"additionalProperties":false,"required":["endpoint","body"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/editor":{"post":{"tags":["Editor"],"summary":"Create saved codes.","operationId":"editor_post","security":[],"parameters":[{"name":"auth","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"variables":{"type":"array","items":{"type":"string"}},"code":{"type":"string"},"language":{"type":"string","enum":["javascript","python"]}},"additionalProperties":false,"required":["name","variables","code","language"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"saved":{"type":"boolean"}},"additionalProperties":false,"required":["saved"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}},"delete":{"tags":["Editor"],"summary":"Delete saved code.","operationId":"editor_delete","security":[],"parameters":[{"name":"rowKey","in":"query","required":true,"schema":{"type":"string"}},{"name":"auth","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"}},"additionalProperties":false,"required":["deleted"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}},"get":{"tags":["Editor"],"summary":"List saved codes.","operationId":"editor_get","security":[],"parameters":[{"name":"auth","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"partitionKey":{"type":"string"},"rowKey":{"type":"string"},"name":{"type":"string"},"code":{"type":"string"},"language":{"type":"string"}},"additionalProperties":false,"required":["partitionKey","rowKey","name","code","language"]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}},"put":{"tags":["Editor"],"summary":"Update saved code.","operationId":"editor_put","security":[],"parameters":[{"name":"rowKey","in":"query","required":true,"schema":{"type":"string"}},{"name":"auth","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"variables":{"type":"array","items":{"type":"string"}},"language":{"type":"string"}},"additionalProperties":false,"required":["code","variables","language"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"updated":{"type":"boolean"}},"additionalProperties":false,"required":["updated"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/editor/make":{"post":{"tags":["Editor/Make"],"summary":"Execute JavaScript code.","operationId":"editor_make_post","security":[],"parameters":[{"name":"rowKey","in":"query","required":true,"schema":{"type":"string"}},{"name":"language","in":"query","required":true,"schema":{"type":"string","enum":["javascript","python"]}},{"name":"auth","in":"header","required":true,"schema":{"type":"string"}},{"name":"ipaas","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"variables":{"type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false,"required":["variables"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"output":{"type":"object","properties":{"result":{}},"additionalProperties":false,"required":["result"]}},"additionalProperties":false,"required":["output"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}},"get":{"tags":["Editor/Make"],"summary":"List saved code on Automation.","operationId":"editor_make_get","security":[],"parameters":[{"name":"language","in":"query","required":true,"schema":{"type":"string","enum":["javascript","python"]}},{"name":"auth","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false,"required":["label","value"]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/editor/make-variables":{"get":{"tags":["Editor/Make"],"summary":"Get all available code editor variables.","operationId":"editor_make-variables_get","security":[],"parameters":[{"name":"rowKey","in":"query","required":true,"schema":{"type":"string"}},{"name":"auth","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"variables":{"type":"array","items":{"type":"string"}}},"additionalProperties":false,"required":["variables"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/resource/variables":{"get":{"tags":["Resource"],"summary":"Get all global azure variables.","operationId":"resource_variables_get","security":[],"parameters":[{"name":"auth","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"variableName":{"type":"string"},"variableValue":{"type":"string"}},"additionalProperties":false,"required":["variableName","variableValue"]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/resource/bin":{"get":{"tags":["Resource"],"summary":"Get all json bins","operationId":"resource_bin_get","security":[],"parameters":[{"name":"auth","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"binId":{"type":"string"}},"additionalProperties":false,"required":["binId"]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/resource/schedulers":{"get":{"tags":["Resource"],"summary":"Get all active scheduler task.","operationId":"resource_schedulers_get","security":[],"parameters":[{"name":"auth","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"taskId":{"type":"string"},"webhook":{"type":"string"},"nextExecution":{"type":"string"}},"additionalProperties":false,"required":["taskId","webhook","nextExecution"]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}},"/resource/shortened-urls":{"get":{"tags":["Resource"],"summary":"Get all Shortened Urls","operationId":"resource_shortened-urls_get","security":[],"parameters":[{"name":"auth","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"identifier":{"type":"string"},"createdAt":{"type":"string"},"destination":{"type":"string"}},"additionalProperties":false,"required":["identifier","createdAt","destination"]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"errorMessage":{"type":"string"},"code":{"type":"string"}},"required":["status","errorMessage"]}}}}}}}}}