iPolloWork Docs

API reference

Orient to the iPolloWork API surface, its resource groups, and the repository OpenAPI contract.

The iPolloWork repository includes an OpenAPI contract at packages/docs/openapi.json. It describes the resource families for organization, authentication, configuration, connectors, plugins, Skills, workers, and related control-plane actions.

This reference is an orientation layer for the API. Use the generated OpenAPI document as the authoritative request and response contract for a specific endpoint.

System flowAPI responsibility map

Requests are grouped by the type of resource they control. Runtime work and organization control are intentionally separate concerns.

  1. 01Identity

    Authentication, current user, organization, members, roles, and invitations.

  2. 02Configuration

    Config objects, versions, plugins, Skills, and marketplace resources.

  3. 03Connections

    Provider catalogs, connector accounts, targets, mappings, and sync activity.

  4. 04Runtime

    Workers, hosted runtime state, tokens, and scoped operations.

API splitThe workspace server and Den API solve different problems

Read the local server documentation for work that touches a local workspace. Read OpenAPI for organization-managed capabilities. Neither plane should impersonate the other.

01
Local iPolloWork Server

Filesystem-backed work runtime

Workspace state

Sessions, files, artifacts, audit, approvals, and scoped workspace health.

Runtime adapter

The supported OpenCode proxy and local capability boundary.

02
Den OpenAPI

Organization and Cloud capability plane

Identity and policy

People, organizations, roles, invitations, and resource access.

Shared capabilities

Config objects, plugins, Skills, model providers, connectors, and hosted Workers.

Start with the resource boundary

NeedResource family
Inspect the current person or organization/v1/me, /v1/org, /v1/members, /v1/roles
Manage reusable configuration/v1/config-objects, /v1/plugins, /v1/skills, /v1/skill-hubs
Connect external services/v1/connector-accounts, /v1/connector-instances, /v1/connectors/github/*
Manage model providers/v1/llm-provider-catalog, /v1/llm-providers
Manage hosted workers/v1/workers

Read OpenAPI and integration before building a client. Use Local Server reference for workspace-facing routes and Control-plane resource map for the Den API graph. The focused pages then cover authentication and access, configuration resources, workers and connectors, and runtime, workers, and webhooks.