HomeUsing the Platform API

Platform API Reference

Collections

MethodDescription
collections.addDocThis method adds a document to an existing collection. Will return a blank OK response object if successful.
collections.createThis method creates a new collection. Will return an OK response collection_id and collection_type.
collections.updateThis method updates a new collection's name, description or privacy_type. Will return an OK response collection_id and changed attributes and their corresponding values.
collections.deleteThis method deletes new collection. Will return a blank OK response object if successful.
collections.getListThis method retrieves a list of collections for a given user.
collections.removeDocThis method removes a document from an existing collection. Will return a blank OK response object if successful.
collections.listDocsThis method retrieves a list of documents in a given collection.

Docs

MethodDescription
docs.uploadThis method accepts the document file via Multi-Part POST.
docs.uploadFromUrlThis method retrieves the document file from the specified URL.
docs.getListThis method retrieves a list of documents for a given user.
docs.getConversionStatusThis method retrieves the conversion status of the document.
docs.getSettingsThis method retrieves the meta-data for existing documents.
docs.changeSettingsThis method updates the meta-data for existing documents. Only send arguments for fields you would like to overwrite. Will return a blank response object if succesful
docs.getDownloadUrlThis method returns a link you can use to download a static version of a document.
docs.getStatsThis method retrieves statistics of the document.
docs.deleteThis method deletes an existing document. Will return a blank OK response object if successful.
docs.searchThis method searches for the specified query in the public documents on Scribd.com. Private documents are not searchable.
docs.getCategoriesThis method returns a list of categories or subcategories.
docs.browseThis method returns a list of documents that meet filter criteria.
docs.uploadThumbThis method accepts a document thumbnail file via Multi-Part POST.

Thumbnail

MethodDescription
thumbnail.getThis method retrieves a URL to the thumbnail of a document, in a given size. Note that docs.getSettings and docs.getList also retrieve thumbnail URLs in default size - this method is really for resizing those. IMPORTANT - it is possible that at some time in the future, Scribd will redesign its image system, invalidating these URLs. So if you cache them, please have an update strategy in place so that you can update them if neceessary.

User

MethodDescription
user.loginThis method allows your API application to sign in as an existing Scribd user, executing methods as that user.
user.signupThis method allows your API application to signup a new Scribd user. If the signup is successful, your application will be passed back a session key which will allow you to execute methods on behalf of the new user.
user.getAutoSigninUrlThis method returns a URL that, when visited, will automatically sign in the given user account and then redirect to the URL you provide. The URL expires after 7 days.