API Endpoints

Check API status

Changed on

Check API availability and validate authentication token.

This endpoint can be used to:

  • Verify that your authentication token is valid
  • Check API connectivity without performing any heavy operations
  • Identify which drive (workspace) your token is connected to

Returns the connected drive ID and name, plus the API version.

get/status

Request

  • Base URL: https://descriptapi.com/v1
  • URL: https://descriptapi.com/v1/status
  • Auth: HTTP bearer

Response

Token is valid and API is available

drive_idstring uuid nullable required

The drive ID associated with the authentication token, or null if the token has no associated drive

drive_namestring nullable required

Human-readable name of the connected drive (workspace), or null if unavailable

api_versionstring required

Current API version

Example response

{
  "drive_id": "c9c5c47e-158a-49f7-846b-4f6ee2a229a2",
  "drive_name": "My Team Workspace",
  "api_version": "1.2"
}

Changes

  • 04c0005aef70Revision changes
    • breaking

      removed the required property from the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status