API Documentation

The DriveBird Network API lets you programmatically manage your assets and other static resources using conventional HTTP requests. Any action that you can perform through the DriveBird Network Control Panel (except for creating access tokens and billing management) can also be performed with the API.

You need to use POST method and JSON object as raw body content to: https://www.drivebird.com/api for every request. There are no dedicated endpoints for each API. All APIs should be pointed to the above mentioned URL.

Response type is always JSON. No matter what, three keys will always be present.

Response master keys:
1. status (integer): By using status code you will know if your request was successful or error.
2. errors (numeric array): List of errors string if occurred else empty.
3. data (object): All relative data as a response of your request.

Example:

{
    "status": 200,
    "errors": [],
    "data": {
        "msg": "The asset has been uploaded",
        "url": "https://cdn.drivebird.com/storage/user-id/bucket-name/20220103-161644-632-file-name.jpg"
    }
}
            

The status is a numeric number which represents the result-type of the API call. This is the same as HTTP Status Code.

For more details about the code visit RestAPITutorial.

The status can be divide into two section. One is common and other one is request (application) specific. Please see below for common status codes. Application specific code status can be found on application API page.

For more details about the code visit RestAPITutorial website.

Paste the payload JSON body and hit submit button.

The response will be displayed here.

Functionality available through the API, allowing you to script the complex actions that your situation requires.

                            {
                                "model":"Example",
                                "method":"demo",
                                "arg":{

                                }
                            }
                            

                            {
                                "model":"ChatBot",
                                "method":"textExchange",
                                "arg":{
                                    "text":"hi"
                                }
                            }
                            

Need more APIs? Having difficulties to call API? I am here to help.