Crocodoc's free API has a rate limit of two simutaneous conversions. To have rate limiting removed, contact support@crocodoc.com.

Arguments

• &url={URL}

  Required if no file is uploaded. Location of the file to be fetched and converted.

• &file={uploaded file}

  Required if no url is provided. File should be uploaded using a multipart POST request (detail below).

• &title={title}

  (optional) title of the document

• &async={boolean}

  (optional) When in async mode, a response is returned before conversion begins. default:false

• &private={boolean}

  (optional) private documents can only be accessed by owners or via sessions. default:false

• &token={API token}

  (required)

Example Response

Results are returned using JSON syntax. If the request was successful:

{"shortId": "yQZpPm", "uuid": "8e5b0721-26c4-11df-b354-002170de47d3"}

If an error occurred:

{"error": "conversion error"}

The following errors may occur: invalid params, invalid token, invalid url, invalid filetype, password protected, rate limited, conversion error, and error.

Uploading via POST

The following unix command uploads a file to Crocodoc via a multipart POST request. To submit POST requests using Python, it is recommended that you use this code snippet. For PHP, please view this example. For help with multipart POST requests in other languages, feel free to contact support@crocodoc.com.

curl -F "file=@example.pdf" -F "token={API token}" -F "title=Example PDF" https://personal.crocodoc.com/api/v1/document/upload

Arguments

• &uuids={list of uuids}

  (required) a comma-deliminated list of uuids.

• &token={API token}

  (required)

Example Request

https://personal.crocodoc.com/api/v1/document/status?uuids=8e5b0721-26c4-11df-b354-002170de47d3,b54adc00-67f9-11d9-9669-0800200c9a66&token=

Example Response

[{"uuid": "8e5b0721-26c4-11df-b354-002170de47d3", status: "QUEUED", viewable: false},
{"uuid": "b54adc00-67f9-11d9-9669-0800200c9a66", status: "AVAILABLE", viewable: true}]

The following document statuses may be returned: "QUEUED", "CONVERTING", "AVAILABLE", "ERROR".
Crocodoc allows users to view partially converted documents. Even if a document's status is "CONVERTING", a document is viewable as soon as the "viewable" flag is true.

Web Hooks

Web hooks are available for high-volume API users. Web hooks allow us to notify your servers as soon as a document's conversion status changes. Email support@crocodoc.com for more information.

Arguments

• &uuid={uuid}

  (required) uuid of the document to be deleted

• &token={API token}

  (required)

Example Response

If the request was successful:

true

If an error occurred:

{"error": "invalid uuid"}

Arguments

• &uuid={uuid}

  (required) uuid of the document to be downloaded

• &annotated={boolean}

  (optional) Should the document include annotations? default: false. (Note: image support not yet available)

• &token={API token}

  (required)

Example Use

wget "https://personal.crocodoc.com/api/v1/document/download?uuid=08a7c925-e137-44ab-ab2d-ebe62edfaec8&token="

Arguments

• &uuid={uuid}

  (required) uuid of the document to be downloaded

• &editable={boolean}

  (optional) Can users markup the shared document? default: true.

• &token={API token}

  (required)

Example Response

{"shortId": "y1O7rK" }

Arguments

• &uuid={uuid}

  (required) uuid of the document to be cloned

• &token={API token}

  (required)

Example Response

{"shortId": "yQZpPm", "uuid": "8e5b0721-26c4-11df-b354-002170de47d3"}

Example request

Arguments

• &uuid={uuid}

  (required) uuid of the document to be viewed

• &token={API token}

  (required)

• &downloadable={boolean}

  (optional) enables document downloads. default: true

• &editable={boolean}

  (optional) Can users markup the document? default: true

• &name={name}

  (optional) name of the person viewing the document.

• &admin={boolean}

  (optional) Admins can delete any user's annotations. default: false

Example Response

{"sessionId": "fgH9qWEwnsJUeB0" }

Example Document

The following iframe is set to this URL: http://personal.crocodoc.com/demo?embedded=true

Tip: Add the following CSS rule to show a spinner while the iframe loads.

iframe { background:url(//personal.crocodoc.com/media/images/docviewer/spinner.gif) no-repeat center; }

Example Session

http://personal.crocodoc.com/view/?sessionId=fgH9qWEwnsJUeB0

Arguments

Arguments should be passed in when creating session IDs.