---
title: "Start Content Crawl Import"
method: POST
path: "/content-workspace/import/crawl"
tags: ["Content"]
---

# Start Content Crawl Import

`POST /content-workspace/import/crawl`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/content-workspace/import/crawl`
- Auth: HTTP bearer

Deep-crawl the org's own website into the workspace. SPENDS PROVIDER CREDIT.

Billed per page crawled; `max_pages` is the ceiling on the spend. Only the
org's registered website can be crawled. Returns the import job - poll
`GET /content-workspace/import/status/{job_id}`.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- ContentWorkspaceCrawlRequest: Deep-crawl the org's OWN website. SPENDS PROVIDER CREDIT, per page crawled.
  - `start_url` string, required: Must be on the org's registered website.
  - `include_paths` string[], nullable: e.g. ['/blog', '/resources'].
  - `exclude_paths` string[], nullable: e.g. ['/author', '/tag'].
  - `max_pages` integer: The ceiling on pages crawled - and on the spend.

## Response `202`

Successful Response

- ApiResponseStudioContentPayload
  - `data` StudioContentPayload, required: One Studio object, open-shaped. See the module docstring.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)