Kaart Maken - Olostep Docs

curl --request POST \ --url https://api.olostep.com/v1/maps \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "url": "https://docs.olostep.com" } '

{ "id": "map_abc123", "urls_count": 22, "urls": [ "https://docs.olostep.com/api-reference/batches/create", "https://docs.olostep.com/api-reference/batches/info", "https://docs.olostep.com/api-reference/batches/items" ] }

curl --request POST \ --url https://api.olostep.com/v1/maps \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "url": "https://docs.olostep.com" } '

Autorisaties

Authorization

string

header

vereist

Bearer authenticatie header in de vorm Bearer , waar jouw auth token is.

Body

application/json

url

string<uri>

vereist

De URL van de website waarvoor je de links wilt

search_query

string

Een optionele zoekopdracht om de links te sorteren op zoekrelevantie.

top_n

number

Een optioneel aantal om alleen de top n links voor een zoekopdracht te beperken.

include_subdomain

boolean

Inclusief subdomeinen van de gegeven URL. true standaard.

include_urls

string[]

URL-padpatronen om op te nemen met behulp van glob-syntaxis. Bijvoorbeeld: /blog/** om alleen blog-URLs op te nemen. Alleen URLs die aan deze patronen voldoen, worden geretourneerd.

exclude_urls

string[]

URL-padpatronen om uit te sluiten met behulp van glob-syntaxis. Bijvoorbeeld: /careers/**. Uitgesloten URLs zullen opgenomen URLs overschrijven.

cursor

string

OPTIONEEL: Paginering cursor van een vorige reactie. Wanneer verstrekt, retourneert het de volgende set URLs vanaf waar het vorige verzoek stopte vanwege de limiet van de reactiesomvang.

Respons

Succesvolle reactie met URLs gevonden op de pagina

urls_count

integer

vereist

Aantal URLs in de huidige reactie

urls

string[]

vereist

Array van URLs gevonden op de pagina

string

Unieke identificatie voor deze kaart

cursor

string

Paginatiecursor om de volgende set van URLs op te halen die beperkt zijn door de 10MB grootte limiet. Als deze null is of niet aanwezig, zijn alle URLs opgehaald.

credits_consumed

integer | null

Aantal credits verbruikt door dit verzoek. Wordt ingevuld nadat de uitvoering voltooid is. Credits zijn de bron van waarheid voor facturering.

cost_usd

number | null

Geschatte kosten in USD voor dit verzoek. Wordt ingevuld nadat de uitvoering voltooid is. Berekend op basis van verbruikte credits en je abonnementsprijs — 99% nauwkeurig, maar credits_consumed is de gezaghebbende waarde.