Resources
Request, rate, credit, and trace headers.
| Header | Direction | Meaning |
|---|---|---|
X-RailCore-Key | Request | The API key. Required, unless it is sent in Authorization or X-Api-Key instead |
Authorization | Request | Bearer <key>: the API key, as an alternative to X-RailCore-Key |
X-Api-Key | Request | The API key, as an alternative to X-RailCore-Key. Two key headers with different keys answer 401 AMBIGUOUS_API_KEY |
X-RailCore-Timestamp | Request | Unix seconds; required on Growth, Scale and Enterprise keys |
X-RailCore-Nonce | Request | Unique replay-protection token; required on Growth, Scale and Enterprise keys |
X-RailCore-Signature | Request | Base64 HMAC-SHA256 signature; required on Growth, Scale and Enterprise keys |
X-RailCore-Request-ID | Response | Support and request-log identifier |
X-RailCore-Trace-ID | Response | Distributed trace identifier |
X-RailCore-Plan | Response | Plan applied to the request |
X-RailCore-RateLimit-Limit | Response | The account's per-minute budget, shared by all its keys. Sent only when the plan has a per-minute limit. |
X-RailCore-RateLimit-Remaining | Response | Requests left in the account's current minute. Sent only when the plan has a per-minute limit. |
X-RailCore-RateLimit-Reset | Response | Minute reset Unix time. Sent only when the plan has a per-minute limit. |
X-RailCore-RateLimit-Day-Limit | Response | The account's daily request budget, per IST day. Sent only on keys with a daily cap (Free). |
X-RailCore-RateLimit-Day-Remaining | Response | Daily requests left. Sent only on keys with a daily cap (Free). |
X-RailCore-RateLimit-Day-Reset | Response | Daily reset Unix time. Sent only on keys with a daily cap (Free). |
X-RailCore-Credits-Cost | Response | What this request counted as (one credit is one request) |
X-RailCore-Credits-Remaining | Response | Requests left on the account |
X-RailCore-Confidence | Response | high, medium, or low live-data confidence. A finished run whose arrival at its last station was reported is high |
Server-Timing | Response | Where the request spent its time, in milliseconds: stages such as key, limits, credits and upstream in the order they ran, then total. Sent on every response |
Retry-After | Response | Seconds to wait before retrying a 429 or a 503 |
Deprecation | Response | When the path stopped answering API keys, as @ and Unix seconds (RFC 9745). Sent only with 410 ENDPOINT_RETIRED, from a retired path. |
Sunset | Response | The same moment as an HTTP date (RFC 8594). Sent only with 410 ENDPOINT_RETIRED, from a retired path. |
Link | Response | The path to use instead (rel="successor-version") and the changelog entry (rel="deprecation"). Sent only with 410 ENDPOINT_RETIRED, from a retired path. |
X-RailCore-Webhook-Id | Webhook | The job_id, on a job's callback to your callback_url |
X-RailCore-Webhook-Timestamp | Webhook | Unix seconds when this send was signed |
X-RailCore-Webhook-Attempt | Webhook | Which send this is, 1 to 4 |
X-RailCore-Webhook-Signature | Webhook | v1= and the hex HMAC-SHA256 of the timestamp, a period and the raw body, with the job's webhook_secret |
Retired paths
Webhook headers
Browser visibility
Last updated