GET
/v1/convai/knowledge-base/crawl
ElevenLabs APIList Ongoing And Recent Crawl Jobs Created By A User
- Base URL
- https://api.elevenlabs.io
- Auth
- xi-api-key: <ELEVENLABS_API_KEY>
- Last verified
- 2026-09-03 · upstream hash matched
Actions
Agents: curl -H "Accept: text/markdown" this URL
→ 225 tokens · Vary: Accept
→ 225 tokens · Vary: Accept
Critical gotchas
Authentication uses the non-standard xi-api-key header, not Authorization: Bearer. Sending a Bearer token returns HTTP 401.
Text-to-speech responses are raw binary audio, not JSON. Write the body to a file (--output speech.mp3) rather than parsing it.
cURL
curl -X GET 'https://api.elevenlabs.io/v1/convai/knowledge-base/crawl?include_job_ids=example&page_size=30&cursor=example-cursor' \ -H "xi-api-key: $ELEVENLABS_API_KEY"Get a free ElevenLabs API key → sponsored
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| include_job_ids | query | string[] | No | Ids of additional crawl jobs to retrieve |
| page_size | query | integer | No | How many documents to return at maximum. Can not exceed 100, defaults to 30. |
| cursor | query | string | No | Used for fetching next page. Cursor is returned in the response. |
Response 200 OK
{
"crawl_jobs": [
{
"type": "discovery",
"seed_url": "string",
"pattern": "string",
"max_depth": 0,
"max_pages": 0,
"status": "queued",
"pages_identified": 0,
"pages_scraped": 0,
"pages_skipped": 0,
"pages_failed": 0,
"root_folder_id": "string",
"updated_at": 0,
"id": "string",
"created_at": 0
}
],
"next_cursor": "string"
}