Onboarding API

3 endpoints. Every path is relative to the API base URL and needs a bearer token unless it is marked public. See the REST API overview for authentication, errors and pagination.

GET/v1/orgs/{orgId}/onboarding

Bearer token

Path parameters

• orgIdstring (uuid)required

Responses

200

• dataobjectrequired
  Fields

  • currentStepstringrequired

    one of brand, social, x_connection, billing, strategy, first_content

  • completedbooleanrequired
  • stepsarray<object>required
    Item fields

    • keystringrequired

      one of brand, social, x_connection, billing, strategy, first_content

    • labelstringrequired
    • completedbooleanrequired
    • requiredbooleanrequired
  • brandProfileDetectedbooleanrequired
  • brandConfirmedbooleanrequired
  • socialConnectedbooleanrequired
  • xConnectedbooleanrequired
  • strategyReadybooleanrequired
  • firstContentReadybooleanrequired
  • paidTrialActivebooleanrequired
  • subscriptionRequiredbooleanrequired

Request

curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/onboarding" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

PATCH/v1/orgs/{orgId}/onboarding

Bearer token

Path parameters

• orgIdstring (uuid)required

Request body application/json

• currentStepstring

  one of brand, social, x_connection, billing, strategy, first_content

Responses

200

• dataobjectrequired
  Fields

  • currentStepstringrequired

    one of brand, social, x_connection, billing, strategy, first_content

  • completedbooleanrequired
  • stepsarray<object>required
    Item fields

    • keystringrequired

      one of brand, social, x_connection, billing, strategy, first_content

    • labelstringrequired
    • completedbooleanrequired
    • requiredbooleanrequired
  • brandProfileDetectedbooleanrequired
  • brandConfirmedbooleanrequired
  • socialConnectedbooleanrequired
  • xConnectedbooleanrequired
  • strategyReadybooleanrequired
  • firstContentReadybooleanrequired
  • paidTrialActivebooleanrequired
  • subscriptionRequiredbooleanrequired

Request

curl -X PATCH "https://api.adventur.ai/v1/orgs/$ORG_ID/onboarding" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

POST/v1/orgs/{orgId}/onboarding/from-website

Bearer token

One-call first-run setup from a public website URL (and optional notes): infers a brand profile, generates a draft content plan, and persists both. Does not confirm the brand or activate the plan. Visual kit candidates remain GET /v1/orgs/{orgId}/brand/kit/website.

Path parameters

• orgIdstring (uuid)required

Request body application/json

• websiteUrlstringrequired
• notesstring

Responses

200One-call first-run setup from a public website URL (and optional notes): infers a brand profile, generates a draft content plan, and persists both. Does not confirm the brand or activate the plan. Visual kit candidates remain GET /v1/orgs/{orgId}/brand/kit/website.

• dataobjectrequired
  Fields

  • brandobjectrequired
    Fields

    • profileobjectrequired
      Fields

      • websiteUrlstring (uri) | nullrequired
      • logoUrlstring (uri) | nullrequired
      • primaryFontstring | nullrequired
      • secondaryFontstring | nullrequired
      • colorPalettearray<string>required
      • taglinestring | nullrequired
      • missionstring | nullrequired
      • voiceobjectrequired
        Fields

        • tonestringrequired
        • personalityTraitsarray<string>required
        • writingGuidelinesarray<string>required
        • bannedPhrasesarray<string>required
      • businessOutlineobjectrequired
        Fields

        • overviewstringrequired
        • productsOrServicesarray<string>required
        • targetAudiencearray<string>required
        • valuePropositionstringrequired
        • differentiatorsarray<string>required
      • backgroundColorstring | null
      • logoAssetobject | null
        Fields

        • assetIdstringrequired
        • contentTypestringrequired
        • widthnumber | nullrequired
        • heightnumber | nullrequired
        • sourceAssetIdstring | null
      • kitUpdatedAtstring | null
      • brandTypestring

        one of personal, business, unknown

      • identitystring | null
      • expertisearray<string>
      • goalsarray<string>
      • topicsarray<string>
      • opinionsarray<string>
      • guardrailsarray<object>
        Item fields

        • idstringrequired
        • textstringrequired
        • disclosurestring

          one of private, restricted

      • knowledgeItemsarray<object>
        Item fields

        • idstringrequired
        • kindstringrequired

          one of claim, fact, opinion, preference, topic

        • textstringrequired
        • provenanceobjectrequired
          Fields

          • originstringrequired

            one of user, inferred, imported, learned

          • sourceTypestring | null
          • sourceUrlstring | null
          • sourceExternalIdstring | null
          • fetchedAtstring | null
          • updatedAtstring | null
          • confidencestring

            one of high, medium, low

          • userSuppliedboolean
        • disclosurestring

          one of public, private, restricted

        • durabilitystring

          one of durable, time_sensitive

        • confirmedboolean
      • preferenceSignalsarray<object>
        Item fields

        • idstringrequired
        • signalstringrequired
        • kindstringrequired

          one of approval, edit, reject, explicit

        • lastSeenAtstringrequired
        • confidencestring

          one of high, medium, low

        • occurrencesinteger
        • promotedboolean
      • profileDisclosurestring

        one of public, private, restricted

      • metaobject
        Fields

        • schemaVersioninteger
        • confirmedAtstring | null
        • lastInferredAtstring | null
        • lastRefreshedAtstring | null
    • sourcestringrequired

      one of ai, heuristic

  • strategyobjectrequired
    Fields

    • idstring (uuid)required
    • orgIdstring (uuid)required
    • versionintegerrequired
    • statusstringrequired

      one of draft, active, superseded

    • primaryObjectivestringrequired
    • targetAudiencestringrequired
    • pillarsarray<object>required
      Item fields

      • idstringrequired
      • namestringrequired
      • descriptionstring
      • priorityinteger
      • keywordsarray<string>
    • channelPrioritiesarray<object>required
      Item fields

      • platformstringrequired

        one of x, linkedin, tiktok, reddit, facebook, instagram, youtube, bluesky, threads

      • enabledboolean
      • priorityinteger
      • postsPerWeeknumber
    • contentMixarray<object>required
      Item fields

      • contentTypestringrequired

        one of educational, opinion, personal, community, promotional

      • targetPercentnumberrequired
    • metaobjectrequired
      Fields

      • schemaVersioninteger
      • generatedAtstring | null
      • confirmedAtstring | null
      • confirmedBystring (uuid) | null
      • lastEditedAtstring | null
      • lastSuggestedAtstring | null
    • createdAtstringrequired
    • updatedAtstringrequired
    • sourceGoalstring | null
    • positioningAnglesarray<string>
    • opportunitiesarray<object>
      Item fields

      • idstringrequired
      • themestringrequired
      • rationalestring
      • statusstring

        one of open, exploring, done, dismissed

    • prioritiesarray<object>
      Item fields

      • idstringrequired
      • textstringrequired
      • startsAtstringrequired
      • endsAtstring | null
      • statusstring

        one of active, expired, cancelled

      • createdAtstring
      • createdBystring (uuid) | null
    • guardrailNotesarray<string>
    • recommendationsarray<object>
      Item fields

      • idstringrequired
      • summarystringrequired
      • createdAtstringrequired
      • rationalestring
      • proposedChangestring
      • statusstring

        one of pending, accepted, rejected

    • confidencestring

      one of high, medium, low

Request

curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/onboarding/from-website" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"websiteUrl":"string"}'