Skip to main content

Overview

Admin endpoints manage platform-level configuration including API keys, organizations, subscription tiers, and the enrichment pipeline. Most require ADMIN role access.
Most developers interact with API keys and organization settings through the Podium Developer Portal. The admin API is for programmatic management and platform-level automation.

API Key Management

Create a Key

The full API key is only returned once at creation time. Store it securely — subsequent queries return a masked version.

List Organization Keys

Get Key Details

Deactivate a Key

Setting isActive: false immediately blocks all requests using this key.

Rotate a Key

Key rotation:
  1. Generates a new key value for the same key ID
  2. Invalidates the old key value
  3. Publishes an api-key-changed event to flush caches across all API instances
  4. Returns the new full key (one-time display)

Delete a Key

Permanently removes the key. This cannot be undone.

Organizations

List Organizations

Create an Organization

Get Organization Details

Organization Settings

Settings control organization-specific behavior like blockchain preferences, x402 configuration, and reward modes.

Update Settings

App Configuration

Global application configuration:

Subscription Tiers

List Tiers

Get Tier Details

Campaign Administration

Admin-level campaign management across the organization:

List All Campaigns

Approve or Reject a Campaign

Valid transitions: SUBMITTEDAPPROVED or SUBMITTEDDRAFT (rejection).

Enrichment Pipeline

Admin endpoints for managing the enrichment pipeline.

Trigger Source Ingestion

Dispatches an enrichment-crawl event for the specified source. The system fetches and processes data, then queues it for AI-powered extraction.

Ingest Products from a Domain

Discover Product URLs on a Domain

Dry-run endpoint to preview which product URLs Podium would find on a domain, without ingesting anything:

Trigger Product Discovery

Discover and ingest products from shopping search results. Provide specific queries, filter by category, or omit both to run the full discovery catalog:

Discovery Catalog Stats

View the discovery query catalog — how many queries are available per category:

Recompute Baselines

Omit productId to recompute all stale baselines. For immediate (synchronous) recomputation:

Baseline Statistics

View detailed statistics across all three baseline levels (product, category, market):

Pipeline Status

Catalog Sync

Sync enrichment data into the companion product catalog. Creates ProductCatalogItem records from enrichment raw records:

Reprocess Unprocessed Records

Re-queue all unprocessed raw records for AI-powered attribute extraction:

Manage Enrichment Sources

Create a Source

List Sources

Enrichment Endpoint Summary

Task Administration

See Task Pool API for details.

Endpoint Summary