---
title: "POST /scrape"
method: POST
path: "/scrape"
tags: ["scrape"]
---

# POST /scrape

`POST /scrape`

## Request body

- ScrapeRequest — Request body for scraping a single entity directly
  - `dataset_name` string, required
  - `extraction_criteria` SaveRequirement[], required
    - union — It's an OR statement across these.
      - RequiredRelationship
        - `relationship_name` string, required
      - RequiredEntity
        - `entity_id` string, uuid
        - `seeded_entity_id` integer, required — The integer id corresponding to an entity in the seeded entity graph (different from the global dataset entity id)
      - RequiredProperty
        - `property_names` string[], required — If there are multiple properties, it can match just one of them
        - `table_name` string, required — The table name of the entity to update
  - `node_id` string, uuid
  - `seeded_kg` LLMKnowledgeGraph — Knowledge graph info structured to deserialize and display in the same format that the LLM outputs. Also the first representation of an LLM output in the pipeline from raw tool output to being merged into a DB
    - `entities` LLMEntity[], required
      - `id` integer, required
      - `properties` object, required
      - `type` string, required
    - `relationships` LLMRelationship[]
      - `properties` object
      - `source` integer, required
      - `target` integer, required
      - `type` string, required
  - `url` string, required
  - `use_proxy` boolean, nullable

## Response `200`

Scrape job created successfully

- ScrapeResponse — Response body
  - `job_id` string, required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `500` — Internal server error

---

[API](https://skmtc.dev/structifyai/apis/structify.md) · [All operations](https://skmtc.dev/structifyai/apis/structify/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/structifyai/structify/revisions/1364930b6980/schema)