Skip to content

The KOLDOS API

Two ways in. The local API runs on your own computer today and gives any compatible client the whole KOLDOS turn. The hosted API, KOLDOS as a service, is planned with the same format.
Local API
Available
Hosted API
Planned
Hosted access
Manual approval

Getting started

From zero to a first turn

  1. 01

    Start the local API

    Run koldos serve on the computer where KOLDOS is installed. It listens on 127.0.0.1:8128.

    Local API reference
  2. 02

    Send a turn

    Use any client that speaks the common chat completions format, with the model koldos. Build one below.

  3. 03

    Ask about hosted access

    The hosted API is planned. Planned window: Dec 30, 2026 to Feb 10, 2027. A planned window, not a fixed release date. Developer access is provided manually. Contact itzkoldkir on Discord to request API access.

    Discord username

    itzkoldkir

  4. 04

    Keys and credits

    When the hosted service starts, keys, usage and credits live in the dashboard. The full key is shown once.

    Sign in

Request builder

Build a chat completion request

Pick the local or the hosted API, write the request and copy it in curl, JavaScript or Python.
The hosted API is a planned service with a draft specification. The local API described alongside it already exists and runs on your own machine.

Target

Runs on your computer with koldos serve. This request works today against a running KOLDOS.

Sent as the user message. KOLDOS runs one turn for it.

temperature, max_tokens, top_p are accepted and ignored. KOLDOS sets its own budgets for every turn.

Generated request · local API
curl http://127.0.0.1:8128/v1/chat/completions \
  -H "Content-Type: application/json" \
  -d '{
    "model": "koldos",
    "messages": [
      {
        "role": "user",
        "content": "Explain what the function main does in src/app.py."
      }
    ]
  }'

This page never sends requests or asks for a key. Run the snippet from your own environment.

Developer portal

Local API at http://127.0.0.1:8128/v1. The hosted API is planned at , which is not deployed.

  1. 01

    API overview

    What the API is, how it differs from KOLDOS Local, and the current state of the specification.

    Overview
  2. 02

    Authentication

    An API key in the Authorization: Bearer header. Dashboard sign-in uses Discord through the KOLDOS backend.

    Authentication
  3. 03

    API keys

    Created and revoked in the dashboard. The full key is shown once and never stored by this site.

    Managing keys
  4. 04

    Models

    Listed per key by GET /models. Which models the API serves: Pending. Not published yet

    Models
  5. 05

    Credits

    Each use costs a fixed number of credits: text 1, search 2, vision 3, deep research 8.

    Credits
  6. 06

    Usage

    Daily requests, tokens and credits, plus a per-request log, in the dashboard.

    Usage and logs
  7. 07

    Rate limits

    Per plan, reported in response headers. Values: Pending. Not published yet

    Rate limits
  8. 08

    Errors

    A JSON error object with a stable code and an HTTP status.

    Error codes
  9. 09

    Examples

    Requests in curl, JavaScript and Python, built from the parameters you choose.

    Examples
  10. 10

    SDK information

    No official SDKs have been published. Any HTTP client works.

    SDKs
  11. 11

    Changelog

    No API changes have been published. The specification is still a draft.

    Changelog
  12. 12

    Status

    Health of the API, authentication, model services and this portal, when a status feed is connected.

    Status page

Local endpoints

Available

Hosted endpoints

Planned

Service status

Status page

PreviewNo status feed is connected, so no health is shown.

  • API

    No data. No status feed is connected yet.
  • Authentication

    No data. No status feed is connected yet.
  • Model services

    No data. No status feed is connected yet.
  • Developer portal

    No data. No status feed is connected yet.

No live status feed is connected. Account service on this site: Not live.

Plans

Pricing

Free, Premium, Developer, API. Prices are set; access to the hosted service is granted by hand.

Keys, usage and credits live in the dashboard

Sign in with Discord to manage them once your access is approved.