---
title: "Create crawler"
method: POST
path: "/crawlers"
tags: ["Crawlers"]
---

# Create crawler

`POST /crawlers`

## Request

- Base URL: `https://api.distill.io/v2`
- URL: `https://api.distill.io/v2/crawlers`
- Auth: one of:
  - API key in cookie `connect.sid`
  - HTTP bearer
  - API key in query parameter `api_key`

Auth: Write — Workspace member with write access or higher.

## Request body

- object
  - `name` string, required
  - `url` string, nullable, required
  - `config` object, nullable
  - `schedule` object, nullable
  - `state` 0 | 40 | 45 | 90 | 100 | 110

## Response `200`

Success

- object
  - `id` string, uuid, required
  - `workspace_id` string, uuid
  - `name` string, required
  - `url` string, nullable
  - `config` object, nullable
  - `schedule` object, nullable
  - `latest_job_id` string, uuid, nullable
  - `state` integer, required
  - `ts` string, date-time, required
  - `ts_mod` string, date-time, required

## Other responses

- `400`: Validation error
- `401`: Unauthorized
- `403`: Forbidden

---

[API](https://skmtc.dev/distill/apis/distill-io-api-v2.md) - [All operations](https://skmtc.dev/distill/apis/distill-io-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/distill/apis/distill-io-api-v2/revisions/c55722ccfe14?raw)