Router Management

Update router

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

patch/router/v1/routers/{router_id}

Request

Base URL
https://api.inworld.ai
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/inworld/apis/inworld-text-to-speech-api/docs/router/v1/routers/:router_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

router_idstring required

Router ID.

update_maskstring

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

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.

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).

No recorded changes to this operation across all 1 revision of this API.