Upload Status API Overview

What is the ClearSlide Upload Status API?

The Upload Status API allows you to receive status updates for the file you have uploaded to ClearSlide.

🚧

Prerequisites

When you complete Prerequisites in ClearSlide APIs section, you will have an Authorization Token to test against our API.

How to generate Upload Status API request code?

You can generate a complete functional request code snippet for the tech stack of your choice.

You can interactively add Headers and Query parameters (including filters and sorting) into the form. The documentation tool updates API request code accordingly.

Developers can copy and paste the auto-generated API request code into your project.

How do I test the Upload Status API request code?

Here are a few options:

• Try it out allows you to trigger a request and view JSON results immediately
• Copy the request code snippet into your project. Trigger the request and parse the response to view the results in a JSON format

Sample Request Code

curl -X GET "https://platform.clearslide.com/v2/upload/KFDC4FNLU5TDZEYW2MZN" -H  "accept: application/vnd.api+json" -H  "authorization: Bearer 940a1464-fbbf-43e2-b683-1c8eb3a2552c"

Sample JSON Response

If the uploadID provided in the request is invalid or the file is still being uploaded, you will see the following response on checking the upload status:

{
    "included": [], 
    "data": {
        "relationships": {}, 
        "attributes": {
            "status": "UNKNOWN_ID", 
            "uploadType": "doc", 
            "hasRichContent": false, 
            "isError": false, 
            "isComplete": false
        }, 
        "type": "upload", 
        "id": "UNKNOWN_ID", 
        "links": {
            "self": "/upload/UNKNOWN_ID"
        }
    }
}

If the file has been successfully uploaded, then the expected response of the Upload Status API is:

{
    "included": [], 
    "data": {
        "relationships": {}, 
        "attributes": {
            "status": "Complete", 
            "uploadType": "doc", 
            "isComplete": true, 
            "hasRichContent": false, 
            "isError": false, 
            "deckName": "test.png", 
            "deckVID": "664Z45KWA4RW9FHWE22P"
        }, 
        "type": "upload", 
        "id": "Y5N9427MTZHUU4FVU9T3", 
        "links": {
            "self": "/upload/Y5N9427MTZHUU4FVU9T3"
        }
    }
}