---
title: "Extract Company Data"
method: POST
path: "/global-context/extract-company-data"
tags: ["GTM Context"]
---

# Extract Company Data

`POST /global-context/extract-company-data`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/global-context/extract-company-data`
- Auth: HTTP bearer

Pull company facts out of scraped intelligence data.

SPENDS CREDITS when `enrich` is true (the default): the route is
credit-gated before the model call and answers 402 when the balance is
short. Send `enrich=false` for the scrape-derived fields alone, which costs
nothing extra.

The app takes an untyped body here; this contract types it, so a missing
`website_url` is a 422 naming the field rather than a 400 describing it.

## Headers

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

## Request body

- ExtractCompanyDataRequest: The typed form of the untyped `dict` body `extract-company-data` takes. The app reads exactly two keys off that dict and 400s when `website_url` is missing. Typed here so the same mistake is a parse-layer 422 naming the field, and so the caller can see that `enrich` exists at all - it is invisible in an untyped body. NOT a mirrored model: there is no app model to mirror. The proxy sends a plain dict, exactly as the browser does.
  - `website_url` string, required: Company website to extract from. Intelligence data for it must already exist.
  - `enrich` boolean: Enrich the extracted fields through Apollo. SPENDS CREDITS - the call is credit-gated and answers 402 when the balance is short.

## Response `200`

Successful Response

- ApiResponseStudioPayload
  - `data` StudioPayload, required: An open envelope for one settings block, document or brand artefact. OPEN on purpose. These surfaces are configuration and generated content, and both grow: a new toggle on a settings block or a new field on a generated document must reach a caller on the day it ships, not on the day somebody remembers to widen a mirror. A closed response model here would silently DROP the new key, which reads to the caller as "the product does not have that setting". The request side is the opposite and is mirrored exactly - see the module docstring for why the asymmetry is deliberate.
  - `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)