Polimorf Docs
API Reference

Overview

The Polimorf public runtime API — base URL, conventions, and the runtime endpoints for ad-hoc generations and deployed assistants.

The public runtime API is the API-key-authenticated HTTP surface for running generations. The SDK is the recommended integration path, but every operation is a plain HTTPS request you can make from any language.

The dashboard/management API (assistants, workspaces, deployments, …) is a separate, session-authenticated surface for the Polimorf UI and is not part of this reference.

Base URL

All paths are relative to your instance's base URL, with no global prefix:

https://api.polimorf.app

The execute endpoint, for example, is https://api.polimorf.app/runtime/execute.

Authentication

Send your workspace API key as a bearer token on every request:

Authorization: Bearer csk_live_xxxxxxxxxxxxxxxxxxxxxxxx

The runtime endpoints require the runtime:execute scope. See Authentication.

Conventions

  • Request and response bodies are JSON (Content-Type: application/json).
  • Timestamps are ISO-8601 UTC.
  • Non-2xx responses use the error envelope (code, status, message, optional fields).
  • Streaming endpoints return Server-Sent Events.

Endpoints

Method & pathPurpose
POST /runtime/executeRun an ad-hoc, non-streaming generation
POST /runtime/streamStream an ad-hoc generation (SSE)
POST /runtime/assistants/:slugRun a deployed assistant by slug
POST /runtime/assistants/:slug/streamStream a deployed assistant (SSE)

Errors

The Polimorf error envelope, HTTP status mapping, and the typed SDK error classes you can branch on.

Ad-hoc generation

POST /runtime/execute and /runtime/stream — run a generation by specifying the provider, model, and messages on each request.

On this page

Base URLAuthenticationConventionsEndpoints