Skip to main content

Standard Response Structure

All ScriptBase endpoints return JSON with a consistent structure.

Success Response

{
  "success": true,
  "data": {
    // Endpoint-specific data
  },
  "meta": {
    "creditsUsed": 2,
    "creditsRemaining": 998,
    "rateLimit": {
      "limit": 10,
      "remaining": 59,
      "resetAt": 1704326400
    }
  }
}

Error Response

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error description",
    "details": {
      // Optional additional context
    }
  }
}

Response Fields

Top-Level Fields

FieldTypeAlways PresentDescription
successbooleanYestrue for success, false for errors
dataobjectSuccess onlyThe requested data
errorobjectError onlyError information
metaobjectSuccess onlyMetadata about the request

Meta Object

The meta object provides information about credit usage and rate limits:
{
  "creditsUsed": 2,
  "creditsRemaining": 998,
  "rateLimit": {
    "limit": 60,
    "remaining": 59,
    "resetAt": 1704326400
  }
}
FieldTypeDescription
creditsUsednumberCredits consumed by this request
creditsRemainingnumberCredits left in your quota after this request
rateLimit.limitnumberTotal requests allowed per minute
rateLimit.remainingnumberRequests remaining in current window
rateLimit.resetAtnumberUnix timestamp when rate limit resets

Content Type

All responses use application/json content type:
Content-Type: application/json

Status Codes

See Error Reference for complete status code documentation.
CodeMeaning
200Success
202Accepted (async job created)
400Bad Request
401Unauthorized
404Not Found
429Rate Limit Exceeded
500Internal Server Error