POST /v1/account/profile/populate

Populate the account company profile

Access

Authenticated (self)

Cost

Free

Rate limit

30 / minute per account

Quota

None

Kick off agent population of your account company profile. Sets profileStatus to populating and dispatches a company_context job, which writes description, topics of interest, and similar hiring profiles back through this API. The job is seeded with what the profile already holds (company name, domain, GitHub org, LinkedIn, and your website/careers/blog links), so re-running after you add links produces a better result. Every body field is an optional override; send {} to re-run from the stored profile. Hiring locations are never written by this job.

Request body `ProfilePopulateRequest`

jobPostingUrl string

A job posting to read the company from.

max 2048 chars
rawText string

Pasted text to extract from, when you would rather not hand over a URL.

max 50000 chars
domain string

The company’s web domain.

max 253 chars
githubOrg string

The company’s GitHub organisation.

max 39 chars
linkedinUrl string

The company’s LinkedIn page.

max 2048 chars

Responses

202 Population started
- status string required
  
  Where the background extraction stands. Read the profile back to see what it wrote.
400 Nothing identifies the company yet (no name, domain, posting, or text)
- code string required
  
  Stable machine-readable error code. Branch on this, never on the numeric status.
  
  bad_requestunauthorizedsignature_requiredpayment_requiredforbiddennot_foundconflictgonepayload_too_largeunprocessable_entitytoo_many_requestsinternal_errornot_implementedbilling_unavailablenot_contactablemailbox_link_unavailablemailbox_requiredmail_engine_unavailablewebhook_publisher_unavailabledatabase_unavailableclient_error
- message string required
  
  Human-readable explanation of the refusal.
- status integer required
  
  The HTTP status code, repeated in the body.
- remedy object
  
  A self-serve path forward, when one exists (a 402 points at the credit top-up).
  - kind string required
    
    What kind of remedy this is, so a client can route it: whether the caller can clear the condition through the API, or a person must act in the web app.
    
    topupconnect_mailbox
  - url string required
    
    Where to go to clear the condition: an API path, or a web app page when only a person can.
401 No or invalid credential
- code string required
  
  Stable machine-readable error code. Branch on this, never on the numeric status.
  
  bad_requestunauthorizedsignature_requiredpayment_requiredforbiddennot_foundconflictgonepayload_too_largeunprocessable_entitytoo_many_requestsinternal_errornot_implementedbilling_unavailablenot_contactablemailbox_link_unavailablemailbox_requiredmail_engine_unavailablewebhook_publisher_unavailabledatabase_unavailableclient_error
- message string required
  
  Human-readable explanation of the refusal.
- status integer required
  
  The HTTP status code, repeated in the body.
- remedy object
  
  A self-serve path forward, when one exists (a 402 points at the credit top-up).
  - kind string required
    
    What kind of remedy this is, so a client can route it: whether the caller can clear the condition through the API, or a person must act in the web app.
    
    topupconnect_mailbox
  - url string required
    
    Where to go to clear the condition: an API path, or a web app page when only a person can.

Request body ProfilePopulateRequest

Responses

Request body `ProfilePopulateRequest`