GET
/
integrations
/
web_crawler
/
index
JavaScript
import Hyperspell from 'hyperspell';

const client = new Hyperspell({
  apiKey: process.env['HYPERSPELL_TOKEN'], // This is the default and can be omitted
});

const response = await client.integrations.webCrawler.index({ url: 'url' });

console.log(response.resource_id);
{
  "source": "collections",
  "resource_id": "<string>",
  "status": "pending"
}

Authorizations

Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Query Parameters

url
string
required

Response

200
application/json

Successful Response

The response is of type object.