Create crawl job

POST https://api.elevenlabs.io/v1/convai/knowledge-base/crawl Content-Type: application/json

Create a crawl job to crawl the given URL with specified depth and page limits.

Reference: https://elevenlabs.io/docs/api-reference/knowledge-base/create-crawl-job

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

Body (application/json)

This endpoint expects a Body_Create_crawl_job_v1_convai_knowledge_base_crawl_post.

url (string, required) — URL to a page of documentation that the agent will have access to in order to interact with users.
max_pages (integer, optional, default: 1000) — Maximum number of pages to crawl (1-10,000), defaults to 1000.
pattern (string, optional, nullable) — If set, only URLs that match this pattern are included.
sitemap_urls (list of string, optional, nullable) — List of URLs to crawl from sitemap (optional, overrides automatic URL discovery).
parent_folder_id (string, optional, nullable) — If set, the created document or folder will be placed inside the given folder.
enable_auto_sync (boolean, optional, default: false) — Whether to enable auto-sync for this URL document.
auto_remove (boolean, optional, default: false) — Whether to automatically remove the document if the URL becomes unavailable. Only applicable when auto-sync is enabled.
auto_discover (boolean, optional, default: false) — Automatically discover and add new pages linked from already-crawled pages during auto-sync. Requires enable_auto_sync=true.
minimum_frequency_days (integer, optional, nullable) — Minimum frequency (in days) at which the underlying eligible documents are refreshed. The actual interval may be shorter, never longer. Defaults to 7, tightened to the parent folder's frequency if that is stricter. Only applicable when auto-sync is enabled.
max_depth (integer, optional, default: 3, deprecated) — Deprecated - this field is a no-op and will be removed in a future version.

Response

200

Successful Response

id (string, required)
type (enum, required, default: discovery)
- Allowed values: discovery, sitemap
root_folder_id (string, required)
status (string, required)
created_at (integer, required)
folder_path (list of KnowledgeBaseFolderPathSegmentSummaryResponseModel, optional) — The folder path segments leading to the root folder, from root to parent folder.

Errors

422 Unprocessable Entity Error

Validation Error

detail (list of ValidationError, optional)

Types

KnowledgeBaseFolderPathSegmentSummaryResponseModel

id (string, required)

ValidationError

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

ValidationErrorLocItems

Examples

Request

JSON

{
  "url": "string"
}

Response

JSON

{
  "id": "string",
  "type": "discovery",
  "root_folder_id": "string",
  "status": "string",
  "created_at": 1,
  "folder_path": [
    {
      "id": "string"
    }
  ]
}

SDK Code

TypeScript

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

async function main() {
    const client = new ElevenLabsClient();
    await client.conversationalAi.knowledgeBase.crawlJobs.create({
        url: "string",
    });
}
main();

Python

from elevenlabs import ElevenLabs

client = ElevenLabs()

client.conversational_ai.knowledge_base.crawl_jobs.create(
    url="string",
)

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"url\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	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::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"string\"\n}"

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.post("https://api.elevenlabs.io/v1/convai/knowledge-base/crawl")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"string\"\n}")
  .asString();

PHP

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.elevenlabs.io/v1/convai/knowledge-base/crawl', [
  'body' => '{
  "url": "string"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/knowledge-base/crawl");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"url\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Swift

import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = ["url": "string"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

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

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()