onboarding

Start onboarding from a website or a written brief

post/api/v1/onboarding/start

Request

  • Base URL: https://api.cadencz.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.cadencz.com/api/v1/onboarding/start
  • Auth: HTTP bearer

Request body

urlstring nullable

The website to analyze.

briefstring nullable

A written description of the product, used instead of a website: what it is, who it is for, the problem, the benefits, the tone.

company_namestring nullable

The brand or product name. Required with a brief.

platformsstring[] nullable

Where the first week should be written for. Saved to the strategy before the run starts.

goalsstring[] nullable

What the posts are for — ids from the goal catalogue (promote, learnings, engage, build_in_public, grow, authority). Saved to the strategy before the run.

brain_idstring nullable

Target an existing brain.

new_brainboolean

Force a fresh brain (plan-capped).

refreshboolean

Re-read the brain's data only — its plan is left untouched.

Response

Successful Response

idstring required
source_kindstring
urlstring nullable
company_namestring nullable
statusstring required
current_stepstring nullable
errorstring nullable
brain_idstring nullable
content_plan_idstring nullable
created_atstring date-time required
finished_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.