1ToolRing Docs Get a key
View as markdown
concepts/response-format

Every successful response uses one envelope:

{
  "data": { },
  "meta": { }
}
  • data is the payload (an object, an array, or a scalar).
  • meta is present for paginated or attributed responses (pagination, source attribution, cache info).

Errors use:

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Unknown catalog id"
  }
}

Headers

HeaderDirectionMeaning
Authorization: Bearer <key>requestThe credential.
X-ToolRing-CreditsresponseCredits actually charged for this call; 0 when nothing was charged.
X-ToolRing-Cacheresponsehit or miss.
X-ToolRing-Cache-AgeresponseAge of a cached answer, in seconds.
X-ToolRing-Max-AgerequestCaps the cache TTL for this call; 0 means do not cache.
X-ToolRing-TagrequestA k=v metadata bag; customer=<id> attributes spend to a per-tag budget.
X-ToolRing-Capability, -Route, -Source, -FailoverresponseWhich job, endpoint and source answered a routed toolring.<capability> call.

Dates

Dates use ISO 8601: YYYY-MM-DD for dates, YYYY-MM-DDTHH:mm:ssZ for timestamps.