Model Router

Update Model Router

Changed on

Update a Model Router configuration. Settings changes append a new version; name and description updates do not. Settings are merged with the current snapshot - omitted fields keep their existing values.

patch/v1/routers/{id}

Request

  • Base URL
    https://api.dev.runwayml.com
  • URL
    https://api.dev.runwayml.com/v1/routers/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The Model Router's primary key ID (UUID).

Headers

X-Runway-Version'2024-11-06' required

The version of the RunwayML API being used. You can read more about versioning here.

Request body

namestring

Display name. The slug is immutable and cannot be changed after creation.

descriptionstring nullable

Response

A named Model Router configuration.

idstring uuid required

The Model Router's primary key ID (UUID). Use it to manage this router via the API; use the slug to reference the router in generation requests.

slugstring required

Immutable slug used to reference this Model Router in generation requests (for example, production-video). Unique within the API project. The UUID id remains the canonical management identifier.

namestring required

Human-friendly Model Router display name shown in the dev portal. Mutable, and not used to reference the router in requests.

descriptionstring nullable required

An optional Model Router description.

versioninteger required

Current settings version. Increments when settings change; name and description updates do not create a new version.

createdAtstring date-time required

When the Model Router was created.

updatedAtstring date-time required

When the Model Router was last updated.

Changes

  • 03955b3cb80cRevision changes
    • breaking

      the / request property type changed from object to no type

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • info

      added subschema #1 subschema #2 to the / request property anyOf list

  • 73a12c23285cRevision changes
    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status