---
title: "start a template collection"
method: POST
path: "/integration/n8n/start"
---

# start a template collection

`POST /integration/n8n/start`

## Request

- Base URL: `https://deepsfetch.com`
- URL: `https://deepsfetch.com/integration/n8n/start`
- Auth: HTTP bearer

## Request body

- object
  - `config` N8nConfig, required
    - `template` 'price' | 'documentation' | 'catalog', required
    - `url` string, uri, required: Public HTTPS URL; no credentials, IP literal or custom port.
    - `fields` object[]
      - `name` string, required
      - `type` 'string' | 'number' | 'boolean', required
      - `source` 'css' | 'jsonld', required
      - `path` string, required
      - `required` boolean
      - `attribute` string
      - `description` string
    - `maxItems` integer
    - `itemSelector` string
    - `costControl` object: Supported on compatible scrape/map/crawl/extract paths. Browser runtime, interact, search and watch reject caps (including workspace policy) with 409 cost_operation_unsupported. External AI costs excluded.
      - `maxCredits` integer: Additional task credit cap. External AI provider costs are excluded.
      - `cacheMode` 'fresh' | 'prefer'
      - `maxAgeSeconds` integer
      - `allowFallback` boolean: Set false to restrict fallback. General estimation includes fallback unless false; quickstart forces false.
      - `taskId` string: Shared task budget identifier within the workspace. Use a new ID per logical run; distinct from idempotency.
  - `idempotencyKey` string, required

## Response `202`

Successful response

- N8nJob
  - `id` string, required
  - `status` 'queued' | 'running' | 'completed' | 'failed' | 'cancelled', required
  - `config` N8nConfig, required
    - `template` 'price' | 'documentation' | 'catalog', required
    - `url` string, uri, required: Public HTTPS URL; no credentials, IP literal or custom port.
    - `fields` object[]
      - `name` string, required
      - `type` 'string' | 'number' | 'boolean', required
      - `source` 'css' | 'jsonld', required
      - `path` string, required
      - `required` boolean
      - `attribute` string
      - `description` string
    - `maxItems` integer
    - `itemSelector` string
    - `costControl` object: Supported on compatible scrape/map/crawl/extract paths. Browser runtime, interact, search and watch reject caps (including workspace policy) with 409 cost_operation_unsupported. External AI costs excluded.
      - `maxCredits` integer: Additional task credit cap. External AI provider costs are excluded.
      - `cacheMode` 'fresh' | 'prefer'
      - `maxAgeSeconds` integer
      - `allowFallback` boolean: Set false to restrict fallback. General estimation includes fallback unless false; quickstart forces false.
      - `taskId` string: Shared task budget identifier within the workspace. Use a new ID per logical run; distinct from idempotency.
  - `result` object: Template-specific validated result; check valid before consumption.
  - `error` string, nullable

## Other responses

- `400`: Invalid input
- `401`: Invalid credentials
- `409`: Conflict or credit cap

---

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