castomAPI
Odbierz klucz
POST /v1/generate/screenshot 2 tokenów PRO Klucz API Generowanie

Wykonaj zrzut ekranu viewportu above-the-fold dowolnej strony…

Wykonaj zrzut ekranu viewportu above-the-fold dowolnej strony internetowej

POST

Żądanie

  • x-api-key: <your-api-key>
  • Content-Type: application/json

Odpowiedź

{
  "format": "json",
  "result": "<result>",
  "status": "success",
  "targetUrl": "https://example.com/page",
  "tokensDeducted": 2
}
Odpowiedź poniżej to makieta zbudowana ze schematu endpointu — żadne żądanie nie opuszcza tej strony. Zmień treść, naciśnij Wyślij, zobacz kształt odpowiedzi. Uruchom naprawdę w panelu →

Co robi

Wykonaj zrzut ekranu viewportu above-the-fold dowolnej strony internetowej

Żądanie

Treść

PoleTypWymaganeOpis
delayintegernie
deviceScaleFactornumbernie
formatenumnieOne of: png, jpeg, webp.
heightintegernie
responseTypeenumnieOne of: dataurl, binary.
urlstringtak
widthintegernie

Przykładowe żądanie

{
  "delay": 0,
  "deviceScaleFactor": 1,
  "format": "png",
  "height": 1080,
  "responseType": "dataurl",
  "url": "https://example.com/page",
  "width": 1920
}

Odpowiedź

PoleTypOpis
formatstring
resultstring
statusstring
targetUrlstring
tokensDeductedinteger

Przykładowa odpowiedź

{
  "format": "json",
  "result": "<result>",
  "status": "success",
  "targetUrl": "https://example.com/page",
  "tokensDeducted": 2
}

Błędy

Każdy błąd ma tę samą kopertę: status HTTP, kod maszynowy i jedno zdanie.

400Treść albo parametr nie przeszły walidacji. Tablica details wskazuje pole.
401Brak klucza, klucz cofnięty albo zły nagłówek. Wyślij x-api-key.
402Portfel nie pokrywa tego wywołania. Doładuj albo poczekaj na miesięczny przydział.
404Zasób nie istnieje albo nie jest Twój. Obie sytuacje odpowiadają identycznie i nic nie kosztują.
429Przekroczony limit na minutę dla Twojego planu. Odczekaj i ponów.
5xxUsługa nadrzędna odmówiła albo przekroczyła czas. Wywołanie nie jest rozliczane.

Kod

curl -X POST 'https://app.castomapi.com/v1/generate/screenshot' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"delay": 0, "deviceScaleFactor": 1, "format": "png", "height": 1080, "responseType": "dataurl", "url": "https://example.com/page", "width": 1920}'
const res = await fetch('https://app.castomapi.com/v1/generate/screenshot', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"delay": 0, "deviceScaleFactor": 1, "format": "png", "height": 1080, "responseType": "dataurl", "url": "https://example.com/page", "width": 1920})
});
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/generate/screenshot', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"delay": 0, "deviceScaleFactor": 1, "format": "png", "height": 1080, "responseType": "dataurl", "url": "https://example.com/page", "width": 1920})
});
const data = await res.json();
console.log(data);
import requests

res = requests.post(
    'https://app.castomapi.com/v1/generate/screenshot',
    headers={'x-api-key': '<your-api-key>'},
    json={"delay": 0, "deviceScaleFactor": 1, "format": "png", "height": 1080, "responseType": "dataurl", "url": "https://example.com/page", "width": 1920},
    timeout=30,
)
print(res.json())
<?php
$ch = curl_init('https://app.castomapi.com/v1/generate/screenshot');
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(['delay' => 0, 'deviceScaleFactor' => 1, 'format' => 'png', 'height' => 1080, 'responseType' => 'dataurl', 'url' => 'https://example.com/page', 'width' => 1920]),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);

Koszt i limity

Ta operacja kosztuje 2 tokenów. Nieudane wywołanie nigdy nie jest rozliczane. Każde konto dostaje 1000 darmowych tokenów miesięcznie; opłacone saldo nie wygasa. Dostępne w planach PRO i Enterprise: ta operacja zużywa własne klucze lub limity castomAPI. Klucz z planu darmowego dostaje 403 i nie jest rozliczany.

Limity żądań na minutę

Bez klucza10
Free60
Pro300
Enterprise1200

Dokumentacja → Cennik

Pytania

Ile kosztuje Wykonaj zrzut ekranu viewportu above-the-fold dowolnej strony…?

2 tokenów za udane wywołanie, pobierane z portfela po odpowiedzi. Nieudane wywołania są bezpłatne. Każde konto dostaje 1000 darmowych tokenów miesięcznie.

Jak się uwierzytelnić?

Wyślij klucz w nagłówku x-api-key. Jeden klucz obejmuje każdy rozliczany endpoint; niczego nie trzeba włączać osobno.

Czy mogę wysłać nagłówek Authorization: Bearer zamiast klucza?

Nie dla rozliczanego endpointu — te przyjmują wyłącznie nagłówek x-api-key. Tokeny Bearer należą do strony konta: panel i API konta przyjmują sesję JWT, a castomapi-auth wydaje je standardowym uzgodnieniem OAuth2, z grantami authorization code, client credentials i refresh. Opisuje to strona usługi auth.

Jakie są limity?

10 żądań na minutę z jednego IP zupełnie bez klucza, 60 na minutę w planie Free, 300 w Pro, 1200 w Enterprise. Powyżej poziomu bez klucza limit jest na konto, łącznie dla wszystkich endpointów.

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