Skip to content

Generate Company Profile

POST
/company-profile/generate

(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.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors company_profile.SaveProfileRequest.

object
fields
required

Which profile fields to generate, and their seeds.

object
key
additional properties
any
website_url
required

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

string

Responses

200

Successful Response

object
data
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”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string