Freelance Workspace

PdfBI API Documentation

Downloads remaining 

Clone report

Sync report

Export report

Export report status

Export report file

Default

Streamline your Power BI report exports with our cost-effective PDF Export API. Export Power BI reports to PDF without purchasing embedded capacity. Simple REST API integration, secure authentication, and scalable solution for automated report generation.

Power BI PDF Export API Documentation

Production

Sandbox

<p class="slate-p " >Welcome to the Power BI Export API documentation. This API provides a streamlined solution for exporting Power BI reports to PDF format without requiring your own Power BI Embedded capacity.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=success ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.77116 10.8968L5.72949 8.8551C5.60449 8.7301 5.45171 8.6676 5.27116 8.6676C5.0906 8.6676 4.93088 8.73705 4.79199 8.87594C4.6531 9.01482 4.58366 9.17455 4.58366 9.3551C4.58366 9.53566 4.6531 9.68844 4.79199 9.81344L7.33366 12.3551C7.45866 12.4801 7.60449 12.5426 7.77116 12.5426C7.93783 12.5426 8.08366 12.4801 8.20866 12.3551L13.2087 7.3551C13.3337 7.2301 13.3927 7.07732 13.3857 6.89677C13.3788 6.71621 13.3128 6.56344 13.1878 6.43844C13.0628 6.29955 12.9066 6.2301 12.7191 6.2301C12.5316 6.2301 12.3684 6.29955 12.2295 6.43844L7.77116 10.8968ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C11.0142 16.0843 12.6982 15.4072 14.0524 14.053C15.4066 12.6989 16.0837 11.0148 16.0837 9.00094C16.0837 6.98705 15.4066 5.30302 14.0524 3.94885C12.6982 2.59469 11.0142 1.9176 9.00033 1.9176C6.98644 1.9176 5.30241 2.59469 3.94824 3.94885C2.59408 5.30302 1.91699 6.98705 1.91699 9.00094C1.91699 11.0148 2.59408 12.6989 3.94824 14.053C5.30241 15.4072 6.98644 16.0843 9.00033 16.0843Z" fill="#06837A"></path></svg></div><div ><p class="slate-p " ><span style="color:rgba(255, 255, 255, 0.84)">Please email info@pdfbi.com with any feature requests or questions regarding the documentation. PdfBI does receive continous development and we love hearing new ideas from our customers!</span></p></div></div><h3 class="slate-h3 " >Overview</h3><p class="slate-p " >Our service simplifies the Power BI PDF export process by handling the infrastructure requirements and capacity management on your behalf. Instead of setting up and maintaining your own Power BI Embedded capacity, you can leverage our pre-configured environment to perform report exports at a fraction of the cost.</p><p class="slate-p " ></p><h3 class="slate-h3 " >How It Works</h3><p class="slate-p " >The export process follows a simple workflow:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">After subscribing to our service, you authenticate with your Microsoft account, granting our API permission to interact with your Power BI resources.</div></li><li class="slate-li " ><div style="position:relative">Using your assigned API key, you can initiate the export process for any of your Power BI reports.</div><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Cloning your report to our managed workspace</div></li><li class="slate-li " ><div style="position:relative">Processing the export request</div></li><li class="slate-li " ><div style="position:relative">Delivering the final PDF file</div></li></ol></li></ol><p class="slate-p " ></p><h3 class="slate-h3 " >Key Benefits</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Cost-Effective</strong>: Eliminate the need for your own Power BI Embedded capacity</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Simple Integration</strong>: Straightforward REST API endpoints for all export operations</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Secure</strong>: Maintains separation between your workspace and our export environment</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Scalable</strong>: Handles multiple concurrent export requests efficiently</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Long Lived Tokens: </strong>Token are long lasting preventing the need for complex refresh token logic</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Prerequisites</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">An active subscription to our service</div></li><li class="slate-li " ><div style="position:relative">Microsoft Power BI access with reports you wish to export</div></li><li class="slate-li " ><div style="position:relative">Your unique API key (provided upon subscription)</div></li></ul><p class="slate-p " ></p><p class="slate-p " >The following sections detail the specific endpoints, authentication requirements, and example implementations to help you integrate our API into your applications.</p>

