Skip to Content
Gorila docs

Onboarding tools

The plan that sets Gorila up for an organization or a member.

get_onboarding_plan

Get onboarding plan. Changes data.

Use this when the user says "set up Gorila", when the organization or the user hasn't been onboarded yet, or to resume onboarding. Starts or resumes a run and returns its steps and the current one: what to look for with your own connectors (documents, chat, email, tasks, website…), the checklist of what to cover, what to submit, progress (3/11) and open gaps. Org onboarding (owners and the admins of General, once per organization) captures the team's knowledge and the runner's own tasks; personal onboarding (everyone) captures how the user works, privately. To redo it, ask which one unless clear ("the company's or yours?"). Never ask the user how to organize: the categories are fixed.

ParameterTypeRequiredDescription
kind"org" | "personal"noorg or personal. Omit: resumes the run in progress, else org for an owner or General admin whose organization isn't set up yet, else personal. Once the organization is set up, an owner or General admin who omits it is asked which one (nothing starts).
restartbooleannoStart over: abandons your run in progress, or runs a finished onboarding again. Only when the user asks. Nothing is duplicated.
not_nowbooleannoThe user said "not now" to the onboarding you offered: nothing starts, and Gorila stops suggesting it (list_my_tasks, get_workspace) for 7 days. Pass the kind you offered, if you know it.

submit_onboarding_result

Submit onboarding result. Changes data.

Use this after doing an onboarding step from get_onboarding_plan: submit what you found as structured, distilled text (sources, entries, brand_voice, projects, tasks, answers…, only the fields the step asks for). Mark each entry with the checklist keys it covers. Gorila validates it and skips what it already has. New knowledge is published as it comes in (for the team in the organization's setup, private in a personal one), a change to an entry that was already there waits in the inbox, and the user's own tasks go on their board. It answers with what is still missing and the next step. Submit big steps in batches with finished: false. Never send raw documents, emails or chat transcripts.

ParameterTypeRequiredDescription
stepstringyesThe step key from get_onboarding_plan's Submit line, e.g. "brand_tone".
finishedbooleannofalse: a partial batch, the step stays open for more. true (default): the step is done.
sources_usedstring[]noWhere this batch came from: connector names from the sources step, "website", "user files" or "user answers".
sourcesobject[]nosources step only.
websitestringnosources step only: the company's public website, when there is one.
entriesobject[]noKnowledge entries found in this batch (at most 25; submit more batches if needed).
brand_voiceobjectnobrand_tone step only: the brand voice.
projectsobject[]nocompany and questions steps.
product_areasobject[]nocompany step only: products with their own brand, tone, customer or forbidden topics that the user agreed, in this chat, to give an area each. Never without the user's yes.
product_decisionobjectnocompany step, required before finishing it: whether the company has products with their own rules, and why.
tasksobject[]noopen_tasks and my_tasks steps.
task_scope"mine" | "blank"noThe user's answer to "your open tasks, or a blank board?": "mine" brings their own open tasks, "blank" brings none (send it without tasks). Never answer for the user.
tasks_left_outobjectnoHow many tasks you saw in the sources and did not send, as you told the user. Gorila repeats them in its final answer so the user sees what stayed out and why: send the same counts with every batch.
block"saved" | "pasted" | "already" | "declined" | "handed"noalways_on step, or any time after the onboarding closed: what happened with the instruction block. "saved": you saved it yourself after the user's yes (your memory or your instructions file); "handed": you gave it to the user to paste and carried on; "pasted": the user told you it is pasted; "already": it was already there; "declined": the user doesn't want it, or not now.
wake"configured" | "not_now" | "never" | "unavailable"nowake step only: the user's answer about the daily run. "configured": the scheduled run exists now in their client; "not_now" or "never": their answer, never yours; "unavailable": this client can't schedule and they can't create it here either.
answersobjectnoprofile step (About you) only: filled from what you found, never asked one by one.
profileobjectnoprofile step, and open_tasks in the organization's setup: the profile the user just saw and confirmed. Their team sees it; never submit one they haven't seen.
consentbooleannoprofile step (About you) only: true when the user agreed to you reading their past chats; leave it out when you didn't read them.
confirm_task_idsstring[]nomy_tasks step only: draft task ids the user confirms as theirs.
discard_task_idsstring[]nomy_tasks step only: draft task ids that aren't real work.

skip_onboarding_step

Skip onboarding step. Changes data.

Use this when the current onboarding step can't be done: its sources and its plan B gave nothing for it (no fitting connector, nothing on the website or in the chat), the company has nothing for it, or the user declined or answered "later" (e.g. no consent to read chat history, no time for the final questions). Records the reason, which the final summary reports, and returns the next step. A step that reads company material also takes what was checked (checked, pages_seen) and, when pages were seen, what the user said about it (user_said); the error says which one is missing.

ParameterTypeRequiredDescription
stepstringyesThe current step key from get_onboarding_plan's Submit line, e.g. "brand_tone".
reasonstringyesWhy, in English, as a full sentence: the step's title, what you looked for, where, and what you found, e.g. "Skipping Brand tone: no brand guide or copy rules in Notion (only a sales playbook) and no public website."
checkedstringnoSteps that read company material, in English: each source, how you went through it and what you found, e.g. "Notion: listed all 16 pages and searched marca, tono, brand, style guide; no tone or brand page." Not needed for the questions, chat history or a step you already submitted to.
pages_seenintegernoWith checked: how many pages, documents or results you saw in total (0 when there is no source at all).
user_saidstringnoWith pages_seen above 0: what the user said about this step, close to their words and in their language, e.g. "No hay nada más sobre esto en Notion."

complete_onboarding

Complete onboarding. Changes data.

Use this at the last step of onboarding, once every other step is done or skipped. It closes the run: what the setup found is already published, so it publishes anything still waiting, and returns what is in Gorila now (knowledge, tasks, projects, what is marked to double-check), the one thing to propose to the user next, made with what it learned about them, and what to offer after that.

ParameterTypeRequiredDescription
kind"org" | "personal"noWhich run, if you have both in progress. Default: the one at its last step.