HomeUsing the Platform APIPlatform API Reference


This method retrieves the conversion status of the document.


api_keystring(required)API key assigned to your account.
api_sigstring(optional)MD5 hash of the active request and your secret key. This is an optional security measure. See the signing documentation for more info.
session_keystring(optional)A session key for a signed in user. If this parameter is provided, your application will carry out actions on behalf of the signed in user corresponding to the session key. Otherwise, your application will carry out actions on behalf of the user account associated with the API account. See the authentication documentation for more information
my_user_idstring(optional)This parameter is intended for sites with their own user authentication system. You can create phantom Scribd accounts that correspond to your users by simply passing the unique identifier you use to identify your own user accounts to my_user_id. If you pass this parameter to an API method, the API will act as if it were executed by the phantom user corresponding to my_user_id. See the authentication documentation for more information.

Sample return XML

<?xml version="1.0" encoding="UTF-8"?><rsp stat="ok"><conversion_status>PUBLISHED</conversion_status></rsp>

Result explanation

conversion_status["DISPLAYABLE", "DONE", "ERROR", "PROCESSING"]When documents are uploaded, they are initially in the PROCESSING state. When the iPaper is ready to be displayed, they enter the DISPLAYABLE state. At the the DISPLAYABLE stage, the iPapers can be rendered, but the documents are not search indexed and the download calls may not work. Once the processing is finished, the document enters the DONE state. If the processing fails, which can occur for many reasons, the document will be in the ERROR state.

Error codes

500Internal Server Error. Scribd has been notified about this problem.
601Required parameter missing
611Insufficient permissions to access this document
612Document could not be found
619Document has been deleted

Back to Platform API Reference