Welcome to the Power BI Export API documentation. This API provides a streamlined solution for exporting Power BI reports to PDF format without requiring your own Power BI Embedded capacity.

Our service simplifies the Power BI PDF export process by handling the infrastructure requirements and capacity management on your behalf. Instead of setting up and maintaining your own Power BI Embedded capacity, you can leverage our pre-configured environment to perform report exports at a fraction of the cost.

The export process follows a simple workflow:

The following sections detail the specific endpoints, authentication requirements, and example implementations to help you integrate our API into your applications.

<p class="slate-p " >Check how many downloads you have left this month, endpoint will return limit, used and remaining counts.</p><p class="slate-p " ></p>

Check how many downloads you have left this month, endpoint will return limit, used and remaining counts.

Accept

Your API key provided during subscription


Authorization

<p class="slate-p " >Copies a report from the client&apos;s Power BI workspace to our service&apos;s managed workspace, enabling PDF export functionality.</p><p class="slate-p " ></p><h3 class="slate-h3 " >Usage Notes</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">The cloned report is stored in our managed workspace and is used solely for PDF export operations</div></li><li class="slate-li " ><div style="position:relative">The original report in your workspace remains unchanged</div></li><li class="slate-li " ><div style="position:relative">Cloned reports are automatically managed by our system and do not count against your Power BI capacity</div></li><li class="slate-li " ><div style="position:relative">Subsequent export operations will use this cloned version of your report</div></li></ul><p class="slate-p " ></p>

Copies a report from the client's Power BI workspace to our service's managed workspace, enabling PDF export functionality.

Your API key provided during subscription

The ID of your Power BI workspace containing the source report

WORKSPACE_ID

REPORT_ID

<p class="slate-p " >Synchronizes changes from your original Power BI report to its cloned version in our managed workspace. This ensures that your exported PDFs reflect the latest updates made to your report.</p><p class="slate-p " ></p><h3 class="slate-h3 " >Usage Notes</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Use this endpoint when you&apos;ve made changes to your original report and need to update the cloned version</div></li><li class="slate-li " ><div style="position:relative">The sync operation creates a new clone of your report, replacing the previous version</div></li><li class="slate-li " ><div style="position:relative">Any in-progress exports will continue using the version of the report that was active when they started</div></li><li class="slate-li " ><div style="position:relative">New export requests will use the newly synchronized version</div></li><li class="slate-li " ><div style="position:relative">We recommend syncing only when necessary to maintain optimal performance. </div></li><li class="slate-li " ><div style="position:relative">Sync abuse make get your subscription cancelled.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Best Practices</h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Sync your report only after making significant changes that need to be reflected in exports</div></li><li class="slate-li " ><div style="position:relative">Avoid unnecessary sync operations as they consume system resources</div></li><li class="slate-li " ><div style="position:relative">Ensure all exports are completed before initiating a sync if you need to maintain consistency</div></li><li class="slate-li " ><div style="position:relative">Check the sync status response to confirm successful completion before initiating new exports</div></li></ol><p class="slate-p " ></p>

Synchronizes changes from your original Power BI report to its cloned version in our managed workspace. This ensures that your exported PDFs reflect the latest updates made to your report.

The ID of your original report that needs to be synced

