Projects & Environments

Rynko uses a two-level organizational hierarchy: Projects and Environments. Understanding this structure helps you organize your work effectively and collaborate with your project members.

Overview

Project (Organization Level)
├── Billing & Subscription
├── Project Members & Roles
├── Asset Gallery
├── Project Analytics (Financial)
└── Environments
    ├── Environment A
    │   ├── Templates
    │   ├── API Keys
    │   ├── Document Logs
    │   ├── Webhooks
    │   └── Environment Analytics (Operational)
    └── Environment B
        ├── Templates
        ├── API Keys
        └── ...

Projects

A Project is your organization-level container. It represents a billing entity and controls who has access to your resources.

API Reference

In the API, projects are referred to as teamId for backward compatibility. See the Projects API for details.

What Belongs to a Project

Feature	Description
Billing & Subscription	Your plan, document credits, and invoices
Project Members	Users who can access project resources
Project Roles	Permissions for project members (Owner, Admin, Member, Viewer)
Project Analytics	Financial metrics like credit usage and cost attribution
Asset Gallery	Images and files used in templates (shared across all environments)
Environments	Resource containers within the project

Project Roles

Role	Capabilities
Owner	Full access, manage billing, delete project
Admin	Manage members, create environments, access project analytics
Member	Access assigned environments, create documents
Viewer	View-only access to assigned environments

When to Use Project-Level Features

Managing who has access to your organization
Viewing billing and subscription information
Understanding overall credit usage and costs
Creating or managing environments

Environments

An Environment is a resource container within a project. Use environments to isolate different projects, clients, or stages.

API Reference

In the API, environments are referred to as workspaceId for backward compatibility.

What Belongs to an Environment

Feature	Description
Templates	Document templates (PDF and Excel)
API Keys	Authentication keys for API access
Document Logs	History of generated documents
Webhooks	Event notification subscriptions
Environment Analytics	Operational metrics like success rates and processing times
API Playground	Interactive API testing

When to Use Environments

Different Clients: Keep client A's templates separate from client B's
Stages: Separate development, staging, and production
Departments: Marketing templates vs. Finance templates
Access Control: Give specific project members access to specific environments

Environment Examples

Acme Corp (Project)
├── Development Environment
│   ├── Test templates
│   ├── Dev API keys
│   └── Test webhooks
├── Production Environment
│   ├── Production templates
│   ├── Production API keys
│   └── Production webhooks
└── Marketing Environment
    ├── Campaign templates
    └── Marketing API keys

Context Modes

Rynko operates in two context modes depending on your selection:

Project-Only Mode

When you have a project selected but no environment:

Available Features: Project settings, project analytics, billing, environment management
Hidden Features: Templates, API keys, document logs, webhooks, API playground

Use this mode when you need to:

Manage project members
View billing information
Check project-level analytics (credit usage, cost attribution)
Create or switch environments

Project + Environment Mode

When you have both a project and environment selected:

All Features Available: Everything from project-only mode plus environment-specific features
Context: Operations happen within the selected environment

Use this mode for day-to-day work:

Creating and editing templates
Generating documents
Managing API keys
Viewing document logs
Setting up webhooks

Selecting Projects and Environments

Using the Header Selector

The header contains two dropdown selectors:

Project Selector (left): Shows your current project and lets you switch
Environment Selector (right): Shows environments in the current project

┌─────────────────────────────────────────────────────────────┐
│  [Acme Corp ▼]  /  [Production ▼]                          │
│   ↑ Project       ↑ Environment                            │
└─────────────────────────────────────────────────────────────┘

Switching Projects

Click the project dropdown in the header
Select a different project
Your environment selection resets (enters project-only mode)
Select an environment to continue working

Switching Environments

Click the environment dropdown in the header
Select an environment, or choose "No Environment (Project Mode)" for project-only mode
Features update based on your selection

From the Pages

You can also select projects and environments from their respective pages:

Projects Page (/teams): View all your projects, click to select
Environments Page (/workspaces): View all environments in current project, click to select

The sidebar navigation adapts to your current context:

Always Visible (Any Mode)

Dashboard
Projects
Environments
Asset Gallery (project-scoped)
Analytics (Project analytics in project-only mode)
Settings
Billing

Environment Required

These features only appear when an environment is selected:

Templates
Template Gallery
Document Logs
API Keys
API Playground
Webhooks

tip

If you try to access an environment-required feature without an environment selected, you'll be prompted to select one.

Analytics: Project vs. Environment

Analytics are split into two tabs based on what you're measuring:

Project Analytics

Financial and billing-focused metrics:

Wallet: Subscription quota, premium credits, billing breakdown
Attribution: Which templates consume the most credits
Projections: When you might run out of resources

Access: Available to project Owners and Admins

Environment Analytics

Operational and performance metrics:

Health: Success rates, error breakdowns, processing times
Insights: Top templates, peak usage times, volume trends

Access: Available in Project + Environment mode to all environment members

API Keys and Environments

API keys are scoped to environments. This means:

Each environment has its own set of API keys
An API key from Environment A cannot access Environment B
When you generate documents via API, they belong to the environment of the API key used

Best Practice

Create separate API keys for:

Different stages (dev/staging/prod)
Different applications
Different access levels

Webhooks and Environments

Webhook subscriptions are environment-scoped:

Webhooks in Environment A only receive events from Environment A
Events from Environment B go to Environment B's webhooks

This allows you to:

Route production events to your production systems
Route development events to testing endpoints
Keep different projects completely isolated

Document Logs and Environments

Document logs show documents generated within the current environment:

Each environment maintains its own log history
Filtering and search only applies to the current environment
Bulk actions only affect documents in the current environment

Common Scenarios

Setting Up for the First Time

Create your project (done during signup)
Create your first environment (e.g., "Production")
Create templates within the environment
Generate API keys for your application

Onboarding a New Project Member

Go to Project Settings
Invite the new member with appropriate role
They can then access environments based on their role

Separating Development and Production

Create a "Development" environment
Create a "Production" environment
Use separate API keys for each stage
Set up webhooks pointing to appropriate endpoints

Managing Multiple Clients

Create an environment for each client
Keep templates, API keys, and logs isolated
Assign project members to relevant environments

FAQ

Can I move templates between environments?

Not directly. You would need to export the template schema and import it in the new environment.

Can one user belong to multiple projects?

Yes, you can be a member of multiple projects. Switch between them using the project selector.

Who can create environments?

Project Owners and Admins can create new environments.

Are credits shared across environments?

Yes, document credits are at the project level and shared across all environments.

Can I delete an environment?

Yes, project Owners and Admins can delete environments. This permanently removes all templates, logs, API keys, and webhooks in that environment.

Related: Project Management | Settings | API Keys

Overview​

Projects​

What Belongs to a Project​

Project Roles​

When to Use Project-Level Features​

Environments​

What Belongs to an Environment​

When to Use Environments​

Environment Examples​

Context Modes​

Project-Only Mode​

Project + Environment Mode​

Selecting Projects and Environments​

Using the Header Selector​

Switching Projects​

Switching Environments​

From the Pages​

Navigation Changes by Context​

Always Visible (Any Mode)​

Environment Required​

Analytics: Project vs. Environment​

Project Analytics​

Environment Analytics​

API Keys and Environments​

Best Practice​

Webhooks and Environments​

Document Logs and Environments​

Common Scenarios​

Setting Up for the First Time​

Onboarding a New Project Member​

Separating Development and Production​

Managing Multiple Clients​

FAQ​

Can I move templates between environments?​

Can one user belong to multiple projects?​

Who can create environments?​

Are credits shared across environments?​

Can I delete an environment?​