Steps to Test the Documents API Reference Pages

The following page describes the steps to test Documents API Reference.

To upload a document to the repository:

  1. Select the Base URL based on your region.

  2. Enter the SID in the SID field.

  3. Select the file to upload. You can either upload a file from your local drive or from the network drive.

  4. Enter the API-Key in the api-key field.

  5. Click on the Try It! button in the CURL REQUEST window.

    A sample API Reference page is shown below.

The file gets uploaded into the repository.

The Success response is shown in the Response window.

To list all documents:

  1. Select the Base URL based on your region.
  2. Enter the SID in the SID field.
  3. Enter the API-Key in the api-key field.
  4. Click Try It!.

All the documents' details are shown in the Response window.

To Delete a ocument from the repository:

  1. Select the Base URL based on your region.
  2. Enter the SID in the SID field.
  3. In the BODY PARAMS section:
    1. Click '+' in the Add Field section.
    2. Add 'id' in place of newKey.
    3. Add the document id of the document you want to delete in place New Value.
  4. Click Try It!.

The specified document is deleted from the repository.

To rename a document:

  1. Select the Base URL based on your region.
  2. Enter the SID in the SID field.
  3. In the BODY PARAMS section, you must specify the document id of the document you want to rename and enter the new title for the document.
    1. Click '+' in the Add Field section.
    2. Add 'id' in place of newKey.
    3. Add the document id of the document you want to delete in place New Value.
    4. Click '+' in the Add Field section to add another field.
    5. Add 'title' in place of newKey.
    6. Add the new title for the document in the New Value.
  4. Click Try It!.

The document that you specified is renamed to the new title.




© 2025 Kaleyra Inc. All rights reserved.
Trademarks, logos and service marks displayed on this site are registered and unregistered trademarks of Kaleyra Inc.