REST API

Dokumentacja API

Bezpośredni dostęp HTTP do wszystkich funkcji Baseline Labs. Uwierzytelnij się za pomocą swojego klucza API i wywołuj z dowolnego języka.

URL bazowy

https://baselinelabs.ai/api/

Uwierzytelnij się za pomocą nagłówka X-API-Key: bl_your_key przy każdym żądaniu.

Projekty

GET /api/geo/saves

Wyświetl listę wszystkich Twoich projektów.

{
  "saves": [
    { "id": 42, "name": "My Brand", "url": "https://mybrand.com" }
  ]
}

POST /api/geo/saves

Utwórz nowy projekt.

{ "name": "My Brand", "url": "https://mybrand.com" }

Wyszukiwanie

POST /api/geo/search

Przeprowadź wyszukiwanie w Google, GPT, Perplexity, Gemini, Google AI Mode, Claude i DeepSeek. Kosztuje kredyty.

{
  "save_id": 42,
  "queries": ["best project management tools", "top PM software 2026"]
}

Zwraca identyfikator wyszukiwania. Sprawdzaj status wyników:

GET /api/geo/search/{search_id}

Pobierz wyniki wyszukiwania po zakończeniu przetwarzania.

Raporty widoczności

GET /api/geo/reports/templates

Wyświetl listę Twoich szablonów raportów.

POST /api/geo/reports/run

Uruchom raport widoczności z szablonu. Kosztuje kredyty.

{ "template_id": 12 }

GET /api/geo/reports/{report_id}

Pobierz wyniki raportu, w tym rankingi dla poszczególnych zapytań.

Wzmianki o marce

POST /api/geo/mentions/scan

Utwórz skan wzmianek o marce. Kosztuje kredyty.

{ "save_id": 42, "brand_name": "My Brand" }

GET /api/geo/mentions/{scan_id}

Pobierz wyniki skanowania i poszczególne rekordy wzmianek.

Schema.org

POST /api/geo/schema/generate

Generuj JSON-LD schema.org dla dowolnego adresu URL przy użyciu wnioskowania GPU.

{ "url": "https://example.com/page" }

Odpowiedź:

{
  "url": "https://example.com/page",
  "schema_url": "https://schema.baselinelabs.ai/abc123.json",
  "cached": true,
  "inference_ms": 12
}

GET /api/geo/schema/status/{job_id}

Sprawdź status zadania asynchronicznego generowania schematu (dla zadań trwających >5s).

Odpowiedzi o błędach

Wszystkie błędy zwracają JSON z polem detail.

401 Nieprawidłowy lub brakujący klucz API

402 Niewystarczająca liczba kredytów

429 Przekroczono limit żądań

404 Zasób nie znaleziony