Customer success

Synthesize Brief

Write a fresh brief from everything currently known about this client.

THIS RUNS A LARGE LANGUAGE MODEL and therefore spends credits - the handler calls the model directly and converts its failures into 502s. It is classified billable by an explicit rule for that reason: as a plain write it would make "spend model credits on every account we have" the same grant as "rename a company".

502 when the model is unavailable, which is distinct from a 500: retry it.

post/customer-success/companies/{company_id}/brief/synthesize

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/customer-success/companies/{company_id}/brief/synthesize
  • Auth: HTTP bearer

Path parameters

company_idstring required

Company id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataOrgPayload required

An open envelope for a single role, team, member or account record.

Open on purpose. The app's own response models on this surface grow with the product - RoleResponse gained rep_limits and manages_role_slugs, TeamResponse gained channel counts and a campaign count - and a pinned mirror would SILENTLY DROP whatever it had not caught up on. A dropped permission in a role read is the worst possible kind of stale: it reads as "they do not have it".

Changes

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