Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.orkesta.com.tr/llms.txt

Use this file to discover all available pages before exploring further.

The Orkesta platform organizes everything into workspaces, which contain projects, members, and credentials. This page explains each concept and how they relate so you can plan your integration before diving into configuration.

Workspaces

A workspace is the top-level container for your organization in Orkesta. Everything — projects, members, billing, and API keys — lives inside a single workspace. Each workspace has a unique slug that appears in all API endpoint URLs, so you can identify it at a glance and reference it consistently across your integrations.

Projects

A project is the primary unit of work within a workspace. Each project has its own members, settings, and payment data, which lets you isolate environments (for example, production and staging) or separate business units cleanly.
Role assignments at the project level take precedence over workspace-level roles. If you give a member the Viewer role at the workspace level but the Admin role on a specific project, they will have Admin access within that project.

Members and roles

You add people to a workspace as members and assign each member a built-in role that controls what they can see and do.
RoleDescription
AdminFull access to workspace settings, billing, members, and all projects.
MemberCan view and operate within projects they belong to; cannot change workspace-level settings.
ViewerRead-only access to projects they belong to; cannot take any write actions.
For granular control beyond these built-in roles, see Roles and permissions.

API credentials

API keys are scoped to the workspace and grant programmatic access to the Orkesta API. You can create keys with read-only or read-write permissions depending on what your integration needs.
Treat API keys as secrets. Do not commit them to source control or share them in plain text. Rotate a key immediately if it is ever exposed.

Manage your workspace

Configure workspace name, timezone, security settings, SSO, and IP allowlists.

Invite and manage members

Add members by email or CSV import, assign roles, and manage pending invitations.

Roles and permissions

Set up built-in roles, create custom roles, and configure per-project overrides.