Documentation

Learning path

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.

0.0.0

Introduction to Orbitype

Orbitype is a versatile and user-friendly ai agent environment designed to streamline your content management experience. It allows you to efficiently manage and deliver content across various digital platforms, providing seamless integration with S3 storage and SQL/Postgres databases.

In this chapter

  • Building Bridges
  • Why a Learning Path?
  • Introduction for Power-Users
  • Introduction for Developers
0.0.1

How To Register on Orbitype

Here are the instructions on how to register on Orbitype:

In this chapter

  • Access Orbitype Website/App:
  • Provide Basic Information:
  • Navigate to Registration Page:
0.0.2

How To Book Demo on Orbitype

Here are the instructions on how to book a demo on Orbitype:

In this chapter

  • Access Orbitype:
  • Book A Demo:
  • Schedule Meeting:
  • Connect to TidyCal:
0.1.0

Key Features of Orbitype

- Flexible Data Management: Customize your content structure as needed. Create and manage your database schema or store files directly on S3.

- API-Driven Interactions: Orbitype's API-centric approach means you can access and manipulate your data through well-defined endpoints.

- Modular Connectors: The system uses connectors, like the S3 Connector for storage and SQL Connector for database operations, to simplify data handling.

In this chapter

  • Key Features for Power-Users
  • Key Features for Developers
  • Key Features for Agencies
0.2.0

Hierarchy in Orbitype

How Orbitype is structured

In this chapter

  • User Levels
  • Projects
  • Connectors
1.0.0

General Knowledge about Orbitype

A few things to know about Orbitype: it's a customizable SaaS platform that offers strong user role capabilities, flexible data connectivity, and smooth project management for users.

In this chapter

  • SaaS Architecture
  • User Account Structure
  • Project Management
  • User Roles
  • Connector Functionality
  • API Interface
  • Support for Data Structures
1.1.0

The Side Bar

The Orbitype dashboard's sidebar is a user-friendly navigation tool, providing quick access to features and sections for effective content management. Its design adapts to user roles and permissions, ensuring a personalized experience.

In this chapter

  • The Side Bar
  • Explore
  • SQL Editor
  • Settings
  • Project Links
  • My Pins
  • User Profiles
  • Light and Dark Mode
  • Documentation
1.2.0

User Account

Orbitype simplifies user account creation, guiding administrators through quick user addition and role matching, ensuring smooth system integration.

In this chapter

  • Access the User Management Section
  • Navigate to User Details
  • Fill in Email Address
  • Set a Secure Password
  • Enter Full Name
  • Upload a Profile Picture
  • Specify Organization
  • Add Website Link
  • Assign Projects
  • Save User Account
1.3.0

Projects

Managing and configuring project settings in Orbitype allows for seamless integration and customization to fit your needs.

In this chapter

  • Project Settings Overview
  • Company Name
  • Members
  • Adding a Member
  • Connectors
  • Adding a Connector
  • Database
  • Media Storage
  • API Keys
  • Generating an API Key
2.0.0

Overview Pages

In Orbitype, Overview Pages are designed to enhance your browsing experience by providing two distinct ways to view and interact with your content: Grid View and Table View. These views offer flexibility in how data and files are presented, catering to different user preferences and content types. Additionally, Orbitype incorporates hidden settings that automatically customize your experience based on your interactions, ensuring a seamless and personalized interface without requiring manual configuration.

In this chapter

  • Table View
  • Grid View
  • Personal Language Settings on Orbitype's Overview Page
  • Customization and Seamless Experience
3.0.0

Single Pages

In Orbitype, Single View Pages are a crucial concept, especially designed for displaying individual content items in detail. These pages are dedicated to showcasing a specific piece of content, such as an article, image, video, or any custom content type, in isolation from other content on the site. This approach is particularly beneficial for highlighting the intricacies and details of a single content item, providing a focused and enhanced user experience.

The implementation of Single View Pages allows content creators and developers to tailor the presentation and functionality of these pages to the specific needs of the content they're displaying. This could include custom layouts, interactive elements, or additional metadata, enhancing the engagement and accessibility of the content.

