{ "openapi": "3.0.1", "info": { "title": "ConvertAPI", "description": "# High-Performance File Conversion API\nConvert Word, Excel, PowerPoint, HTML, PDF and Image formats with our powerful file conversion service.\nWe support more than [200 file types.]( https://www.convertapi.com/doc/file-formats)", "termsOfService": "https://www.convertapi.com/terms", "contact": { "url": "https://www.convertapi.com/support", "email": "support@convertapi.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "v2" }, "servers": [ { "url": "https://v2.convertapi.com" }, { "url": "https://eu-v2.convertapi.com" }, { "url": "https://uk-v2.convertapi.com" }, { "url": "https://us-v2.convertapi.com" }, { "url": "https://ca-v2.convertapi.com" }, { "url": "https://as-v2.convertapi.com" }, { "url": "https://au-v2.convertapi.com" } ], "paths": { "/convert/svg/to/pdf": { "summary": "SVG to PDF API", "description": "Convert SVG vector graphics to PDF with controls for page size, orientation, alignment, background, and exact dimensions.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/svg-to-pdf" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "svg" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "HorizontalAlignment": { "enum": [ "left", "center", "right" ], "type": "string", "description": "Specifies the horizontal image alignment.\n * `left` - left\n * `center` - center\n * `right` - right", "default": "center", "x-ca-featured": false, "x-ca-label": "Horizontal image alignment", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "left": "left", "center": "center", "right": "right" } }, "VerticalAlignment": { "enum": [ "top", "center", "bottom" ], "type": "string", "description": "Specifies the vertical image alignment.\n * `top` - top\n * `center` - center\n * `bottom` - bottom", "default": "center", "x-ca-featured": false, "x-ca-label": "Vertical image alignment", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "top": "top", "center": "center", "bottom": "bottom" } }, "BackgroundColor": { "type": "string", "description": "Sets the background color of the PDF. It can be a Hexadecimal value, an RGB value, an HSL value, or a color name (keyword value).", "default": "White", "x-ca-featured": false, "x-ca-label": "Background color", "x-ca-group": "PDF Output", "x-ca-type": "String", "x-ca-representation": "Default" }, "PageSize": { "enum": [ "a0", "a1", "a2", "a3", "a4", "a5", "a6", "a7", "a8", "a9", "b0", "b1", "b2", "b3", "b4", "b5", "letter", "legal", "ledger" ], "type": "string", "description": "PDF page size.\n * `a0` - A0\n * `a1` - A1\n * `a2` - A2\n * `a3` - A3\n * `a4` - A4\n * `a5` - A5\n * `a6` - A6\n * `a7` - A7\n * `a8` - A8\n * `a9` - A9\n * `b0` - B0\n * `b1` - B1\n * `b2` - B2\n * `b3` - B3\n * `b4` - B4\n * `b5` - B5\n * `letter` - Letter\n * `legal` - Legal\n * `ledger` - Ledger", "default": "a4", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Page Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "a0": "A0", "a1": "A1", "a2": "A2", "a3": "A3", "a4": "A4", "a5": "A5", "a6": "A6", "a7": "A7", "a8": "A8", "a9": "A9", "b0": "B0", "b1": "B1", "b2": "B2", "b3": "B3", "b4": "B4", "b5": "B5", "letter": "Letter", "legal": "Legal", "ledger": "Ledger" } }, "PageOrientation": { "enum": [ "portrait", "landscape" ], "type": "string", "description": "PDF page orientation.\n * `portrait` - Portrait\n * `landscape` - Landscape", "default": "portrait", "x-ca-featured": false, "x-ca-label": "Page orientation", "x-ca-group": "Page Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "portrait": "Portrait", "landscape": "Landscape" } }, "PageWidth": { "maximum": 30000, "minimum": 10, "type": "integer", "description": "Custom page width in millimeters (mm). This option override PageSize option.", "x-ca-featured": false, "x-ca-label": "Page width", "x-ca-group": "PDF Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "30000" } }, "PageHeight": { "maximum": 30000, "minimum": 10, "type": "integer", "description": "Custom page height in millimeters (mm). This option override PageSize option.", "x-ca-featured": false, "x-ca-label": "Page height", "x-ca-group": "PDF Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "30000" } }, "UseImagePageSize": { "type": "boolean", "description": "Use image width and height for PDF size. This property overrides PageSize, PageWidth, and PageHeight if image size is impossible to obtain when PageSize, PageWidth, and PageHeight is used.", "default": false, "x-ca-featured": false, "x-ca-label": "Use image page size", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Convert SVG files to PDF while preserving crisp, scalable vector quality. Control page size and orientation, explicit width/height, horizontal and vertical alignment, background color, and whether to use the image’s intrinsic page size. Ideal for print‑ready exports, sharing, archiving, and embedding in documents and workflows. Output remains vector where possible for small files and sharp rendering.", "x-ca-meta-title": "SVG to PDF Conversion API – Vector to PDF.", "x-ca-meta-description": "Convert SVG to PDF via API. Preserve vector quality and control page size, orientation, background, alignment, and dimensions.", "x-ca-source-formats": "svg", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "image", "pdf" ] } }, "components": { "schemas": { "fileId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "Uploaded File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "error": { "type": "object", "properties": { "Code": { "type": "integer", "description": "Error message code", "format": "int32", "example": 4000 }, "Message": { "type": "string", "description": "Error message text", "example": "Parameter validation error." } }, "externalDocs": { "url": "https://www.convertapi.com/doc/response-codes" } } }, "responses": { "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "415": { "description": "File type error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "500": { "description": "Conversion failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Conversion rate limit error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "parameters": { "fileId": { "name": "fileId", "in": "path", "description": "File ID", "required": true, "schema": { "$ref": "#/components/schemas/fileId" } }, "src": { "name": "src", "in": "path", "description": "Source file format (docx, pdf, jpg etc.)", "required": true, "schema": { "type": "string" } }, "dst": { "name": "dst", "in": "path", "description": "Destination file format (docx, pdf, jpg etc.)", "required": true, "schema": { "type": "string" } } }, "headers": { "content-disposition": { "description": "File information ([docummentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition))", "schema": { "type": "string" } }, "file-name": { "description": "File name", "schema": { "type": "string" } }, "file-ext": { "description": "File name extension", "schema": { "type": "string" } }, "file-size": { "description": "File size", "schema": { "type": "integer" } } }, "securitySchemes": { "secret": { "type": "http", "description": "[Get `Secret`](https://www.convertapi.com/a/secret)", "scheme": "bearer" }, "token": { "type": "http", "description": "[Get `Token`](https://www.convertapi.com/a/api-tokens)", "scheme": "bearer" }, "jwt": { "type": "http", "description": "[Get `JWT`](https://www.convertapi.com/a/jwt-tokens)", "scheme": "bearer", "bearerFormat": "JWT" } } }, "tags": [ { "name": "Conversion", "description": "File Conversion API call", "externalDocs": { "description": "File Conversion related operations", "url": "https://www.convertapi.com/doc/content-types" } }, { "name": "File Server", "description": "ConvertAPI temporary file storage", "externalDocs": { "description": "File Server related operations", "url": "https://www.convertapi.com/doc/upload" } }, { "name": "User", "description": "API User", "externalDocs": { "description": "API User related operations", "url": "https://www.convertapi.com/doc/user" } } ], "externalDocs": { "description": "Find out more about ConvertAPI", "url": "https://www.convertapi.com/doc" } }