<p class="slate-p " >Initiates a PDF export of a previously cloned Power BI report from our managed workspace. This endpoint starts the export process and returns an export ID for tracking the status.</p><p class="slate-p " >Works in the same way the Power BI REST API - Export to File endpoint works (<a href="https://learn.microsoft.com/en-us/rest/api/power-bi/reports/export-to-file" target="_self">https://learn.microsoft.com/en-us/rest/api/power-bi/reports/export-to-file</a>)</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >This endpoint may take up to 20 seconds to return a response initially due to waiting for the MS embedded capacity to start. An async endpoint is in development allowing you to instantly receive a response and then use the status endpoint to check the status of the download.</p></div></div><h3 class="slate-h3 " >Usage Notes</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">The export process is asynchronous - use the returned exportId to check status</div></li><li class="slate-li " ><div style="position:relative">Exports are processed in the order they are received</div></li><li class="slate-li " ><div style="position:relative">The report must have been previously cloned to our managed workspace</div></li><li class="slate-li " ><div style="position:relative">Export times vary based on report complexity and system load</div></li><li class="slate-li " ><div style="position:relative">Exported files are temporarily stored for 24 hours before automatic deletion</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Best Practices</h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Store the exportId returned by this endpoint for subsequent status checks</div></li><li class="slate-li " ><div style="position:relative">Implement appropriate retry logic for checking export status</div></li><li class="slate-li " ><div style="position:relative">Export during off-peak hours for faster processing when possible</div></li></ol><p class="slate-p " ></p>

Initiates a PDF export of a previously cloned Power BI report from our managed workspace. This endpoint starts the export process and returns an export ID for tracking the status.

Works in the same way the Power BI REST API - Export to File endpoint works (

As mentioned on https://pdfbi.com we only support one sematic model (dataset) per report, this is due to a limitation when cloning report via the Power BI REST API. This is why this endpoint only accepts a single identity, it also does not accept any `dataset` ids as it will automatically use the one associated to the report when it was cloned.
https://learn.microsoft.com/en-us/rest/api/power-bi/reports/export-to-file#effectiveidentity

identity

The ID of the cloned report in our managed workspace

<p class="slate-p " >Retrieves the current status of a Power BI report export operation. Use this endpoint to track the progress of your export request and determine when the PDF is ready for download.</p><p class="slate-p " ></p><h3 class="slate-h3 " >Usage Notes</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Poll this endpoint at reasonable intervals (e.g., every 5-10 seconds) to check export status</div></li><li class="slate-li " ><div style="position:relative">Export results are available for 24 hours after completion</div></li><li class="slate-li " ><div style="position:relative">Failed exports include additional error details in the response</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Best Practices</h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Handle all possible status values in your code</div></li><li class="slate-li " ><div style="position:relative">Monitor percentComplete for progress tracking</div></li><li class="slate-li " ><div style="position:relative">Check for expired exports (410 Gone) and handle appropriately</div></li></ol><p class="slate-p " ></p>

Retrieves the current status of a Power BI report export operation. Use this endpoint to track the progress of your export request and determine when the PDF is ready for download.

The ID of the export operation returned by the export initiation endpoint

EXPORT_ID

<p class="slate-p " >Downloads the generated PDF file for a completed Power BI report export. This endpoint provides access to the final exported file once the export process has finished successfully.</p><p class="slate-p " ></p><h3 class="slate-h3 " >Usage Notes</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Only access this endpoint after confirming the export status is &quot;completed&quot;</div></li><li class="slate-li " ><div style="position:relative">Files are available for download for 24 hours after export completion</div></li><li class="slate-li " ><div style="position:relative">Each successful download request streams the complete PDF file</div></li><li class="slate-li " ><div style="position:relative">Large files may require appropriate timeout settings in your client</div></li><li class="slate-li " ><div style="position:relative">The filename includes a timestamp for easy identification</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Best Practices</h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Always verify export completion before attempting download</div></li><li class="slate-li " ><div style="position:relative">Implement appropriate error handling for large file downloads</div></li><li class="slate-li " ><div style="position:relative">Consider implementing retries for network interruptions</div></li></ol><p class="slate-p " ></p>

Downloads the generated PDF file for a completed Power BI report export. This endpoint provides access to the final exported file once the export process has finished successfully.

Sections