Skip to content
Embabel Worlds

Start the Get-to-Know-Me onboarding flow

POST
/api/v1/onboarding/run
curl --request POST \
  --url http://localhost:11044/api/v1/onboarding/run \
  --header 'Content-Type: application/json' \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>' \
  --data '{ "buildMeApp": true, "lookbackDays": 1, "sources": [ "example" ] }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”

What to profile: sources (required; source ids from GET /onboarding/sources such as email, calendar, osx, and an empty list means every available source), lookbackDays (how many days of activity to read; default 30, not clamped) and buildMeApp (default false; true also builds a Me app from the persona, the expensive part). The run happens in the background and answers 202 with a jobId to poll

Media typeapplication/json

Body of POST /onboarding/run: which sources to profile, how far back, and whether to build a Me app as well

object
buildMeApp
required

Also build a personal Me app (me.html) from the persona once it is saved, which is the expensive step. Defaults to false

boolean
lookbackDays
required

How many days of past activity to profile. Defaults to 30

integer format: int32
sources
required

Source ids to profile, as GET /onboarding/sources lists them (email, calendar, osx). An empty list profiles every source that is available

Array<string>

Example generated

{
  "buildMeApp": true,
  "lookbackDays": 1,
  "sources": [
    "example"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*

The 202 answer to POST /onboarding/run: the job started in the background. Poll GET /onboarding/status/{jobId} for its outcome

object
jobId
required

Id of the started job (a UUID), for GET /onboarding/status/{jobId}

string
status
required

Always started

string