POST
/
v1
/
web
curl --request POST \
  --url https://api.taam.cloud/v1/web \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "scrape",
  "params": {}
}'
{
  "id": "<string>",
  "object": "<string>",
  "created": 123,
  "model": "<string>",
  "data": {},
  "usage": {
    "prompt_tokens": 123,
    "completion_tokens": 123,
    "total_tokens": 123
  },
  "system_fingerprint": "<string>"
}

The Website Mapping service helps you discover all links and pages on a website. You can filter results using search queries and control the crawling behavior.

​
Required Parameters

​
url
string
required

The base URL to start mapping from

​
Optional Parameters

​
Example Request

curl --request POST \
  --url https://crawl.taam.cloud/v1/web \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://example.com",
    "search": "blog",
    "ignoreSitemap": true,
    "includeSubdomains": false,
    "limit": 1000
  }'

​
Example Response

{
  "success": true,
  "links": [
    "https://example.com/blog/post-1",
    "https://example.com/blog/post-2",
    "https://example.com/blog/categories"
  ]
}

​
Status Codes

Authorizations

​
Authorization
string
header
required

Enter your API key prefixed with 'Bearer '

Body

application/json

Response

200 - application/json

Successful response

The response is of type object.