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

# POST /scrape/list

`POST /scrape/list`

## Request body

- ScrapeListRequest — Request body for scraping a list
  - `dataset_descriptor` DatasetDescriptor, required — A dataset is where you put multiple referential schemas. A dataset is a complete namespace where all references between schemas are held within the dataset.
    - `description` string, required
    - `llm_override_field` string, nullable
    - `name` string, required
    - `relationships` RelationshipDescriptor[], required
      - `description` string, required
      - `merge_strategy` RelationshipMergeStrategy
        - `source_cardinality_given_target_match` integer, nullable — Describes the expected cardinality of the source table when a match is found in the target table For example, if we have a source company and a target funding round, we expect the source company to appear in multiple funding rounds, but not *too* many. So if we have a funding round match, the expected number of unique companies is relatively small. This is an estimate of that number.
        - `target_cardinality_given_source_match` integer, nullable — Describes the expected cardinality of the target table when a match is found in the source table For example, if we have a source company and a target funding round, we usually expect some number of funding rounds to be associated with a single company but not *too* many. So if we have a company match, the expected number of unique funding rounds is relatively small. This is an estimate of that number.
      - `name` string, required
      - `properties` PropertyDescriptor[]
        - `description` string, required
        - `merge_strategy` union
          - 'Unique' — Property with unique 1:1 correspondence to its parent. Merge based on this property 100% of the time
          - object
            - `Probabilistic` MergeConfig, required — The configuration for a probabilistic merge strategy
              - …
          - 'NoSignal'
        - `name` string, required
        - `prop_type` union
          - 'String'
          - 'Boolean'
          - object
            - `Enum` string[], required
          - 'Integer'
          - 'Float'
          - 'Date'
          - 'URL'
          - 'Money'
          - 'Image'
          - 'PersonName'
          - 'Address'
      - `source_table` string, required
      - `target_table` string, required
    - `tables` TableDescriptor[], required
      - `description` string, required
      - `expected_cardinality` integer, nullable — Expected number of unique values in the complete dataset. This is used for our probabilistic merge strategy.
      - `name` string, required — Organized in a name, description format.
      - `primary_column` string, nullable
      - `properties` PropertyDescriptor[], required — Organized in a name, description format.
        - `description` string, required
        - `merge_strategy` union
          - 'Unique' — Property with unique 1:1 correspondence to its parent. Merge based on this property 100% of the time
          - object
            - `Probabilistic` MergeConfig, required — The configuration for a probabilistic merge strategy
              - …
          - 'NoSignal'
        - `name` string, required
        - `prop_type` union
          - 'String'
          - 'Boolean'
          - object
            - `Enum` string[], required
          - 'Integer'
          - 'Float'
          - 'Date'
          - 'URL'
          - 'Money'
          - 'Image'
          - 'PersonName'
          - 'Address'
  - `dataset_name` string, nullable
  - `input` union, required
    - object
      - `Direct` object, required
        - `url` string, required
    - object
      - `Related` object, required
        - `relationship_name` string, required
        - `source_entity` LLMEntity, required
          - `id` integer, required
          - `properties` object, required
          - `type` string, required
        - `source_url_column` string, required
  - `node_id` string, uuid
  - `table_name` string, required
  - `use_proxy` boolean, nullable

## Response `200`

Knowledge graph extracted successfully

- ScrapeListResponse — Response body
  - `dataset_name` string, required
  - `job_id` string, uuid, required

## Other responses

- `400` — Invalid input
- `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)