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>"
}

Get the current status and results of a crawl operation. For large crawls, results may be paginated.

​
Path Parameters

​
id
string
required

The ID of the crawl job to check

​
Response Fields

​
status
string

Current status of the crawl: scraping, completed, or failed

​
total
integer

Total number of pages attempted to crawl

​
completed
integer

Number of successfully crawled pages

​
creditsUsed
integer

Number of credits consumed by the crawl

​
expiresAt
string

ISO 8601 timestamp when the crawl data expires

​
next
string

URL to retrieve next batch of data (for paginated results)

​
data
array

​
Example Request

curl --request POST \
  --url https://crawl.taam.cloud/v1/web \
  --header 'Authorization: Bearer YOUR_API_KEY'

​
Example Response

{
  "status": "completed",
  "total": 50,
  "completed": 48,
  "creditsUsed": 96,
  "expiresAt": "2024-03-20T10:00:00Z",
  "next": null,
  "data": [
    {
      "markdown": "# Page Title\nContent...",
      "html": "<h1>Page Title</h1><p>Content...</p>",
      "links": [
        "https://example.com/page1",
        "https://example.com/page2"
      ],
      "metadata": {
        "title": "Example Page",
        "description": "Page description",
        "language": "en",
        "sourceURL": "https://example.com/page",
        "statusCode": 200
      }
    }
  ]
}

​
Status Codes

Authorizations

​
Authorization
string
header
required

Enter your API key prefixed with 'Bearer '

Body

application/json
​
model
enum<string>
required

Type of web service to use

Available options:
scrape,
crawl,
map,
taam-ai-search,
crawl-status
​
params
object

Parameters specific to the selected model

Response

200 - application/json
Successful response
​
id
string

Unique identifier for the request

​
object
string

Type of completion (e.g., scrape.completion)

​
created
integer

Unix timestamp of when the request was created

​
model
string

Model used for the request

​
data
object

Model-specific response data

​
usage
object
​
system_fingerprint
string