Response Format

All EDS API responses follow a consistent structure to make error handling and data parsing predictable for client developers.

Success Response

When a request is successful, the response will have success: true and the requested data in the data field.

{
  "success": true,
  "data": {
    "id": "clx123abc",
    "name": "project-files"
  },
  "error": null
}

Error Response

When a request fails, the response will have success: false, the data field will be null, and the error field will contain a descriptive message.

{
  "success": false,
  "data": null,
  "error": "Missing or invalid 'filename'"
}

Schema Definition

interface APIResponse<T> {
  success: boolean;
  data: T | null;
  error: string | null;
}

HTTP Status Codes

EDS uses standard HTTP status codes in addition to the success boolean in the body.

Next Steps