In this chapter

  • Configure your screen as you like
  • Single View - Tree - Code-Meta
3.1.0

Tree View

The Tree View reads your json or Database Structure and Matches the following Field Types to give you an easy to edit interface on any data structure.

In this chapter

  • Text Leaf
  • Boolean Leaf
  • Date Leaf
  • File Leaf
  • Multilang Leaf
  • Number Leaf
  • Richtext Leaf
  • Select Leaf
  • ID Leaf
  • Relational Leaf
  • Chip Leaf
  • Conclusion
3.2.0

Code View

Code view in Orbitype and similar headless CMS allows direct manipulation of underlying markup, offering precise control for developers and experienced users.

In this chapter

  • Code View
  • Code View Functionalities
3.3.0

Meta View

The Meta View centralizes the management and organization of metadata, crucial for optimizing content, search, and user experience.

In this chapter

  • Meta View
  • Meta View Funcionalities
3.4.0

Image View

Explore images of your S3 Storage in detail with Orbitype's Image View. Click any image file in the cloud storage to enjoy a full-screen display, offering clarity beyond thumbnails or lists. Perfect for a closer look!

In this chapter

  • Image View
3.5.0

Video View

Streamline your video content management in Orbitype with the Video View feature. Access, review, and manage videos directly within the CMS's cloud storage, eliminating the need for external players or downloads. Simplify your content workflow effortlessly.

In this chapter

  • Video View
3.6.0

PDF View

Effortlessly manage PDF documents with Orbitype's PDF View feature. View and interact with PDFs directly in the cloud storage, bypassing downloads and external apps. Ideal for quick access, review, and management of PDF content within the CMS environment.

In this chapter

  • PDF VIEW
4.0.0

Orbitype for Developer

Orbitype is a managed headless CMS that supports a variety of data sources.

Connect S3 compatible object storages, SQL databases and more.

Use a simple RESTful API to modify your data programmatically

or edit it with an automatically generated visual GUI.

In this chapter

  • Getting started
  • Managing Projects
4.1.0

API Authentication

Orbitype exposes a full-featured RESTful API that you can connect to from your

own code. Read, create, update, and delete items with simple HTTP requests.

In this chapter

  • First steps
  • Authentication Headers
  • Copy-paste config (Cursor, Production)
  • Copy-paste config (Claude Desktop, Production)
  • MCP endpoint (Core)
  • MCP discovery and context
  • Available MCP tools
  • S3 prefix enforcement
  • Claude Desktop MCP setup
  • Cursor MCP setup
  • ChatGPT MCP setup
4.2.0

S3 API

For S3 connectors, the API exposes endpoints to read and write files.

In this chapter

  • Index
  • Show
  • Store
  • Destroy
  • Copy
  • Upload
4.3.0

SQL API

For SQL connectors, the API exposes an endpoint to execute prepared SQL

statements. The HTTP Method conveys intention, but you may pass any valid

combination of sql and bindings.

In this chapter

  • Index
  • Show
  • Create
  • Update
  • Destroy
4.4.0

Database settings

Fine-tune how Orbitype interacts with your database. Among other things, you can hide tables from non-technical users and define aliases.

In this chapter

  • Hiding tables
  • Table aliases
4.5.0

Foreign keys

Databases establish relationships between entities via foreign keys. Orbitype can resolve these reference and make it easy to add, change and analyze relationships.

In this chapter

  • Referencing another entry
  • Referencing multiple other entries
4.6.0

SQL wizard

Use the SQL wizard to quickly and easily create database tables. Even without any coding knowledge, you'll be able to create whatever data structure you need.

In this chapter

  • Templates
  • Columns
5.0.0

Credentials

All the credentials of an Orbitype workspace can be accessed in workflows. There, you can use the credentials to authenticate with the API, third-party APIs, and also utilize them as central variables for your workspace.

In this chapter

  • Access Credentials in Workflows
  • OAuth Integrations
