Skip to Content
Upblit
AboutOpen SourceCommunityDeveloperContactPricing
Star on GitHub—Sign in
CTRL K
  • Introduction
    • AI Gateway Overview
    • Documents
    • Tenants
    • API Reference Overview
    • AI Gateway API
    • API Keys API
    • Applications API
    • Authentication
    • Ingest API (SDK)
    • Organizations API
    • Projects API
    • Telemetry API
    • Users API
    • Architecture Overview
    • Database Architecture
    • Multi-Tenancy
    • Security Model
    • Service Boundaries
    • Telemetry Pipeline
  • DeployX CLI
    • Contributing
    • Architecture Rules
    • Coding Guidelines
    • SDK Development
    • Dashboard Overview
    • AI Gateway
    • API Keys
    • Applications
    • Observability
    • Organizations
    • Profile
    • Projects
    • Quickstart
    • Authentication
    • Your First Project
    • Installation
    • Observability Overview
    • Structured Logs
    • Telemetry Flow
    • Distributed Traces
    • SDK Overview
    • Express SDK
    • Go SDK
    • Java SDK (Coming Soon)
    • Python SDK
    • React SDK (Coming Soon)
  • Introduction
    • AI Gateway Overview
    • Documents
    • Tenants
    • API Reference Overview
    • AI Gateway API
    • API Keys API
    • Applications API
    • Authentication
    • Ingest API (SDK)
    • Organizations API
    • Projects API
    • Telemetry API
    • Users API
    • Architecture Overview
    • Database Architecture
    • Multi-Tenancy
    • Security Model
    • Service Boundaries
    • Telemetry Pipeline
  • DeployX CLI
    • Contributing
    • Architecture Rules
    • Coding Guidelines
    • SDK Development
    • Dashboard Overview
    • AI Gateway
    • API Keys
    • Applications
    • Observability
    • Organizations
    • Profile
    • Projects
    • Quickstart
    • Authentication
    • Your First Project
    • Installation
    • Observability Overview
    • Structured Logs
    • Telemetry Flow
    • Distributed Traces
    • SDK Overview
    • Express SDK
    • Go SDK
    • Java SDK (Coming Soon)
    • Python SDK
    • React SDK (Coming Soon)

On This Page

  • The Hierarchy
  • 1. Create an Organization
  • 2. Create a Project
  • 3. Create an Application
  • 4. Generate an API Key
  • 5. Instrument Your Application
  • 6. View Telemetry
Getting StartedYour First Project

Your First Project

This guide walks through the full hierarchy: Organization → Project → Application → API Key → Telemetry.

The Hierarchy

Organization (e.g., "Acme Corp") └── Project (e.g., "E-commerce Platform") └── Application (e.g., "checkout-api") └── API Key → used by SDK to send telemetry

1. Create an Organization

An organization is your top-level workspace. It can contain multiple projects and multiple team members.

  1. Go to /dashboard/orgs
  2. Click New Organization
  3. Fill in name, description, and optionally upload a logo
  4. Click Create

2. Create a Project

A project groups related applications. Think of it as a product or service boundary.

  1. Click your organization to enter it
  2. Click New Project
  3. Enter a name (e.g., checkout-platform)
  4. Click Create

3. Create an Application

An application is a single deployable service. Each application gets its own API key.

  1. Click your project
  2. Click New Application
  3. Enter:
    • Name: e.g., checkout-api
    • Description: e.g., Handles payment processing
    • Environment: production, staging, or development
  4. Click Create

4. Generate an API Key

  1. On the application card, click Generate API Key
  2. Copy the key immediately — it is shown only once
  3. Store it in your application’s environment variables:
UPBLIT_API_KEY=upblit_live_xxxxxxxxxxxx

5. Instrument Your Application

Add the SDK to your application and pass the API key:

// Express.js const upblit = require('upblit-express') app.use(upblit(process.env.UPBLIT_API_KEY))
// Go sdk := upblit.New(os.Getenv("UPBLIT_API_KEY")) defer sdk.Close()
# Python / FastAPI import upblit, os upblit.init(os.environ["UPBLIT_API_KEY"])

6. View Telemetry

Send a few HTTP requests to your instrumented app. Within 30 seconds (the default flush interval), traces will appear in:

Dashboard → Your Org → Your Project → Observability

You’ll see:

  • Traces — distributed trace spans with timing and status
  • Logs — structured log entries correlated to traces
Last updated on May 27, 2026
AuthenticationInstallation
Upblit

A student-built observability workbench for logs, traces, metrics, API keys, and AI-assisted incident notes.

OAuthAPI scopesTrace contextRetention notes

Product

  • Architecture
  • Dashboard preview
  • AI docs
  • Security
  • Pricing

Developers

  • Developer docs
  • API reference
  • Changelog
  • GitHub
  • Status

Company

  • Support
  • Contact
  • Docs
  • Dashboard
  • Sign in

Legal

  • Privacy Policy
  • Terms
  • Cookie Policy
  • Acceptable Use
  • Data Retention
  • Data Processing

Copyright 2026 Upblit. All rights reserved.

Built for telemetry review, API operations, and incident response.