REST API

Access Syncello tools programmatically via HTTP. Execute tools directly from your applications, scripts, or automation workflows.

Base URL

https://api.syncello.io/v1

Quick Example

curl -X POST https://api.syncello.io/v1/tools/tape/listWorkspaces \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json"

Request Format

All tool execution requests follow a consistent format:

• Method: POST
• Path: /v1/tools/{platform}/{toolName}
• Headers: Authorization (Bearer token), Content-Type (application/json)
• Body: JSON object with tool parameters

Response Format

Responses are JSON objects with the following structure:

{
  "success": true,
  "data": {
    // Tool-specific response data
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMETER",
    "message": "workspace_id is required"
  }
}

Available Endpoints

Rate Limits

API requests are rate limited per user:

Next Steps

• Authentication - Learn about JWT tokens
• Tool Execution - Detailed request/response examples
• Tools Reference - Browse all available tools