Account

Queries account information, quota limits, current usage and API key expiration.

APIDescription
GET api/Account/{apikey}

Retrieves quota limits and the current usage.

Converter

Direct Converter (requires API key). Waits until the document has been converted. It can take a long time for the conversion to complete. Please consider using the Asynchronous Converter to avoid HTTP specific timeouts.

APIDescription
POST api/Converter/{apikey}/{filename}

Directly converts an .OXPS or .XPS file and returns the download URL of the converted .PDF file (or an error). It can take up to several minutes for the conversion to complete depending on server load. Please consider using the Asynchronous Converter to avoid HTTP specific timeouts.

ConverterAsync

Asynchronous Converter (requires API key). Returns a job ticket for each conversion. In order to check the current conversion status please use the Sessions API.

APIDescription
GET api/ConverterAsync/{apikey}/{ticket}

Gets the download URL of the converted .PDF file for a given job ticket. Please use the Sessions API in order to check the current conversion status.

POST api/ConverterAsync/{apikey}/{filename}

Uploads an .OXPS or .XPS file and returns the associated job ticket.

PublicSessions

Sessions API which can be used without providing a customer specific API key. These sessions are bound to the calling IP address.

APIDescription
GET api/PublicSessions

Gets a list of all recent conversion jobs. The current session is determined by the IP address of the invoking HTTP request.

GET api/PublicSessions/{ticket}

Gets the conversion status of a specific job.

Sessions

Sessions API for customer specific conversions (requires API key).

APIDescription
GET api/Sessions/{apikey}

Gets a list of all recent conversion jobs.

GET api/Sessions/{apikey}/{ticket}

Gets the conversion status of a specific job.