Accelerate third-party API endpoints using…

What it does

Accelerate third-party API endpoints using an edge Redis caching layer with custom TTL and hit metrics

Request

Body

Field	Type	Required	Description
`body`	string \| object	no	Optional payload for POST/PUT/PATCH requests
`forceRefresh`	boolean	no	Force a cache miss and re-fetch fresh data from the target upstream server
`headers`	object	no
`method`	enum	no	One of: GET, POST, PUT, DELETE, PATCH.
`targetUrl`	string	yes
`timeout`	integer	no
`ttlSeconds`	integer	no	Time-To-Live in seconds for cached response (Default: 300s / 5m, Max: 86400s / 24h)
`varyHeaders`	array<string>	no	List of request header names to include in cache key generation (e.g., ["Authorization", "Accept-Language"])

Example request

{
  "body": "Hello from castomAPI.",
  "forceRefresh": false,
  "headers": {},
  "method": "GET",
  "targetUrl": "https://example.com/page",
  "timeout": 10000,
  "ttlSeconds": 300,
  "varyHeaders": []
}

Response

Field	Type	Description
`cache`	object
`↳ cacheKey`	string
`↳ cachedAt`	string
`↳ hit`	boolean
`↳ ttlRemainingSeconds`	integer
`↳ ttlSeconds`	integer
`contentType`	string
`data`	object \| array \| string
`executionTimeMs`	integer
`headers`	object
`status`	string
`statusCode`	integer
`targetUrl`	string
`tokensDeducted`	integer

Example response

{
  "cache": {
    "cacheKey": "example",
    "cachedAt": "<cached at>",
    "hit": true,
    "ttlRemainingSeconds": 3600,
    "ttlSeconds": 3600
  },
  "contentType": "application/pdf",
  "data": {},
  "executionTimeMs": 6,
  "headers": {
    "key": "example"
  },
  "status": "success",
  "statusCode": 200,
  "targetUrl": "https://example.com/page",
  "tokensDeducted": 1
}

Errors

Every error answers with the same envelope: an HTTP status, a machine code and a sentence.

`400`	The body or a parameter failed validation. The details array names the field.
`401`	No key, a revoked key or a wrong header. Send x-api-key.
`402`	The wallet cannot cover this call. Top up or wait for the monthly grant.
`404`	The resource does not exist, or it is not yours. Both answer identically and cost nothing.
`429`	Over the per-minute quota of your tier. Back off and retry.
`5xx`	Upstream refused or timed out. The call is not billed.

Code

curl -X POST 'https://app.castomapi.com/v1/proxy/cache-accelerator' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"body": "Hello from castomAPI.", "forceRefresh": false, "headers": {}, "method": "GET", "targetUrl": "https://example.com/page", "timeout": 10000, "ttlSeconds": 300, "varyHeaders": []}'

const res = await fetch('https://app.castomapi.com/v1/proxy/cache-accelerator', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"body": "Hello from castomAPI.", "forceRefresh": false, "headers": {}, "method": "GET", "targetUrl": "https://example.com/page", "timeout": 10000, "ttlSeconds": 300, "varyHeaders": []})
});
const data = await res.json();
console.log(data);

import { request } from 'node:https';

// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/proxy/cache-accelerator', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"body": "Hello from castomAPI.", "forceRefresh": false, "headers": {}, "method": "GET", "targetUrl": "https://example.com/page", "timeout": 10000, "ttlSeconds": 300, "varyHeaders": []})
});
const data = await res.json();
console.log(data);

import requests

res = requests.post(
    'https://app.castomapi.com/v1/proxy/cache-accelerator',
    headers={'x-api-key': '<your-api-key>'},
    json={"body": "Hello from castomAPI.", "forceRefresh": False, "headers": {}, "method": "GET", "targetUrl": "https://example.com/page", "timeout": 10000, "ttlSeconds": 300, "varyHeaders": []},
    timeout=30,
)
print(res.json())

<?php
$ch = curl_init('https://app.castomapi.com/v1/proxy/cache-accelerator');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode(['body' => 'Hello from castomAPI.', 'forceRefresh' => false, 'headers' => [], 'method' => 'GET', 'targetUrl' => 'https://example.com/page', 'timeout' => 10000, 'ttlSeconds' => 300, 'varyHeaders' => []]),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);

Cost and limits

This operation costs 1 token. A call that fails is never billed. Every account gets 1000 free tokens a month; paid balances never expire.

Rate limits per minute

No key	10
Free	60
Pro	300
Enterprise	1200

Docs → Pricing

Questions

What does Accelerate third-party API endpoints using an edge Redis caching layer cost?

1 token per successful call, debited from your wallet after the response. Failed calls are free. Every account receives 1000 free tokens a month.

How do I authenticate?

Send your key in the x-api-key header. One key covers every metered endpoint; there is nothing to enable per endpoint.

Can I send an Authorization: Bearer token instead?

Not for a metered endpoint — those take the x-api-key header and nothing else. Bearer tokens belong to the account side: the dashboard and account APIs accept a JWT session, and castomapi-auth issues those through a standard OAuth2 handshake, with authorization code, client credentials and refresh grants. The auth service page covers it.

What are the limits?

10 requests a minute per IP with no key at all, 60 a minute on the free tier, 300 on Pro, 1200 on Enterprise. Above the no-key tier the quota is per account, across every endpoint.

OpenAPI: https://app.castomapi.com/docs/json

Request

Response

What it does

Request

Body

Example request

Response

Example response

Errors

Code

Cost and limits

Rate limits per minute

Questions

More in Proxy

Where it fits