Skip to content
Kindgi

Stream adapter preparation events (SSE)

POST
/v1/adapters/{adapterId}/prepare
curl --request POST \
  --url https://example.com/v1/adapters/example/prepare \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

SSE stream (text/event-stream). Iterates the adapter factory’s prepare(params) async generator and emits each yielded PrepareEvent as an SSE data: frame — used for warmup progress on in-process adapters (model download, cache priming, etc.). Body carries adapter-specific params and is passed through unchanged. Returns 404 when the adapter id is unknown to the in-process factory registry, and 400 bad-input when the adapter has no prepare() implementation (e.g. remote model providers with nothing to download) or the deployment did not wire an adapterFactories binding.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
adapterId
required
string

AdapterId — stable string chosen by the deployment (e.g. sandbox-primary).

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
string
>= 1 characters

Caller-supplied idempotency key. Retries with the same key return the original response byte-identical (per docs/API-ROUTE-CONVENTIONS.md §3.1).

Request Body

Section titled “Request Body”
Media typeapplication/json
object
key
additional properties
any
Examplegenerated
{}

Responses

Section titled “Responses”

200

Section titled “200”

SSE stream of PrepareEvent frames — adapter-specific payload shape.

Media typeapplication/json
string
Examplegenerated
example

400

Section titled “400”

Adapter has no prepare() implementation, or adapter factories not wired.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

Section titled “404”

No adapter registered with that id.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}