FIfireworks
Gateway

CRUD APIs for routers. Get Router

get/v1/accounts/{account_id}/routers/{router_id}

Request

  • Base URL
    https://api.fireworks.ai/inference
  • Auth
    HTTP bearer

Path parameters

account_idstring required

The Account Id

router_idstring required

The Router Id

Query parameters

readMaskstring

The fields to be returned in the response. If empty or "*", all fields will be returned.

Response

A successful response.

namestring
displayNamestring
createTimestring date-time
createdBystring
state'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'UPDATING' | 'DELETING'
  • CREATING: The router is being created.
  • READY: The router is ready for access.
  • UPDATING: There are in-progress updates happening with the router.
  • DELETING: The router is being deleted.
deploymentsstring[]

The deployment names to be covered by the router.

modelstring

The model name to route requests to. model is only applicable to single-region deployments. For multi-region deployments, model must be empty.

weightedRandomGatewayWeightedRandomStrategy

Use replica count as weight.

evenLoadGatewayEvenLoadStrategy

Dynamically adjust traffic allocation to balance the load per replica across the deployments as much as possible.

aliasesstring[]
autoGeneratedboolean

auto_generated indicates this router was generated by the system for a deployment. Auto-generated routers cannot be updated or deleted by the user.

publicboolean

True if the router is public (any account can query the underlying workload), false if the router is private (only the account that owns the router can query the underlying workload).

Changes

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