{"openapi":"3.0.3","info":{"title":"pdflayer API","version":"1.0.0","description":"The pdflayer API was built to provide a quick and seamless way to automate HTML to PDF conversion in any application. Its lightweight RESTful infrastructure is based on an efficient combination of the most powerful PDF rendering engines available, making it the most cost-effective and reliable option for anyone looking to process small or large numbers of documents within short time windows.\nThe pdflayer API comes with a full set of customization functionalities, including document configuration, a series of layout adjustment options, authentication and security, design and branding tweaks, and much more.\nThe following documentation intends to outline in detail the pdflayer API's specification, access and use of any features and parameters currently available.\n"},"servers":[{"url":"https://api.pdflayer.com"}],"security":[{"accessKey":[]}],"tags":[],"externalDocs":{"description":"Official pdflayer documentation (reference)","url":"https://pdflayer.com/documentation"},"paths":{"/api/convert":{"get":{"summary":"Generate a PDF from a URL","operationId":"convertGet","tags":["Convert"],"description":"Generates a PDF from a remote URL. All parameters are passed via the query string.\n`document_url` is required for GET. HTML body parameters are rejected on GET.\n","parameters":[{"$ref":"#/components/parameters/accessKey"},{"$ref":"#/components/parameters/documentUrlRequired"},{"$ref":"#/components/parameters/documentName"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageWidth"},{"$ref":"#/components/parameters/pageHeight"},{"$ref":"#/components/parameters/customUnit"},{"$ref":"#/components/parameters/marginTop"},{"$ref":"#/components/parameters/marginBottom"},{"$ref":"#/components/parameters/marginLeft"},{"$ref":"#/components/parameters/marginRight"},{"$ref":"#/components/parameters/headerSpacing"},{"$ref":"#/components/parameters/footerSpacing"},{"$ref":"#/components/parameters/orientation"},{"$ref":"#/components/parameters/title"},{"$ref":"#/components/parameters/author"},{"$ref":"#/components/parameters/subject"},{"$ref":"#/components/parameters/creator"},{"$ref":"#/components/parameters/authUser"},{"$ref":"#/components/parameters/authPass"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/delay"},{"$ref":"#/components/parameters/zoom"},{"$ref":"#/components/parameters/cssUrl"},{"$ref":"#/components/parameters/headerAlign"},{"$ref":"#/components/parameters/headerUrl"},{"$ref":"#/components/parameters/footerAlign"},{"$ref":"#/components/parameters/footerUrl"},{"$ref":"#/components/parameters/pageNumberingOffset"},{"$ref":"#/components/parameters/watermarkUrl"},{"$ref":"#/components/parameters/watermarkOffsetX"},{"$ref":"#/components/parameters/watermarkOffsetY"},{"$ref":"#/components/parameters/watermarkOpacity"},{"$ref":"#/components/parameters/viewport"},{"$ref":"#/components/parameters/encryption"},{"$ref":"#/components/parameters/ownerPassword"},{"$ref":"#/components/parameters/userPassword"},{"$ref":"#/components/parameters/ttl"},{"$ref":"#/components/parameters/force"},{"$ref":"#/components/parameters/inline"},{"$ref":"#/components/parameters/userAgent"},{"$ref":"#/components/parameters/acceptLang"},{"$ref":"#/components/parameters/noImages"},{"$ref":"#/components/parameters/noHyperlinks"},{"$ref":"#/components/parameters/noBackgrounds"},{"$ref":"#/components/parameters/noJavascript"},{"$ref":"#/components/parameters/usePrintMedia"},{"$ref":"#/components/parameters/grayscale"},{"$ref":"#/components/parameters/lowQuality"},{"$ref":"#/components/parameters/noPrint"},{"$ref":"#/components/parameters/noModify"},{"$ref":"#/components/parameters/noCopy"},{"$ref":"#/components/parameters/headerText"},{"$ref":"#/components/parameters/footerText"},{"$ref":"#/components/parameters/watermarkInBackground"}],"responses":{"200":{"description":"Generated PDF","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"missing_document_source":{"summary":"missing_document_source","value":{"success":false,"error":{"code":313,"type":"missing_document_source","info":"You have not specified a document source. Please use either document_url or document_html."}}},"invalid_document_url":{"summary":"invalid_document_url","value":{"success":false,"error":{"code":311,"type":"invalid_document_url","info":"You have specified an invalid document URL. [Make sure to include the HTTP protocol - example: http://example.com/invoice.html]"}}},"invalid_html":{"summary":"invalid_html","value":{"success":false,"error":{"code":312,"type":"invalid_html","info":"Invalid html provided"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimitReached"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Maintenance"}}},"post":{"summary":"Generate a PDF from raw HTML (or URL)","operationId":"convertPost","tags":["Convert"],"description":"Accepts raw HTML for the document body, header, and footer in the JSON body.\nAll other parameters are read from the query string (same as GET).\nAt least one of `document_html` (body) or `document_url` (query) must be supplied.\n","parameters":[{"$ref":"#/components/parameters/accessKey"},{"$ref":"#/components/parameters/documentUrl"},{"$ref":"#/components/parameters/documentName"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageWidth"},{"$ref":"#/components/parameters/pageHeight"},{"$ref":"#/components/parameters/customUnit"},{"$ref":"#/components/parameters/marginTop"},{"$ref":"#/components/parameters/marginBottom"},{"$ref":"#/components/parameters/marginLeft"},{"$ref":"#/components/parameters/marginRight"},{"$ref":"#/components/parameters/headerSpacing"},{"$ref":"#/components/parameters/footerSpacing"},{"$ref":"#/components/parameters/orientation"},{"$ref":"#/components/parameters/title"},{"$ref":"#/components/parameters/author"},{"$ref":"#/components/parameters/subject"},{"$ref":"#/components/parameters/creator"},{"$ref":"#/components/parameters/authUser"},{"$ref":"#/components/parameters/authPass"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/delay"},{"$ref":"#/components/parameters/zoom"},{"$ref":"#/components/parameters/cssUrl"},{"$ref":"#/components/parameters/headerAlign"},{"$ref":"#/components/parameters/headerUrl"},{"$ref":"#/components/parameters/footerAlign"},{"$ref":"#/components/parameters/footerUrl"},{"$ref":"#/components/parameters/pageNumberingOffset"},{"$ref":"#/components/parameters/watermarkUrl"},{"$ref":"#/components/parameters/watermarkOffsetX"},{"$ref":"#/components/parameters/watermarkOffsetY"},{"$ref":"#/components/parameters/watermarkOpacity"},{"$ref":"#/components/parameters/viewport"},{"$ref":"#/components/parameters/encryption"},{"$ref":"#/components/parameters/ownerPassword"},{"$ref":"#/components/parameters/userPassword"},{"$ref":"#/components/parameters/ttl"},{"$ref":"#/components/parameters/force"},{"$ref":"#/components/parameters/inline"},{"$ref":"#/components/parameters/userAgent"},{"$ref":"#/components/parameters/acceptLang"},{"$ref":"#/components/parameters/noImages"},{"$ref":"#/components/parameters/noHyperlinks"},{"$ref":"#/components/parameters/noBackgrounds"},{"$ref":"#/components/parameters/noJavascript"},{"$ref":"#/components/parameters/usePrintMedia"},{"$ref":"#/components/parameters/grayscale"},{"$ref":"#/components/parameters/lowQuality"},{"$ref":"#/components/parameters/noPrint"},{"$ref":"#/components/parameters/noModify"},{"$ref":"#/components/parameters/noCopy"},{"$ref":"#/components/parameters/headerText"},{"$ref":"#/components/parameters/footerText"},{"$ref":"#/components/parameters/watermarkInBackground"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertRequest"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/ConvertRequest"}}}},"responses":{"200":{"description":"Generated PDF","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"},"examples":{"missing_document_source":{"summary":"missing_document_source","value":{"success":false,"error":{"code":313,"type":"missing_document_source","info":"You have not specified a document source. Please use either document_url or document_html."}}},"invalid_document_url":{"summary":"invalid_document_url","value":{"success":false,"error":{"code":311,"type":"invalid_document_url","info":"You have specified an invalid document URL. [Make sure to include the HTTP protocol - example: http://example.com/invoice.html]"}}},"invalid_html":{"summary":"invalid_html","value":{"success":false,"error":{"code":312,"type":"invalid_html","info":"Invalid html provided"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimitReached"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Maintenance"}}}}},"components":{"securitySchemes":{"accessKey":{"type":"apiKey","in":"query","name":"access_key","description":"API Access Key provided by pdflayer. Attach as `?access_key=YOUR_KEY` to requests."}},"parameters":{"accessKey":{"in":"query","name":"access_key","required":true,"schema":{"type":"string"},"description":"Your pdflayer API Access Key.","example":"YOUR_ACCESS_KEY"},"documentUrl":{"in":"query","name":"document_url","schema":{"type":"string","format":"uri"},"description":"URL of the page to render to PDF. Private IPs and IP-to-domain mapping services (nip.io, xip.io, sslip.io, nip.la, lvh.me) are rejected."},"documentUrlRequired":{"in":"query","name":"document_url","required":true,"schema":{"type":"string","format":"uri"},"description":"URL of the page to render to PDF. Required on GET. Private IPs and IP-to-domain mapping services (nip.io, xip.io, sslip.io, nip.la, lvh.me) are rejected."},"documentName":{"in":"query","name":"document_name","schema":{"type":"string","maxLength":180},"description":"Filename used in the Content-Disposition response header."},"pageSize":{"in":"query","name":"page_size","schema":{"type":"string","enum":["A0","A1","A2","A3","A4","A5","A6","A7","A8","A9","B0","B1","B2","B3","B4","B5","B6","B7","B8","B9","LETTER","LEGAL","TABLOID","LEDGER","C5E","COMM10E","DLE","EXECUTIVE","FOLIO"],"example":"A4"},"description":"Standard page size. Case-insensitive; normalized to upper case."},"pageWidth":{"in":"query","name":"page_width","schema":{"type":"integer","minimum":75},"description":"Custom page width. Must be paired with `page_height`. Units controlled by `custom_unit`.\n\n**Note:** the value must be greater than **75px**. Values below 75px are rejected with a \"not processable\" error.\n"},"pageHeight":{"in":"query","name":"page_height","schema":{"type":"integer","minimum":75},"description":"Custom page height. Must be paired with `page_width`. Units controlled by `custom_unit`.\n\n**Note:** the value must be greater than **75px**. Values below 75px are rejected with a \"not processable\" error.\n"},"customUnit":{"in":"query","name":"custom_unit","schema":{"type":"string","enum":["in","mm","px","pt"]},"description":"Unit used to interpret page and margin dimensions. Default `px`."},"marginTop":{"in":"query","name":"margin_top","schema":{"type":"number","minimum":0},"description":"Top margin in `custom_unit` units."},"marginBottom":{"in":"query","name":"margin_bottom","schema":{"type":"number","minimum":0},"description":"Bottom margin in `custom_unit` units."},"marginLeft":{"in":"query","name":"margin_left","schema":{"type":"number","minimum":0},"description":"Left margin in `custom_unit` units."},"marginRight":{"in":"query","name":"margin_right","schema":{"type":"number","minimum":0},"description":"Right margin in `custom_unit` units."},"headerSpacing":{"in":"query","name":"header_spacing","schema":{"type":"number","minimum":0},"description":"Spacing between header and page body, in `custom_unit` units."},"footerSpacing":{"in":"query","name":"footer_spacing","schema":{"type":"number","minimum":0},"description":"Spacing between footer and page body, in `custom_unit` units."},"orientation":{"in":"query","name":"orientation","schema":{"type":"string","enum":["portrait","landscape"]},"description":"Page orientation. Case-insensitive."},"title":{"in":"query","name":"title","schema":{"type":"string","maxLength":150},"description":"PDF metadata — document title."},"author":{"in":"query","name":"author","schema":{"type":"string","maxLength":150},"description":"PDF metadata — author."},"subject":{"in":"query","name":"subject","schema":{"type":"string","maxLength":150},"description":"PDF metadata — subject."},"creator":{"in":"query","name":"creator","schema":{"type":"string","maxLength":150},"description":"PDF metadata — creator."},"authUser":{"in":"query","name":"auth_user","schema":{"type":"string","maxLength":1000},"description":"HTTP Basic auth username used when fetching `document_url`."},"authPass":{"in":"query","name":"auth_pass","schema":{"type":"string","maxLength":1000},"description":"HTTP Basic auth password used when fetching `document_url`."},"dpi":{"in":"query","name":"dpi","schema":{"type":"integer","minimum":10,"maximum":192},"description":"Render DPI. Default 96."},"delay":{"in":"query","name":"delay","schema":{"type":"integer","minimum":10,"maximum":20000},"description":"Delay in milliseconds after page load before capturing the PDF."},"zoom":{"in":"query","name":"zoom","schema":{"type":"number","minimum":0,"maximum":50},"description":"Zoom factor applied to the page."},"cssUrl":{"in":"query","name":"css_url","schema":{"type":"string","format":"uri"},"description":"Public URL of a CSS stylesheet to inject. Must return `text/css` with 2xx status. Private IPs are rejected."},"headerAlign":{"in":"query","name":"header_align","schema":{"type":"string","enum":["left","center","right"]},"description":"Horizontal alignment for the page header. Case-insensitive."},"headerUrl":{"in":"query","name":"header_url","schema":{"type":"string","format":"uri"},"description":"Public URL of an HTML fragment used as the page header. Must return 2xx. Private IPs are rejected."},"footerAlign":{"in":"query","name":"footer_align","schema":{"type":"string","enum":["left","center","right"]},"description":"Horizontal alignment for the page footer. Case-insensitive."},"footerUrl":{"in":"query","name":"footer_url","schema":{"type":"string","format":"uri"},"description":"Public URL of an HTML fragment used as the page footer. Must return 2xx. Private IPs are rejected."},"pageNumberingOffset":{"in":"query","name":"page_numbering_offset","schema":{"type":"integer","minimum":0},"description":"Offset added to the rendered page numbers (e.g. to skip a cover page)."},"watermarkUrl":{"in":"query","name":"watermark_url","schema":{"type":"string","format":"uri"},"description":"Public URL of an image used as a watermark. Must return 2xx. Private IPs are rejected."},"watermarkOffsetX":{"in":"query","name":"watermark_offset_x","schema":{"type":"number","minimum":0},"description":"Horizontal watermark offset from the page edge."},"watermarkOffsetY":{"in":"query","name":"watermark_offset_y","schema":{"type":"number","minimum":0},"description":"Vertical watermark offset from the page edge."},"watermarkOpacity":{"in":"query","name":"watermark_opacity","schema":{"type":"number","minimum":0,"maximum":100},"description":"Watermark opacity, 0 (transparent) – 100 (opaque)."},"viewport":{"in":"query","name":"viewport","schema":{"type":"string","pattern":"^[0-9]+[xX][0-9]+$","example":"1440x900"},"description":"Browser viewport in `widthXheight` pixels. Max 5000x5000."},"encryption":{"in":"query","name":"encryption","schema":{"type":"integer","enum":[40,128,256]},"description":"PDF encryption key length in bits. Requires both `owner_password` and `user_password`."},"ownerPassword":{"in":"query","name":"owner_password","schema":{"type":"string","maxLength":32},"description":"Owner password for the encrypted PDF (if encryption is enabled).\n\nThe pdflayer API offers two levels of PDF password protection: **owner password** and **user password**. These can be specified by appending the owner_password and user_password parameter(s) and setting them to their respective password value. Both owner_password and user_password must be provided.\n"},"userPassword":{"in":"query","name":"user_password","schema":{"type":"string","maxLength":32},"description":"User password for the encrypted PDF (if encryption is enabled).\n\nThe pdflayer API offers two levels of PDF password protection: **owner password** and **user password**. These can be specified by appending the owner_password and user_password parameter(s) and setting them to their respective password value. Both owner_password and user_password must be provided.\n"},"ttl":{"in":"query","name":"ttl","schema":{"type":"integer","minimum":300,"maximum":2592000},"description":"S3 cache lifetime in seconds (300 – 2,592,000)."},"force":{"in":"query","name":"force","schema":{"type":"integer","enum":[0,1]},"description":"Set to 1 to bypass the S3 cache."},"inline":{"in":"query","name":"inline","schema":{"type":"integer","enum":[0,1]},"description":"Set to 1 to render the PDF inline instead of as an attachment."},"userAgent":{"in":"query","name":"user_agent","schema":{"type":"string"},"description":"User-Agent header string used when fetching `document_url`."},"acceptLang":{"in":"query","name":"accept_lang","schema":{"type":"string"},"description":"Accept-Language header used when fetching `document_url` (e.g. en-US)."},"noImages":{"in":"query","name":"no_images","schema":{"type":"integer","enum":[0,1]},"description":"Set to 1 to remove all images from the generated PDF."},"noHyperlinks":{"in":"query","name":"no_hyperlinks","schema":{"type":"integer","enum":[0,1]},"description":"Set to 1 to remove all hyperlinks from the generated PDF."},"noBackgrounds":{"in":"query","name":"no_backgrounds","schema":{"type":"integer","enum":[0,1]},"description":"Set to 1 to remove CSS background graphics from the generated PDF."},"noJavascript":{"in":"query","name":"no_javascript","schema":{"type":"integer","enum":[0,1]},"description":"Set to 1 to disable JavaScript execution when rendering the PDF."},"usePrintMedia":{"in":"query","name":"use_print_media","schema":{"type":"integer","enum":[0,1]},"description":"Set to 1 to render using print media CSS styles."},"grayscale":{"in":"query","name":"grayscale","schema":{"type":"integer","enum":[0,1]},"description":"Set to 1 to convert the PDF to grayscale (black and white)."},"lowQuality":{"in":"query","name":"low_quality","schema":{"type":"integer","enum":[0,1]},"description":"Set to 1 to generate a lower-quality PDF (faster, smaller file)."},"noPrint":{"in":"query","name":"no_print","schema":{"type":"integer","enum":[0,1]},"description":"PDFLayer allows you to configure document permission options such as printing, copying, and modification restrictions at the time of PDF generation. Certain permission flags, including no_print, no_copy, and no_modify, can now be applied **without requiring** an owner_password, user_password, or the encryption parameter. These restrictions are embedded directly during PDF creation.\n\nFor advanced security features — such as password-protected documents, encrypted PDFs, or permissions that require post-generation control — please check the **PDF Authentication** section of the documentation.\n\nAfter a PDF is generated, permission settings that rely on passwords or encryption can only be changed or removed by supplying the **owner password**.\n\nSet to 1 to disable printing of the generated PDF.\n"},"noModify":{"in":"query","name":"no_modify","schema":{"type":"integer","enum":[0,1]},"description":"PDFLayer allows you to configure document permission options such as printing, copying, and modification restrictions at the time of PDF generation. Certain permission flags, including no_print, no_copy, and no_modify, can now be applied **without requiring** an owner_password, user_password, or the encryption parameter. These restrictions are embedded directly during PDF creation.\n\nFor advanced security features — such as password-protected documents, encrypted PDFs, or permissions that require post-generation control — please check the **PDF Authentication** section of the documentation.\n\nAfter a PDF is generated, permission settings that rely on passwords or encryption can only be changed or removed by supplying the **owner password**.\n\nSet to 1 to disable modifications to the generated PDF.\n"},"noCopy":{"in":"query","name":"no_copy","schema":{"type":"integer","enum":[0,1]},"description":"PDFLayer allows you to configure document permission options such as printing, copying, and modification restrictions at the time of PDF generation. Certain permission flags, including no_print, no_copy, and no_modify, can now be applied **without requiring** an owner_password, user_password, or the encryption parameter. These restrictions are embedded directly during PDF creation.\n\nFor advanced security features — such as password-protected documents, encrypted PDFs, or permissions that require post-generation control — please check the **PDF Authentication** section of the documentation.\n\nAfter a PDF is generated, permission settings that rely on passwords or encryption can only be changed or removed by supplying the **owner password**.\n\nSet to 1 to disable copying text and graphics from the generated PDF.\n"},"headerText":{"in":"query","name":"header_text","schema":{"type":"string"},"description":"Plain-text header content. For complex markup use `header_url` (or `header_html` in the POST body)."},"footerText":{"in":"query","name":"footer_text","schema":{"type":"string"},"description":"Plain-text footer content (supports placeholders like [page]/[topage]). For complex markup use `footer_url` (or `footer_html` in the POST body)."},"watermarkInBackground":{"in":"query","name":"watermark_in_background","schema":{"type":"integer","enum":[0,1]},"description":"Set to 1 to render the watermark behind the document content."}},"schemas":{"ApiError":{"type":"object","description":"Standard apilayer error envelope, shared by every error response.","required":["success","error"],"properties":{"success":{"type":"boolean","example":false},"error":{"type":"object","required":["code","type"],"properties":{"code":{"type":"integer","description":"apilayer numeric error code (the code the API returns in the body, e.g. 101 for an invalid access key — NOT the HTTP status).","example":101},"type":{"type":"string","description":"Machine-readable error type.","example":"invalid_access_key"},"info":{"type":"string","description":"Human-readable error detail.","example":"You have not supplied a valid API Access Key. [Technical Support: support@apilayer.com]"}}}}},"ConvertRequest":{"type":"object","description":"JSON body for POST /api/convert. All fields optional; at least one of\n`document_html` or the `document_url` query parameter must be present.\nHTML fields are rejected on GET requests.\n","properties":{"document_html":{"type":"string","description":"Raw HTML for the PDF body."},"header_html":{"type":"string","description":"Raw HTML rendered into the page header."},"footer_html":{"type":"string","description":"Raw HTML rendered into the page footer."}}},"ValidationError":{"type":"object","properties":{"success":{"type":"boolean","example":false},"error":{"type":"object","properties":{"code":{"type":"integer","description":"pdflayer-specific numeric error code."},"type":{"type":"string","description":"Machine-readable error type."},"info":{"type":"string","description":"Human-readable error detail."}}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"account_on_hold":{"summary":"account_on_hold","value":{"success":false,"error":{"code":107,"type":"account_on_hold","info":"Your account currently has open invoices and API has been automatically disabled. Please settle your open balance or downgrade to the Free Plan to restore API access. [Support: support@apilayer.com]"}}},"invalid_access_key":{"summary":"invalid_access_key","value":{"success":false,"error":{"code":101,"type":"invalid_access_key","info":"You have not supplied a valid API Access Key. [Technical Support: support@apilayer.com]"}}},"missing_access_key":{"summary":"missing_access_key","value":{"success":false,"error":{"code":101,"type":"missing_access_key","info":"You have not supplied an API Access Key. [Required format: access_key=YOUR_ACCESS_KEY]"}}},"inactive_user":{"summary":"inactive_user","value":{"success":false,"error":{"code":102,"type":"inactive_user","info":"Permission denied - User not active."}}}}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"https_access_restricted":{"summary":"https_access_restricted","value":{"success":false,"error":{"code":105,"type":"https_access_restricted","info":"Access Restricted - Your current Subscription Plan does not support HTTPS Encryption."}}},"function_access_restricted":{"summary":"function_access_restricted","value":{"success":false,"error":{"code":105,"type":"function_access_restricted","info":"Access Restricted - Your current Subscription Plan does not support this API Function."}}},"api_access_blocked":{"summary":"api_access_blocked","value":{"success":false,"error":{"code":104,"type":"api_access_blocked","info":"Your API access has been temporarily disabled. Please upgrade your Subscription Plan or contact support."}}}}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"invalid_api_function":{"summary":"invalid_api_function","value":{"success":false,"error":{"code":103,"type":"invalid_api_function","info":"This API Function does not exist."}}},"404_not_found":{"summary":"404_not_found","value":{"success":false,"error":{"code":404,"type":"404_not_found","info":"404 - The requested resource could not be found. Please try again or contact support."}}}}}}},"RateLimitReached":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"usage_limit_reached":{"summary":"usage_limit_reached","value":{"success":false,"error":{"code":104,"type":"usage_limit_reached","info":"Your monthly usage limit has been reached. Please upgrade your Subscription Plan."}}},"daily_usage_limit_reached":{"summary":"daily_usage_limit_reached","value":{"success":false,"error":{"code":104,"type":"daily_usage_limit_reached","info":"Your daily usage limit has been reached. Please try again tomorrow or upgrade your subscription plan."}}},"fair_use_limit_reached":{"summary":"fair_use_limit_reached","value":{"success":false,"error":{"code":104,"type":"fair_use_limit_reached","info":"Your fair use limit has been reached. [Please contact support: support@apilayer.com]"}}},"rate_limit_reached":{"summary":"rate_limit_reached","value":{"success":false,"error":{"code":106,"type":"rate_limit_reached","info":"You have exceeded the maximum rate limitation allowed on your subscription plan. Please refer to the \"Rate Limits\" section of the API Documentation for details. "}}}}}}},"InternalError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"internal_error":{"summary":"internal_error","value":{"success":false,"error":{"code":0,"type":"internal_error","info":"An error has occured. [Technical Support: support@apilayer.com]"}}}}}}},"Maintenance":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"maintenance_mode":{"summary":"maintenance_mode","value":{"success":false,"error":{"code":503,"type":"maintenance_mode","info":""}}}}}}}}}}