Documentation
Everything you need to build and run your revenue engine. From database schema to workflow automation to AI agents — the Orbitype documentation walks you through the entire platform step by step.
Popular searches:
Start
Orbitype is the workspace where you talk to Intelligence, keep data, find leads, and build apps.
- 1StartOrbitype is the workspace where you talk to Intelligence, keep data, find leads, and build apps.
- 2Create an accountYou create an account with your email, then confirm that email before the workspace opens.
- 3Create a workspaceYou create a workspace before you add data, leads, or apps.
- 4Find your way aroundThe sidebar is how you move through the workspace.
- 5Words Orbitype usesThese words mean one thing in Orbitype. Later pages use them without defining them again.
- 6Pin a pageA pin is a shortcut in the sidebar to a data page, an app, or a workflow in this workspace.
Intelligence
Intelligence is the assistant in Chat. You describe the outcome. It works with the data in this workspace.
- 1IntelligenceIntelligence is the assistant in Chat. You describe the outcome. It works with the data in this workspace.
- 2Ask IntelligenceYou get a first result by asking one clear question in Chat.
- 3Chat, history, and filesYou resume an old chat, attach a file, and approve actions from the same screen.
- 4Read InsightsInsights shows a readiness score and a list of recommendations for this workspace.
Your data
Your data is the database and the files in this workspace.
- 1Your dataYour data is the database and the files in this workspace.
- 2Open a tableYou open a table from its connector and read the rows.
- 3Open a fileYou open a file from a storage connector and preview it in the workspace.
- 4Run SQL in the editorThe SQL editor runs a statement on the connector you have open and shows the rows.
- 5Edit structured content in the tree viewThe tree view reads a JSON value or a row and gives you fields instead of raw text.
- 6Hide tables and set aliasesDatabase settings control which tables people see and what those tables are called.
- 7Follow a foreign keyA foreign key points from one row to a row in another table. Orbitype uses it so you can pick the related record.
- 8Create a table with the SQL wizardThe SQL wizard creates a table from a description. You do not write the CREATE statement yourself.
- 9Record viewsGrid, table, tree, and code are views of the same record. Images, video, and PDFs open from storage.
- 10Import a file into a tableImport loads a CSV or JSON file into a SQL table after you match file fields to columns.
- 11Export a tableExport downloads the rows of the table you have open as JSON or CSV.
Lead Finder
Lead Finder searches contacts, shows the credit cost, and imports the rows you unlock into a table.
Your first app
An app is a page you build on workspace data. A dashboard is an app.
- 1Your first appAn app is a page you build on workspace data. A dashboard is an app.
- 2Connect an app to the databaseA server action reads the database with the API key that already belongs to the workspace.
- 3Read and write your first recordsThe page calls the server action. The action inserts a row and returns it.
- 4Use the app engineOrbi.exec runs the same runtime as a workflow node, from the page, without a saved action.
- 5Publish an appYou choose who can open the app, then share the link or embed it.
- 6Build a dashboardA dashboard is an app that reads a table and renders the numbers.
- 7Build a form or calculatorA form or a calculator is an app. This page is the full example.
Automate
A workflow repeats a sequence you define. An agent chooses actions from the tools you give it.
- 1AutomateA workflow repeats a sequence you define. An agent chooses actions from the tools you give it.
- 2Build a workflowA workflow is a chain of nodes. Each node is a function. The next node receives the previous result.
- 3Build an agentAn agent uses tools and a prompt. You run it with a message.
- 4Install a templateInstall copies a template from the Store into a workspace.
- 5Use the built-in agent toolsA tool is a function the agent may call. Orbitype includes tools for search, leads, your database, email, calendars, files, and LinkedIn.
- 6Choose a modelEach agent run uses the model you set on that agent. Chat has the same kind of choice.
- 7Read a workflow runA run writes an execution trace. Versions keep earlier saves. Copy and paste duplicate a workflow.
- 8Write a custom toolA custom tool is a function you write. The agent may call it when the description matches the task.
Workspace settings
Workspace settings change this workspace. Account settings change you.
- 1Workspace settingsWorkspace settings change this workspace. Account settings change you.
- 2Rename the workspaceGeneral is where you change the workspace name, avatar, and default language.
- 3Set the business profileThe business profile is the company description Intelligence and research agents read.
- 4Invite membersMembers are the people in this workspace. Roles decide what they can change.
- 5Add a domainA domain points a hostname at a public app.
- 6Read workspace usageUsage on the workspace lists what this workspace spent.
- 7Add a connectorA connector is a database or a file store the workspace can open.
- 8Connect an accountCredentials let workflows, agents, and Chat act in the services you connect.
- 9Add an MCP serverAI Integrations (MCP) is where this workspace calls an MCP server you already run.
- 10Create an API keyAn API key is scoped to one connector. SQL and S3 requests send it as the X-API-KEY header.
- 11Schedule research agentsResearch agents scan the workspace and write recommendations you read in Insights.
- 12Set the workspace languageGeneral settings hold the workspace name, the picture, and the default language for members.
Account settings
Account settings belong to you. They are not tied to one workspace.
- 1Account settingsAccount settings belong to you. They are not tied to one workspace.
- 2Update your personal detailsPersonal details are your name, avatar, email preferences, theme, and language.
- 3Switch workspaceMy workspaces lists the workspaces you belong to.
- 4Plan and billingYou pay for seats, then for what the workspace uses. 1 USD is 100 credits.
- 5Read account usageAccount usage is the sponsor ledger across workspaces.
- 6Open the partner programPartner program gives you a referral link to the partner portal.
- 7Cancel the accountYou cancel the subscription from Plan.
APIs
The SQL API reads and writes rows. The S3 API reads and writes files. The MCP endpoint lets an external client call both with the same API key.
- 1APIsThe SQL API reads and writes rows. The S3 API reads and writes files. The MCP endpoint lets an external client call both with the same AP...
- 2Call the SQL APIYou send a SQL statement to /api/sql/v1. Named bindings use :name.
- 3Call the S3 APIYou list, read, write, copy, and sign files on the storage connector the API key belongs to.
- 4Call Orbitype from Cursor, Claude, or ChatGPTThe MCP endpoint is https://core.orbitype.com/api/mcp/v1. The API key decides whether the client sees SQL or files.
Runtime
App actions, the app engine, workflow nodes, and agent tools run in one runtime.
- 1RuntimeApp actions, the app engine, workflow nodes, and agent tools run in one runtime.
- 2Write a nodeA workflow node is an async function. input is the previous node. The return value is the next input.
- 3Use the browserbrowser.run starts a headless Chromium, runs your function on one page, and returns what that function returns. You read pages, follow li...
- 4Call AI from codeai.chat returns text. ai.image generates an image. Pass true as the second argument to chat when you want JSON.
- 5Search leads from codeleads.search is the Lead Finder search from a node or an action. Import still happens in Lead Finder unless you write the rows yourself.
- 6Search the webserp.search returns search results for a query.
- 7Read a documentocr reads a file into text, a table, or form fields.
- 8Use LinkedIn Advanced from codeConnect LinkedIn Advanced in Credentials first. Then call linkedin from the runtime.
- 9Use Apollo from codeConnect Apollo in Credentials, then search or enrich.
- 10Call an agent, a workflow, or an MCP serveragency runs an agent in this workspace. workflows.run starts another workflow. mcps calls a server you added under AI Integrations.
- 11Call a connected accountA connected account stores an access token on the workspace. A node reads that token and calls the service.
- 12Notify workspace membersYou email people in this workspace from a workflow, an app action, or an agent. Orbitype sends the mail. You do not set up SMTP.
- 13Manage your partner CRM from codeYou read, update, and sync your partner CRM from a workflow, an app action, or an agent.
Go further
These pages are extra tasks. You do not need them to use the workspace.
- 1Go furtherThese pages are extra tasks. You do not need them to use the workspace.
- 2Publish posts from a tableA blog is a site that reads rows from your SQL API.
- 3Read Orbitype from NuxtA Nuxt server route calls the SQL API with your key.
- 4Book a demoYou book a walkthrough on the sales calendar.
- 5Build a page section in an appA hero, a testimonial list, an FAQ, or a text block is markup in an app document.
Store
The Store is where you find templates other people published, and where you keep the templates and components you create.
- 1StoreThe Store is where you find templates other people published, and where you keep the templates and components you create.
- 2ComponentsA component is the unit inside a template. Install turns it into something in your workspace, or leaves it for you to paste.
- 3What a template containsA template is the components you put in it, plus the page that explains them.
- 4Install a templateInstall copies the template's components into one workspace. SQL in the template runs on the database you choose.
- 5Publish a templatePublishing puts your components on a Store page that other people can install.