Sign in

v1

latestOpenAPI 3.0.02026-07-262088144.5 KB
Router Management

Update router

Update an existing router. Returns a long-running operation (LRO).

patch/router/v1/routers/{router_id}

Path parameters

router_idstring required

Router ID.

Query parameters

update_maskstring

Comma-separated list of fields to update (field mask), e.g. strategy.weighted_load_balancing.routes.

Request body

namestring required

Unique ID of router. Cannot be edited after creation.

Used to call this router in the Chat Completions API by setting the model parameter to inworld/<router-name>.

displayNamestring

Router display name.

Response

A successful response. Returns a long-running operation (LRO).

namestring

The server-assigned operation name.

doneboolean

If true, the operation has completed.

responseobject

The normal response of the operation (if any).