List crawl jobs

GET https://api.elevenlabs.io/v1/convai/knowledge-base/crawl

Get a list of ongoing and recent crawl jobs for the user.

Reference: https://elevenlabs.io/docs/api-reference/knowledge-base/list-crawl-jobs

Servers

https://api.elevenlabs.io (Production, default)
https://api.us.elevenlabs.io (Production US)
https://api.eu.residency.elevenlabs.io (Production EU)
https://api.in.residency.elevenlabs.io (Production India)
https://api.sg.residency.elevenlabs.io (Production Singapore)

Request

Query parameters

include_job_ids (list of string, optional, nullable) — Ids of additional crawl jobs to retrieve
page_size (integer, optional, default: 30) — How many documents to return at maximum. Can not exceed 100, defaults to 30.
cursor (string, optional, nullable) — Used for fetching next page. Cursor is returned in the response.

Response

200

Successful Response

crawl_jobs (list of GetCrawlJobResponseModel, required)
next_cursor (string, optional, nullable)

Errors

422 Unprocessable Entity Error

Validation Error

detail (list of ValidationError, optional)

Types

GetCrawlJobResponseModel

seed_url (string, required)
max_pages (integer, required)
root_folder_id (string, required)
updated_at (integer, required)
id (string, required)
created_at (integer, required)
type (enum, optional, default: discovery)
- Allowed values: discovery, sitemap
pattern (string, optional, nullable)
auto_discover (boolean, optional, default: false) — Whether to automatically discover and enqueue additional pages found while crawling.
status (enum, optional, default: queued)
- Allowed values: queued, processing, succeeded, failed, skipped, cancelled
pages_identified (integer, optional, default: 0)
pages_scraped (integer, optional, default: 0)
pages_skipped (integer, optional, default: 0)
pages_failed (integer, optional, default: 0)
max_depth (integer, optional, default: 3, deprecated) — Deprecated - this field is a no-op and will be removed in a future version.

ValidationError

loc (list of ValidationErrorLocItems, required)
msg (string, required)
type (string, required)

ValidationErrorLocItems

Examples

Response

JSON

{
  "crawl_jobs": [
    {
      "seed_url": "string",
      "max_pages": 1,
      "root_folder_id": "string",
      "updated_at": 1,
      "id": "string",
      "created_at": 1,
      "type": "discovery",
      "pattern": "string",
      "auto_discover": false,
      "status": "queued",
      "pages_identified": 0,
      "pages_scraped": 0,
      "pages_skipped": 0,
      "pages_failed": 0,
      "max_depth": 3
    }
  ],
  "next_cursor": "string"
}

SDK Code

TypeScript

import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";

async function main() {
    const client = new ElevenLabsClient();
    await client.conversationalAi.knowledgeBase.crawlJobs.list({});
}
main();

Python

from elevenlabs import ElevenLabs

client = ElevenLabs()

client.conversational_ai.knowledge_base.crawl_jobs.list()

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/convai/knowledge-base/crawl"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.elevenlabs.io/v1/convai/knowledge-base/crawl")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

Java

import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.elevenlabs.io/v1/convai/knowledge-base/crawl")
  .asString();

PHP

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/convai/knowledge-base/crawl');

echo $response->getBody();

using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/knowledge-base/crawl");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);

Swift

import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/knowledge-base/crawl")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()