Refresh cached sources by responseId

Invalidates the cache for a specific source by responseId. This is useful when sources have expired or changed.

Behavior:

• Immediately invalidates cache for the given responseId
• Next request for the same content will perform a fresh scrape
• Returns simple OK status on success
• responseId format: UUID v4 (alphanumeric with hyphens/underscores, max 128 chars)

GET /v1/refresh/{responseId}

Refresh cached sources

JavaScript

const options = {method: 'GET'};

fetch('https://api.example.com/v1/refresh/{responseId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request GET \
  --url https://api.example.com/v1/refresh/{responseId}

import requests

url = "https://api.example.com/v1/refresh/{responseId}"

response = requests.get(url)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/refresh/{responseId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/refresh/{responseId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/v1/refresh/{responseId}")
  .asString();

200

{
  "status": "OK"
}

{
  "error": {
    "code": "INVALID_TMDB_ID",
    "message": "TMDB ID must be numeric",
    "details": {
      "parameter": "id",
      "value": "not-a-number",
      "expected": "numeric string"
    }
  },
  "traceId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
}

{
  "error": {
    "code": "INVALID_TMDB_ID",
    "message": "TMDB ID must be numeric",
    "details": {
      "parameter": "id",
      "value": "not-a-number",
      "expected": "numeric string"
    }
  },
  "traceId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
}

{
  "error": {
    "code": "INVALID_TMDB_ID",
    "message": "TMDB ID must be numeric",
    "details": {
      "parameter": "id",
      "value": "not-a-number",
      "expected": "numeric string"
    }
  },
  "traceId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
}

You are viewing documentation for an outdated version of the specification.

Path Parameters

responseId · string · required

Unique response ID (UUID v4 format, alphanumeric with hyphens/underscores, max 128 characters)

Pattern: ^[a-zA-Z0-9_-]{1,128}$

Response

200

application/json

Cache refreshed successfully

status · enum<string> · required

Cache refresh status

Available options: OK

Example:

"OK"