GTM Context

Generate Company Profile

(Re)build the profile's company data from the crawled site. SPENDS CREDITS.

Model calls plus a web-search enrichment; refused with 402 before any call when the org is out of credits. REPLACES the unapproved profile data.

post/company-profile/generate

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/company-profile/generate
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

website_urlstring required

The org's website - the profile's key.

fieldsobject required

Which profile fields to generate, and their seeds.

Response

Successful Response

dataCrmRecordPayload required

An open envelope for one record, one dashboard or one job receipt.

Open because most of these reads are COMPUTED shapes - an engagement summary, a next-best-step, an intelligence status - that grow with the product, and dropping a field from an advisory read makes it say "nothing to report" rather than "we did not tell you".

Changes

No recorded changes to this operation across all 2 revisions of this API.