Docs
Sign in

Add a model connection.

Starts untested.

POST/api/v1/connections

Scopeconfig

Store its credential with PUT /connections/{id}/secret, then test it. No path or query parameters.

Headers.

Idempotency-Keystring

Makes a retry safe: the same key with the same request returns the first answer and does nothing else.

Body.

namestringrequired

A name for the connection, shown in the dashboard. At least 1 character.

harnessenumrequired

The coding agent program that runs the model. A machine runs it only when that harness is installed there. One of claude-code, pi, codex.

providerenumrequired

Who serves the model. One of anthropic, morph, openai, custom.

modelstringrequired

The model agents use when a launch names none. At least 1 character.

authenumrequired

How the harness signs in. local_login uses the sign-in already on one paired machine, so it never runs on a cloud VM. One of local_login, oauth_token, api_key, boat_profile.

baseUrlstring

The provider's address, for a custom provider or a proxy. A URL.

scopeenumrequired

Where it may run: local on paired machines, cloud on cloud workers, both.

meteringenumrequired

How you pay the provider for it: subscription or metered. Shown in forecasts; Koidog bills nothing.

maxConcurrent1–100required

The most agents that use it at once; the rest wait.

defaultOptionsobject

Options agents use when a launch names none. Default {}.

ShowHide 1 field

effortenum

How much reasoning the model spends, where its harness lets you choose. Left out, the harness's default. One of low, medium, high, xhigh, max.

Response.

201 Created: a Connection. The example has placeholder values.

422 validation_failed
The body does not match its schema; each problem is in details.