Gateway REST API — Gateway. 198 operations. Lead operation: List Accounts. Self-contained Naftiko capability covering one Fireworks Ai business surface.
Gatewaygetaccountusagefilteroptions — Distinct filter values for an account/time range (serverless + dedicated; for FE, separate -yet mirrors GetAccountUsage).
naftiko: 1.0.0-alpha2
info:
label: Gateway REST API — Gateway
description: 'Gateway REST API — Gateway. 198 operations. Lead operation: List Accounts. Self-contained Naftiko capability
covering one Fireworks Ai business surface.'
tags:
- Fireworks Ai
- Gateway
created: '2026-05-19'
modified: '2026-05-19'
binds:
- namespace: env
keys:
FIREWORKS_AI_API_KEY: FIREWORKS_AI_API_KEY
capability:
consumes:
- type: http
namespace: gateway-gateway
baseUri: https://api.fireworks.ai
description: Gateway REST API — Gateway business capability. Self-contained, no shared references.
resources:
- name: v1-accounts
path: /v1/accounts
operations:
- name: gatewaylistaccounts
method: GET
description: List Accounts
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: pageSize
in: query
type: integer
description: The maximum number of accounts to return. The maximum page_size is 200,
- name: pageToken
in: query
type: string
description: A page token, received from a previous ListAccounts call. Provide this
- name: filter
in: query
type: string
description: Only accounts satisfying the provided filter (if specified) will be
- name: orderBy
in: query
type: string
description: Not supported.
- name: readMask
in: query
type: string
description: The fields to be returned in the response. If empty or "*", all fields will be returned.
- name: v1-accounts-account_id
path: /v1/accounts/{account_id}
operations:
- name: gatewaygetaccount
method: GET
description: Get Account
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: readMask
in: query
type: string
description: The fields to be returned in the response. If empty or "*", all fields will be returned.
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: v1-accounts-account_id-accountUsageFilterOptions
path: /v1/accounts/{account_id}/accountUsageFilterOptions
operations:
- name: gatewaygetaccountusagefilteroptions
method: GET
description: Distinct filter values for an account/time range (serverless + dedicated; for FE, separate -yet mirrors
GetAccountUsage).
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: startTime
in: query
type: string
required: true
- name: endTime
in: query
type: string
required: true
- name: usageType
in: query
type: string
description: If not specified, loads filter options for both usage streams.
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: v1-accounts-account_id-auditLogs
path: /v1/accounts/{account_id}/auditLogs
operations:
- name: gatewaylistauditlogs
method: GET
description: List User Audit Logs
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: startTime
in: query
type: string
description: Start time of the audit logs to retrieve.
- name: endTime
in: query
type: string
description: End time of the audit logs to retrieve.
- name: email
in: query
type: string
description: Optional.
- name: pageSize
in: query
type: integer
description: The maximum number of audit logs to return. The maximum page_size is 200,
- name: pageToken
in: query
type: string
description: A page token, received from a previous ListAuditLogs call. Provide this
- name: filter
in: query
type: string
description: Unused but required to use existing ListRequest functionality.
- name: orderBy
in: query
type: string
description: Unused but required to use existing ListRequest functionality.
- name: readMask
in: query
type: string
description: The fields to be returned in the response. If empty or "*", all fields will be returned.
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: v1-accounts-account_id-batchInferenceJobs
path: /v1/accounts/{account_id}/batchInferenceJobs
operations:
- name: gatewaylistbatchinferencejobs
method: GET
description: List Batch Inference Jobs
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: pageSize
in: query
type: integer
description: The maximum number of batch inference jobs to return. The maximum page_size is 200,
- name: pageToken
in: query
type: string
description: A page token, received from a previous ListBatchInferenceJobs call. Provide this
- name: filter
in: query
type: string
description: Only jobs satisfying the provided filter (if specified) will be
- name: orderBy
in: query
type: string
description: A comma-separated list of fields to order by. e.g. "foo,bar"
- name: readMask
in: query
type: string
description: The fields to be returned in the response. If empty or "*", all fields will be returned.
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: gatewaycreatebatchinferencejob
method: POST
description: Create Batch Inference Job
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: batchInferenceJobId
in: query
type: string
description: ID of the batch inference job.
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: v1-accounts-account_id-batchInferenceJobs-batch_inference_job_id
path: /v1/accounts/{account_id}/batchInferenceJobs/{batch_inference_job_id}
operations:
- name: gatewaygetbatchinferencejob
method: GET
description: Get Batch Inference Job
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: readMask
in: query
type: string
description: The fields to be returned in the response. If empty or "*", all fields will be returned.
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: batch_inference_job_id
in: path
type: string
description: The Batch Inference Job Id
required: true
- name: gatewaydeletebatchinferencejob
method: DELETE
description: Delete Batch Inference Job
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: batch_inference_job_id
in: path
type: string
description: The Batch Inference Job Id
required: true
- name: v1-accounts-account_id-billing-summary
path: /v1/accounts/{account_id}/billing/summary
operations:
- name: gatewaygetbillingsummary
method: GET
description: Get billing summary information for an account
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: startTime
in: query
type: string
description: Start time for the billing period.
required: true
- name: endTime
in: query
type: string
description: End time for the billing period (exclusive).
required: true
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: v1-accounts-account_id-billingUsage
path: /v1/accounts/{account_id}/billingUsage
operations:
- name: gatewaygetaccountusage
method: GET
description: Get account usage (serverless and dedicated deployments).
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: startTime
in: query
type: string
description: Costs returned are inclusive of `start_time`.
required: true
- name: endTime
in: query
type: string
description: Costs returned are exclusive of `end_time`.
required: true
- name: usageType
in: query
type: string
description: Usage type to query usage for
- name: timezone
in: query
type: string
description: IANA timezone identifier for daily aggregation (e.g., "America/Los_Angeles", "Europe/London").
- name: groupBy
in: query
type: array
description: Dimension to group usage by (at most one value; repeated for wire compatibility).
- name: filter
in: query
type: string
description: This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the
map name is Age, the key type is string, and the value type i
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: v1-accounts-account_id-checkpoints-checkpoint_id}:promote
path: /v1/accounts/{account_id}/checkpoints/{checkpoint_id}:promote
operations:
- name: gatewaypromotecheckpoint
method: POST
description: Promote a checkpoint to a model.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: checkpoint_id
in: path
type: string
description: The Checkpoint Id
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: v1-accounts-account_id-clusters
path: /v1/accounts/{account_id}/clusters
operations:
- name: gatewaylistclusters
method: GET
description: List Clusters
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: pageSize
in: query
type: integer
description: The maximum number of clusters to return. The maximum page_size is 200,
- name: pageToken
in: query
type: string
description: A page token, received from a previous ListClusters call. Provide this
- name: filter
in: query
type: string
description: Only clusters satisfying the provided filter (if specified) will be
- name: orderBy
in: query
type: string
description: A comma-separated list of fields to order by. e.g. "foo,bar"
- name: readMask
in: query
type: string
description: The fields to be returned in the response. If empty or "*", all fields will be returned.
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: gatewaycreatecluster
method: POST
description: Create Cluster
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: v1-accounts-account_id-clusters-cluster_id
path: /v1/accounts/{account_id}/clusters/{cluster_id}
operations:
- name: gatewaygetcluster
method: GET
description: Get Cluster
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: readMask
in: query
type: string
description: The fields to be returned in the response. If empty or "*", all fields will be returned.
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: cluster_id
in: path
type: string
description: The Cluster Id
required: true
- name: gatewayupdatecluster
method: PATCH
description: Update Cluster
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: cluster_id
in: path
type: string
description: The Cluster Id
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: gatewaydeletecluster
method: DELETE
description: Delete Cluster
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: cluster_id
in: path
type: string
description: The Cluster Id
required: true
- name: v1-accounts-account_id-clusters-cluster_id}:getConnectionInfo
path: /v1/accounts/{account_id}/clusters/{cluster_id}:getConnectionInfo
operations:
- name: gatewaygetclusterconnectioninfo
method: GET
description: Get Cluster Connection Info
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: readMask
in: query
type: string
description: The fields to be returned in the response. If empty or "*", all fields will be returned.
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: cluster_id
in: path
type: string
description: The Cluster Id
required: true
- name: v1-accounts-account_id-creditRedemptions
path: /v1/accounts/{account_id}/creditRedemptions
operations:
- name: gatewaylistcreditredemptions
method: GET
description: List Credit Redemptions
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: pageSize
in: query
type: integer
description: The maximum number of redemptions to return
- name: pageToken
in: query
type: string
description: A page token, received from a previous ListCreditRedemptions call
- name: filter
in: query
type: string
description: Filter string to filter redemptions
- name: orderBy
in: query
type: string
description: A comma-separated list of fields to order by. e.g. "foo,bar"
- name: readMask
in: query
type: string
description: The fields to be returned in the response. If empty or "*", all fields will be returned.
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: v1-accounts-account_id-datasets
path: /v1/accounts/{account_id}/datasets
operations:
- name: gatewaylistdatasets
method: GET
description: List Datasets
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: pageSize
in: query
type: integer
description: The maximum number of datasets to return. The maximum page_size is 200,
- name: pageToken
in: query
type: string
description: A page token, received from a previous ListDatasets call. Provide this
- name: filter
in: query
type: string
description: Only model satisfying the provided filter (if specified) will be
- name: orderBy
in: query
type: string
description: A comma-separated list of fields to order by. e.g. "foo,bar"
- name: readMask
in: query
type: string
description: The fields to be returned in the response. If empty or "*", all fields will be returned.
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: gatewaycreatedataset
method: POST
description: Create Dataset
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: v1-accounts-account_id-datasets-dataset_id
path: /v1/accounts/{account_id}/datasets/{dataset_id}
operations:
- name: gatewaygetdataset
method: GET
description: Get Dataset
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: readMask
in: query
type: string
description: The fields to be returned in the response. If empty or "*", all fields will be returned.
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: dataset_id
in: path
type: string
description: The Dataset Id
required: true
- name: gatewayupdatedataset
method: PATCH
description: Update Dataset
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: dataset_id
in: path
type: string
description: The Dataset Id
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: gatewaydeletedataset
method: DELETE
description: Delete Dataset
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: dataset_id
in: path
type: string
description: The Dataset Id
required: true
- name: v1-accounts-account_id-datasets-dataset_id}:getDownloadEndpoint
path: /v1/accounts/{account_id}/datasets/{dataset_id}:getDownloadEndpoint
operations:
- name: gatewaygetdatasetdownloadendpoint
method: GET
description: Get Dataset Download Endpoint
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: readMask
in: query
type: string
description: The fields to be returned in the response. If empty or "*", all fields will be returned.
- name: downloadLineage
in: query
type: boolean
description: If true, downloads entire lineage chain (all related datasets).
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: dataset_id
in: path
type: string
description: The Dataset Id
required: true
- name: v1-accounts-account_id-datasets-dataset_id}:getUploadEndpoint
path: /v1/accounts/{account_id}/datasets/{dataset_id}:getUploadEndpoint
operations:
- name: gatewaygetdatasetuploadendpoint
method: POST
description: Get Dataset Upload Endpoint
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: dataset_id
in: path
type: string
description: The Dataset Id
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: v1-accounts-account_id-datasets-dataset_id}:splitDataset
path: /v1/accounts/{account_id}/datasets/{dataset_id}:splitDataset
operations:
- name: gatewaysplitdataset
method: POST
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: dataset_id
in: path
type: string
description: The Dataset Id
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: v1-accounts-account_id-datasets-dataset_id}:validateUpload
path: /v1/accounts/{account_id}/datasets/{dataset_id}:validateUpload
operations:
- name: gatewayvalidatedatasetupload
method: POST
description: Validate Dataset Upload
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: dataset_id
in: path
type: string
description: The Dataset Id
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: v1-accounts-account_id-deployedModels
path: /v1/accounts/{account_id}/deployedModels
operations:
- name: gatewaylistdeployedmodels
method: GET
description: List LoRAs
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: pageSize
in: query
type: integer
description: The maximum number of deployed models to return. The maximum page_size is 200,
- name: pageToken
in: query
type: string
description: A page token, received from a previous ListDeployedModels call. Provide this
- name: filter
in: query
type: string
description: Only depoyed models satisfying the provided filter (if specified) will be
- name: orderBy
in: query
type: string
description: A comma-separated list of fields to order by. e.g. "foo,bar"
- name: readMask
in: query
type: string
description: The fields to be returned in the response. If empty or "*", all fields will be returned.
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: gatewaycreatedeployedmodel
method: POST
description: Load LoRA
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: replaceMergedAddon
in: query
type: boolean
description: Merges new addon to the base model, while unmerging/deleting any existing addon in the deployment.
Must be specified for hot reload deployments
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: v1-accounts-account_id-deployedModels-deployed_model_id
path: /v1/accounts/{account_id}/deployedModels/{deployed_model_id}
operations:
- name: gatewaygetdeployedmodel
method: GET
description: Get LoRA
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: readMask
in: query
type: string
description: The fields to be returned in the response. If empty or "*", all fields will be returned.
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: deployed_model_id
in: path
type: string
description: The Deployed Model Id
required: true
- name: gatewayupdatedeployedmodel
method: PATCH
description: Update LoRA
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: deployed_model_id
in: path
type: string
description: The Deployed Model Id
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: gatewaydeletedeployedmodel
method: DELETE
description: Unload LoRA
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: deployed_model_id
in: path
type: string
description: The Deployed Model Id
required: true
- name: v1-accounts-account_id-deploymentShapes
path: /v1/accounts/{account_id}/deploymentShapes
operations:
- name: gatewaylistdeploymentshapes
method: GET
description: List Deployment Shapes
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: pageSize
in: query
type: integer
description: The maximum number of deployments to return. The maximum page_size is 200,
- name: pageToken
in: query
type: string
description: A page token, received from a previous ListDeploymentShapes call. Provide this
- name: filter
in: query
type: string
description: Only deployment satisfying the provided filter (if specified) will be
- name: orderBy
in: query
type: string
description: A comma-separated list of fields to order by. e.g. "foo,bar"
- name: readMask
in: query
type: string
description: The fields to be returned in the response. If empty or "*", all fields will be returned.
- name: targetModel
in: query
type: string
description: Target model that the returned deployment shapes should be compatible with.
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: gatewaycreatedeploymentshape
method: POST
description: CRUD APIs for deployment shape.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: deploymentShapeId
in: query
type: string
description: The ID of the deployment shape. If not specified, a random ID will be generated.
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: v1-accounts-account_id-deploymentShapes-deployment_shape_id
path: /v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}
operations:
- name: gatewaygetdeploymentshape
method: GET
description: Get Deployment Shape
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: readMask
in: query
type: string
description: The fields to be returned in the response. If empty or "*", all fields will be returned.
- name: skipShapeValidation
in: query
type: boolean
description: If true, returns the latest version regardless of validation status.
- name: account_id
in: path
type: string
description: The Account Id
required: true
- name: deployment_shape_id
in: path
type: string
description: The Deployment Shape Id
required: true
- name: gatewayupdatedeploymentshape
method: PATCH
description: Update Deployment Shape
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: fromLatestValidated
in: query
type: boolean
description: When true, the update will use the latest validated version snapshot as the base
- name: account_id
in: path
type: string
description: The Account Id
required: true
# --- truncated at 32 KB (357 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fireworks-ai/refs/heads/main/capabilities/gateway-gateway.yaml