6.0.0

Workflows

Workflows enable users to build their own automations inside their workspaces.
"Workflows" consist of "Nodes," which can be seen as serverless functions that can be connected with each other.

In this chapter

  • Trigger
  • Versions/restore
  • Node types
  • Node settings
  • Node function structure + logging
  • Node Output / Next node param
  • Flow types
6.1.0

Agents

For non deterministic workloads, you can use Orbitype Agents. They are scoped to workspaces and can be called from any code execution context in Orbitype.

In this chapter

  • Agent Tools
  • Agency
6.2.0

Runtime Environment

Orbitype has a shared runtime environment which is accessible to agents through their tools, workflows in their nodes, artifacts in their server actions, and to Orbitype Intelligence in the interactive execution mode.

In this chapter

  • Orbitype Environment Injections
  • Leads Database
  • Apollo Integration
  • Agency
  • Agent
  • SERP
  • Browser
  • AI
  • OCR
  • LinkedIn (advanced)
  • Libraries
  • SheetJS (XLSX): Spreadsheet processing
7.0.0

Artifacts

Build and publish external forms and interactive calculators in Orbitype—without running separate frontend or backend projects.

In this chapter

  • What Are Orbitype Artifacts?
  • Build an External Form or Calculator
  • Connect UI to Backend Actions
  • Publish, Share, and Embed
  • Best Practices & Troubleshooting
8.0.0

External Forms & Interactive calculators

Nowadays, you no longer need to install your own software to integrate forms.

In this chapter

  • Our approach
  • Example:
10.0.0

Usage of Blog Template

Learn how to create a simple blog using Orbitype's Blog Template, and start captivating readers.

In this chapter

  • Navigate to Blog Posts
  • Create a New Post
  • Fill in your Blog Title
  • Fill in your Blog's Body
  • Add a Featured Image
  • SEO Optimization
  • Add a Lead
  • Save as a Draft
  • Or, Publish it immediately
10.0.0

Cookbook - Sections

Modern webpages are often composed of many different sections.

Things like hero banners, testimonials, FAQs or simple text blocks.

Developers implement these as reusable components with props.

But how do we allow non-technical people to use them in Orbitype?

In this chapter

  • From HTML to JSON
  • Dynamic templates
10.0.0

Cancel Account

To ensure you’re comfortable using Orbitype, we want to make sure everything is clear. If you have any questions or encounter issues understanding how something works, please don’t hesitate to reach out. We’re here to assist you—just send us a message at support@orbitype.com, and we’ll be happy to help you with any questions you have.

In this chapter

  • How to cancel
10.0.0

Nuxt integration

Orbitype can easily be integrated into the popular Vue Framework Nuxt.

In this chapter

  • Quick start
  • Move Data to Orbitype
  • Advanced usage
  • Setup Nuxt Server Function
  • Server Function Send Data
  • Server Function Send Data
  • Call Server Function from Nuxt Template
10.0.0

Detailed Pricing

A seat costs 20 USD per month. After that, you only pay for what you use.

Orbitype uses a transparent credit system where 1 USD = 100 Credits. All seats, usage, and add-ons are billed in credits and assigned to the Workspace Sponsor.

In this chapter

  • Quick Links
  • Core Principle
  • How Billing Works
  • Instant Credit Purchases
  • Settlement and Metering
  • Payment Outcomes
  • Ledger and Rounding Notes
  • Seats
  • Monthly Base Charges and Provisions
  • Included Infrastructure and Expandable Resources
  • Agent Runtime and Orbitype Intelligence
  • Core AI Chat
  • AI in Workflows and Code
  • Automations and Execution
  • Platform Actions and Tools
  • Image Generation
  • Artifacts
  • Leads Database Pricing
  • Premium Integrations
  • Storage and File Usage
  • Database Usage
  • MCP billing
  • Prepaid Credits and Orders
  • Payments and Continuity
  • Free Credits and Vouchers
  • Free for Agencies
  • Typical Examples