Fireworks AI gateway.openapi_Gateway API
The gateway.openapi_Gateway API from Fireworks AI — 126 operation(s) for gateway.openapi_gateway.
Fireworks AI gateway.openapi_Gateway API is one of 10 APIs that Fireworks AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes 198 operations across 126 paths, and defines 255 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against a single base URL, https://api.fireworks.ai/inference.
198 operations
126 paths
255 schemas
25 DELETE90 GET22 PATCH61 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Fireworks AI gateway.openapi_Gateway API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (API_KEY) (BearerAuth).
By default, every request must be authenticated.
BearerAuth— Bearer authentication using your Fireworks API key. Format: Bearer
Paths & Operations 198
Across 126 paths, the API surfaces 198 operations — 25 DELETE, 90 GET, 22 PATCH, 61 POST. Each is listed below with its method, path, parameters, and response codes.
gateway.openapi_Gateway 198
GET
/v1/accounts
List Accounts
POST
/v1/auth/refresh
Refresh a session JWT before expiry with a fresh TTL.
POST
/v1/creditCodes:redeem
APIs for credit codes. Redeem Credit Code
POST
/v1/validateModelConfig
Validate Model Config
GET
/v1/accounts/{account_id}
Get Account
GET
/v1/accounts/{account_id}/accountUsageFilterOptions
Distinct filter values for an account/time range (serverless + dedicated; for FE, separate -yet mirrors GetAccountUsage).
GET
/v1/accounts/{account_id}/auditLogs
List User Audit Logs
GET
/v1/accounts/{account_id}/batchInferenceJobs
List Batch Inference Jobs
POST
/v1/accounts/{account_id}/batchInferenceJobs
Create Batch Inference Job
GET
/v1/accounts/{account_id}/batchInferenceJobs/{batch_inference_job_id}
Get Batch Inference Job
DELETE
/v1/accounts/{account_id}/batchInferenceJobs/{batch_inference_job_id}
Delete Batch Inference Job
GET
/v1/accounts/{account_id}/billing/summary
Get billing summary information for an account
GET
/v1/accounts/{account_id}/billingUsage
Get account usage (serverless and dedicated deployments). Optionally filter by usage type via the usagetype field. If not specified, returns all usage types. TODO: rename this to /accountUsage
POST
/v1/accounts/{account_id}/checkpoints/{checkpoint_id}:promote
Promote a checkpoint to a model. The checkpoint is identified by account + snapshot ID; the trainer job ID is passed in the request body to resolve the GCS bucket.
GET
/v1/accounts/{account_id}/clusters
List Clusters
POST
/v1/accounts/{account_id}/clusters
Create Cluster
GET
/v1/accounts/{account_id}/clusters/{cluster_id}
Get Cluster
PATCH
/v1/accounts/{account_id}/clusters/{cluster_id}
Update Cluster
DELETE
/v1/accounts/{account_id}/clusters/{cluster_id}
Delete Cluster
GET
/v1/accounts/{account_id}/clusters/{cluster_id}:getConnectionInfo
Get Cluster Connection Info
GET
/v1/accounts/{account_id}/creditRedemptions
List Credit Redemptions
GET
/v1/accounts/{account_id}/datasets
List Datasets
POST
/v1/accounts/{account_id}/datasets
Create Dataset
GET
/v1/accounts/{account_id}/datasets/{dataset_id}
Get Dataset
PATCH
/v1/accounts/{account_id}/datasets/{dataset_id}
Update Dataset
DELETE
/v1/accounts/{account_id}/datasets/{dataset_id}
Delete Dataset
GET
/v1/accounts/{account_id}/datasets/{dataset_id}:getDownloadEndpoint
Get Dataset Download Endpoint
POST
/v1/accounts/{account_id}/datasets/{dataset_id}:getUploadEndpoint
Get Dataset Upload Endpoint
POST
/v1/accounts/{account_id}/datasets/{dataset_id}:splitDataset
POST
/v1/accounts/{account_id}/datasets/{dataset_id}:validateUpload
Validate Dataset Upload
GET
/v1/accounts/{account_id}/deployedModels
List LoRAs
POST
/v1/accounts/{account_id}/deployedModels
Load LoRA
GET
/v1/accounts/{account_id}/deployedModels/{deployed_model_id}
Get LoRA
PATCH
/v1/accounts/{account_id}/deployedModels/{deployed_model_id}
Update LoRA
DELETE
/v1/accounts/{account_id}/deployedModels/{deployed_model_id}
Unload LoRA
GET
/v1/accounts/{account_id}/deploymentShapes
List Deployment Shapes
POST
/v1/accounts/{account_id}/deploymentShapes
CRUD APIs for deployment shape. Create Deployment Shape
GET
/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}
Get Deployment Shape
PATCH
/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}
Update Deployment Shape
DELETE
/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}
Delete Deployment Shape
GET
/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}/versions
List Deployment Shapes Versions
GET
/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}/versions/{version_id}
Get Deployment Shape Version
PATCH
/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}/versions/{version_id}
Update Deployment Shape Version
GET
/v1/accounts/{account_id}/deployments
List Deployments
POST
/v1/accounts/{account_id}/deployments
Create Deployment
GET
/v1/accounts/{account_id}/deployments/{deployment_id}
Get Deployment
PATCH
/v1/accounts/{account_id}/deployments/{deployment_id}
Update Deployment
DELETE
/v1/accounts/{account_id}/deployments/{deployment_id}
Delete Deployment
GET
/v1/accounts/{account_id}/deployments/{deployment_id}/ledger
Get ledger
DELETE
/v1/accounts/{account_id}/deployments/{deployment_id}/ledger
Reset ledger for hot load
GET
/v1/accounts/{account_id}/deployments/{deployment_id}/shards
List Deployment Shards
GET
/v1/accounts/{account_id}/deployments/{deployment_id}/terminationMessage
Get termination message from deployment
GET
/v1/accounts/{account_id}/deployments/{deployment_id}:metrics
Get Deployment Metrics (Deprecated)
PATCH
/v1/accounts/{account_id}/deployments/{deployment_id}:scale
Scale Deployment to a specific number of replicas or to zero
POST
/v1/accounts/{account_id}/deployments/{deployment_id}:undelete
Undelete Deployment
GET
/v1/accounts/{account_id}/developerPasses
List Developer Passes
POST
/v1/accounts/{account_id}/developerPasses
CRUD APIs for developer passes. Create Developer Pass
GET
/v1/accounts/{account_id}/developerPasses/{developer_passe_id}
Get Developer Pass
PATCH
/v1/accounts/{account_id}/developerPasses/{developer_passe_id}
Update Developer Pass
GET
/v1/accounts/{account_id}/dpoJobs
POST
/v1/accounts/{account_id}/dpoJobs
GET
/v1/accounts/{account_id}/dpoJobs/{dpo_job_id}
DELETE
/v1/accounts/{account_id}/dpoJobs/{dpo_job_id}
POST
/v1/accounts/{account_id}/dpoJobs/{dpo_job_id}:cancel
Cancel Dpo Job
GET
/v1/accounts/{account_id}/dpoJobs/{dpo_job_id}:getMetricsFileEndpoint
POST
/v1/accounts/{account_id}/dpoJobs/{dpo_job_id}:resume
Resume Dpo Job
GET
/v1/accounts/{account_id}/evaluationJobs
List Evaluation Jobs
POST
/v1/accounts/{account_id}/evaluationJobs
Create Evaluation Job
GET
/v1/accounts/{account_id}/evaluationJobs/{evaluation_job_id}
Get Evaluation Job
DELETE
/v1/accounts/{account_id}/evaluationJobs/{evaluation_job_id}
Delete Evaluation Job
GET
/v1/accounts/{account_id}/evaluationJobs/{evaluation_job_id}:getExecutionLogEndpoint
Get Evaluation Job execution logs (stream log endpoint + tracing IDs).
GET
/v1/accounts/{account_id}/evaluations
List Evaluations
POST
/v1/accounts/{account_id}/evaluations
Create Evaluation
GET
/v1/accounts/{account_id}/evaluations/{evaluation_id}
Get Evaluation
DELETE
/v1/accounts/{account_id}/evaluations/{evaluation_id}
TODO: Add Update Evaluation Update Evaluation rpc UpdateEvaluation(UpdateEvaluationRequest) returns (Evaluation) { option (google.api.http) = { patch: "/v1/{evaluation.name=accounts//evaluations/}" b…
POST
/v1/accounts/{account_id}/evaluations/{evaluation_id}:preview
Preview an evaluation with sample data
POST
/v1/accounts/{account_id}/evaluations:validateAssertions
Validate evaluation assertions
GET
/v1/accounts/{account_id}/evaluators
List Evaluators
POST
/v1/accounts/{account_id}/evaluators
Create Evaluator (Deprecated)
GET
/v1/accounts/{account_id}/evaluators/{evaluator_id}
Get Evaluator
PATCH
/v1/accounts/{account_id}/evaluators/{evaluator_id}
Update Evaluator
DELETE
/v1/accounts/{account_id}/evaluators/{evaluator_id}
Delete Evaluator
GET
/v1/accounts/{account_id}/evaluators/{evaluator_id}/versions
List Evaluator Revisions
GET
/v1/accounts/{account_id}/evaluators/{evaluator_id}/versions/{version_id}
CRUD APIs for evaluator revisions (AIP-162). Get Evaluator Revision
DELETE
/v1/accounts/{account_id}/evaluators/{evaluator_id}/versions/{version_id}
Delete Evaluator Revision (deletes alias if name is an alias per AIP-162)
POST
/v1/accounts/{account_id}/evaluators/{evaluator_id}/versions/{version_id}:alias
Alias Evaluator Revision - assign or update a user-specified alias
POST
/v1/accounts/{account_id}/evaluators/{evaluator_id}/versions/{version_id}:rollback
Rollback Evaluator to a specific revision
GET
/v1/accounts/{account_id}/evaluators/{evaluator_id}:getBuildLogEndpoint
Get Evaluator Build Log Endpoint
GET
/v1/accounts/{account_id}/evaluators/{evaluator_id}:getSourceCodeSignedUrl
Get Evaluator Source Code Endpoint
POST
/v1/accounts/{account_id}/evaluators/{evaluator_id}:getUploadEndpoint
Get Evaluator Upload Endpoint
POST
/v1/accounts/{account_id}/evaluators/{evaluator_id}:validateUpload
Validate Evaluator Upload
POST
/v1/accounts/{account_id}/evaluators:previewEvaluator
POST
/v1/accounts/{account_id}/evaluatorsV2
Create Evaluator
GET
/v1/accounts/{account_id}/genericDeploymentTypes
List the generic deployment types under an account
POST
/v1/accounts/{account_id}/genericDeploymentTypes
Create Generic Deployment Type
GET
/v1/accounts/{account_id}/genericDeploymentTypes/{generic_deployment_type_id}
List all generic deployment type version
PATCH
/v1/accounts/{account_id}/genericDeploymentTypes/{generic_deployment_type_id}
Update Generic Deployment Type
DELETE
/v1/accounts/{account_id}/genericDeploymentTypes/{generic_deployment_type_id}
Delete Generic Deployment Type
GET
/v1/accounts/{account_id}/genericDeploymentTypes/{generic_deployment_type_id}/versions/{version_id}
Get generic deployment type version
DELETE
/v1/accounts/{account_id}/genericDeploymentTypes/{generic_deployment_type_id}/versions/{version_id}
Delete the generic deployment type version
GET
/v1/accounts/{account_id}/genericDeployments
List all the generic deployments under an account
POST
/v1/accounts/{account_id}/genericDeployments
Create Generic Deployment
GET
/v1/accounts/{account_id}/genericDeployments/{generic_deployment_id}
Get Generic Deployment
PATCH
/v1/accounts/{account_id}/genericDeployments/{generic_deployment_id}
Create Generic Deployment
DELETE
/v1/accounts/{account_id}/genericDeployments/{generic_deployment_id}
Delete Generic Deployment
GET
/v1/accounts/{account_id}/identityProviders
List Identity Providers
POST
/v1/accounts/{account_id}/identityProviders
Create Identity Provider
GET
/v1/accounts/{account_id}/identityProviders/{identity_provider_id}
Get Identity Provider
PATCH
/v1/accounts/{account_id}/identityProviders/{identity_provider_id}
Update Identity Provider
DELETE
/v1/accounts/{account_id}/identityProviders/{identity_provider_id}
Delete Identity Provider
GET
/v1/accounts/{account_id}/models
List Models
POST
/v1/accounts/{account_id}/models
Create Model
GET
/v1/accounts/{account_id}/models/{model_id}
Get Model
PATCH
/v1/accounts/{account_id}/models/{model_id}
Update Model
DELETE
/v1/accounts/{account_id}/models/{model_id}
Delete Model
POST
/v1/accounts/{account_id}/models/{model_id}/versions
CRUD APIs for model versions. Create Model Version
POST
/v1/accounts/{account_id}/models/{model_id}/versions/{version_id}:deploy
Deploy Model Version
GET
/v1/accounts/{account_id}/models/{model_id}/versions:count
Returns the number of model versions.
GET
/v1/accounts/{account_id}/models/{model_id}:getDownloadEndpoint
Get Model Download Endpoint
POST
/v1/accounts/{account_id}/models/{model_id}:getUploadEndpoint
Get Model Upload Endpoint
POST
/v1/accounts/{account_id}/models/{model_id}:import
Transfer model from S3 to GCP storage
POST
/v1/accounts/{account_id}/models/{model_id}:prepare
Prepare Model for different precisions
GET
/v1/accounts/{account_id}/models/{model_id}:validateUpload
Validate Model Upload
GET
/v1/accounts/{account_id}/policySettings
Returns the singleton PolicySettings for the given account.
PATCH
/v1/accounts/{account_id}/policySettings
Updates the per-account PolicySettings singleton.
GET
/v1/accounts/{account_id}/pricingPlans
List Pricing Plans
GET
/v1/accounts/{account_id}/pricingPlans/{pricing_plan_id}
CRUD APIs for pricing plans. Get Pricing Plan
GET
/v1/accounts/{account_id}/quotas
List Quotas
GET
/v1/accounts/{account_id}/quotas/{quota_id}
Get Quota
PATCH
/v1/accounts/{account_id}/quotas/{quota_id}
Update Quota
GET
/v1/accounts/{account_id}/reinforcementFineTuningJobs
List Reinforcement Fine-tuning Jobs
POST
/v1/accounts/{account_id}/reinforcementFineTuningJobs
Create Reinforcement Fine-tuning Job
GET
/v1/accounts/{account_id}/reinforcementFineTuningJobs/{reinforcement_fine_tuning_job_id}
Get Reinforcement Fine-tuning Job
PATCH
/v1/accounts/{account_id}/reinforcementFineTuningJobs/{reinforcement_fine_tuning_job_id}
Update Reinforcement Fine-tuning Job
DELETE
/v1/accounts/{account_id}/reinforcementFineTuningJobs/{reinforcement_fine_tuning_job_id}
Delete Reinforcement Fine-tuning Job
POST
/v1/accounts/{account_id}/reinforcementFineTuningJobs/{reinforcement_fine_tuning_job_id}:cancel
Cancel Reinforcement Fine-tuning Job
POST
/v1/accounts/{account_id}/reinforcementFineTuningJobs/{reinforcement_fine_tuning_job_id}:debug
Debug Reinforcement Fine-tuning Job
GET
/v1/accounts/{account_id}/reinforcementFineTuningJobs/{reinforcement_fine_tuning_job_id}:getMetricsFileEndpoint
POST
/v1/accounts/{account_id}/reinforcementFineTuningJobs/{reinforcement_fine_tuning_job_id}:resume
Resume Reinforcement Fine-tuning Job
GET
/v1/accounts/{account_id}/rlorTrainerJobs
List Reinforcement Fine-tuning Steps
POST
/v1/accounts/{account_id}/rlorTrainerJobs
Create Reinforcement Fine-tuning Step
GET
/v1/accounts/{account_id}/rlorTrainerJobs/{rlor_trainer_job_id}
Get Reinforcement Fine-tuning Step
DELETE
/v1/accounts/{account_id}/rlorTrainerJobs/{rlor_trainer_job_id}
Delete Reinforcement Fine-tuning Step
GET
/v1/accounts/{account_id}/rlorTrainerJobs/{rlor_trainer_job_id}/checkpoints
List checkpoints for an RLOR Trainer Job
GET
/v1/accounts/{account_id}/rlorTrainerJobs/{rlor_trainer_job_id}/publicLogs
Get a signed URL for the public trainer logs of an RLOR Trainer Job.
POST
/v1/accounts/{account_id}/rlorTrainerJobs/{rlor_trainer_job_id}:cancel
Cancel Rlor Trainer Job
POST
/v1/accounts/{account_id}/rlorTrainerJobs/{rlor_trainer_job_id}:executeTrainStep
Execute one training step for keep-alive Reinforcement Fine-tuning Step
POST
/v1/accounts/{account_id}/rlorTrainerJobs/{rlor_trainer_job_id}:resume
Resume Rlor Trainer Job
GET
/v1/accounts/{account_id}/routers
List Routers
POST
/v1/accounts/{account_id}/routers
Create Router
GET
/v1/accounts/{account_id}/routers/{router_id}
CRUD APIs for routers. Get Router
PATCH
/v1/accounts/{account_id}/routers/{router_id}
Update Router
DELETE
/v1/accounts/{account_id}/routers/{router_id}
Delete Router
GET
/v1/accounts/{account_id}/secrets
List Secrets
POST
/v1/accounts/{account_id}/secrets
GET
/v1/accounts/{account_id}/secrets/{secret_id}
Get Secret
PATCH
/v1/accounts/{account_id}/secrets/{secret_id}
DELETE
/v1/accounts/{account_id}/secrets/{secret_id}
GET
/v1/accounts/{account_id}/serverlessRateLimits
Lists effective global rate limits for shared serverless pool deployments (fireworks-owned). Values reflect configured limits as observed in production monitoring.
GET
/v1/accounts/{account_id}/serverlessTokenUsage
Serverless pool token throughput (tokens per minute) by time bucket and base model, from production usage metrics.
GET
/v1/accounts/{account_id}/supervisedFineTuningJobs
List Supervised Fine-tuning Jobs
POST
/v1/accounts/{account_id}/supervisedFineTuningJobs
Create Supervised Fine-tuning Job
GET
/v1/accounts/{account_id}/supervisedFineTuningJobs/{supervised_fine_tuning_job_id}
Get Supervised Fine-tuning Job
DELETE
/v1/accounts/{account_id}/supervisedFineTuningJobs/{supervised_fine_tuning_job_id}
Delete Supervised Fine-tuning Job
POST
/v1/accounts/{account_id}/supervisedFineTuningJobs/{supervised_fine_tuning_job_id}:cancel
Cancel Supervised Fine-tuning Job
POST
/v1/accounts/{account_id}/supervisedFineTuningJobs/{supervised_fine_tuning_job_id}:resume
Resume Supervised Fine-tuning Job
POST
/v1/accounts/{account_id}/supervisedFineTuningJobs:estimateCost
Estimate the cost of a Supervised Fine-tuning Job
GET
/v1/accounts/{account_id}/trails
List Trails
POST
/v1/accounts/{account_id}/trails
Create Trail
GET
/v1/accounts/{account_id}/trails/{trail_id}
CRUD APIs for trails. Get Trail
PATCH
/v1/accounts/{account_id}/trails/{trail_id}
Update Trail
DELETE
/v1/accounts/{account_id}/trails/{trail_id}
Delete Trail
GET
/v1/accounts/{account_id}/trails/{trail_id}:getMetrics
Get Trail Metrics (trace counts, token usage from tracing service)
GET
/v1/accounts/{account_id}/trainingSessionJobs
List training session jobs for an account.
POST
/v1/accounts/{account_id}/trainingSessionJobs
Create a training session job that binds an account to a shared trainer.
GET
/v1/accounts/{account_id}/trainingSessionJobs/{training_session_job_id}
Get a training session job.
DELETE
/v1/accounts/{account_id}/trainingSessionJobs/{training_session_job_id}
Delete a training session job and cascade-clean its child sessions and routes.
GET
/v1/accounts/{account_id}/trainingSessionJobs/{training_session_job_id}/trainingSessions
List training sessions under a training session job.
POST
/v1/accounts/{account_id}/trainingSessionJobs/{training_session_job_id}/trainingSessions
Create a training session under a training session job.
GET
/v1/accounts/{account_id}/trainingSessionJobs/{training_session_job_id}/trainingSessions/{training_session_id}
Get a training session.
POST
/v1/accounts/{account_id}/trainingSessionJobs/{training_session_job_id}/trainingSessions/{training_session_id}:loadState
Load or switch the LoRA adapter state for a training session.
GET
/v1/accounts/{account_id}/trainingShapes
List Training Shapes
POST
/v1/accounts/{account_id}/trainingShapes
CRUD APIs for training shape. Create Training Shape
GET
/v1/accounts/{account_id}/trainingShapes/{training_shape_id}
Get Training Shape
PATCH
/v1/accounts/{account_id}/trainingShapes/{training_shape_id}
Update Training Shape
DELETE
/v1/accounts/{account_id}/trainingShapes/{training_shape_id}
Delete Training Shape
GET
/v1/accounts/{account_id}/trainingShapes/{training_shape_id}/versions
List Training Shapes Versions
GET
/v1/accounts/{account_id}/trainingShapes/{training_shape_id}/versions/{version_id}
Get Training Shape Version
PATCH
/v1/accounts/{account_id}/trainingShapes/{training_shape_id}/versions/{version_id}
Update Training Shape Version
GET
/v1/accounts/{account_id}/users
List Users
POST
/v1/accounts/{account_id}/users
Create User
GET
/v1/accounts/{account_id}/users/{user_id}
Get User
PATCH
/v1/accounts/{account_id}/users/{user_id}
Update User
GET
/v1/accounts/{account_id}/users/{user_id}/apiKeys
List API Keys
POST
/v1/accounts/{account_id}/users/{user_id}/apiKeys
Create API Key
GET
/v1/accounts/{account_id}/users/{user_id}/apiKeys/accounts/{account_id}/users/{user_id}
Get API Key
POST
/v1/accounts/{account_id}/users/{user_id}/apiKeys:delete
Delete API Key
POST
/v1/accounts/{account_id}:testeval
Similar to preview evaluation, but no need to create the evaluation entry first.
Schemas 255
The contract defines 255 schemas that model the data the API accepts and returns. The most detailed are gatewayDeployment (47 properties), gatewaySupervisedFineTuningJob (38 properties), gatewayModel (38 properties), gatewayReinforcementFineTuningJob (28 properties). Each schema is shown below with its type and property counts.
GatewayValidateDatasetUploadBody
object
gatewayIdentityProvider
object
16 properties
gatewayDpoConfig
object
Hyperparameters for Direct Preference Optimization (DPO) training.
3 properties
gatewayGetDatasetDownloadEndpointResponse
object
1 property
gatewayTimeSeries
object
2 properties
gatewayWeightedRandomStrategy
object
Use replica count as weight.
GatewayCreateEvaluatorBody
object
2 properties
1 required
gatewayValidateAssertionsResponse
object
2 properties
gatewayLedgerEntry
object
2 properties
GatewayUndeleteDeploymentBody
object
gatewayAutoTune
object
1 property
gatewayPlacement
object
The desired geographic region where the deployment must be placed. Exactly one field will be specified.
3 properties
gatewaySecret
object
3 properties
2 required
gatewayAccountRateLimit
object
3 properties
3 required
gatewayListQuotasResponse
object
3 properties
gatewayTrainingShapeVersion
object
7 properties
gatewayAccountState
string
gatewayListTrainingShapesResponse
object
3 properties
gatewaySplitted
object
1 property
1 required
gatewayPreviewEvaluatorResponse
object
5 properties
AssertionAssertionType
string
gatewayRedeemCreditCodeRequest
object
RedeemCreditCodeRequest is the request to redeem a credit code for an account.
2 properties
2 required
BaseModelDetailsCheckpointFormat
string
gatewayTrainerShardingScheme
object
Structured parallelism/sharding profile used by trainer launches.
5 properties
DeploymentShapePresetType
string
gatewayDeploymentShape
object
21 properties
1 required
gatewayListPricingPlansResponse
object
3 properties
gatewayTransformed
object
3 properties
1 required
gatewayMultiRegion
string
gatewayGetModelVersionCountResponse
object
1 property
gatewayDeployedModelState
string
- UNDEPLOYING: The model is being undeployed. - DEPLOYING: The model is being deployed. - DEPLOYED: The model is deployed and ready for inference. - UPDATING:…
gatewayStatus
object
2 properties
EvaluatorSourceType
string
gatewayReplicaStats
object
6 properties
gatewayListTrailsResponse
object
3 properties
gatewayTrainingSessionState
string
ValidateAssertionsResponseValidateAssertionError
object
1 property
gatewayAccountUsage
object
2 properties
ModelSnapshotType
string
gatewayProvider
object
3 properties
gatewayLineItem
object
8 properties
gatewayAuditLogEntry
object
12 properties
AccountRateLimitMetric
string
Which rate-limit metric this row describes.
gatewayWeightPrecision
string
The weight precision for model training/inference. - BFLOAT16: no quantization applied - INT8: enable 8-bit quantization with LLM.int8() - NF4: enable 4-bit qu…
gatewayApiKey
object
10 properties
GatewayDeployModelVersionBody
object
2 properties
2 required
GatewayValidateAssertionsBody
object
Validate the code assertions. Recommended before creating the evaluation.
1 property
1 required
gatewayListSupervisedFineTuningJobsResponse
object
3 properties
gatewayBatchInferenceJobInferenceParameters
object
6 properties
gatewayEvalProtocol
object
GatewayResumeReinforcementFineTuningJobBody
object
gatewayGetBillingSummaryResponse
object
1 property
gatewayRolloutStrategy
string
The rollout strategy to use when deploying the model version. - ROLLOUTSTRATEGYSTANDARD: Standard rollout strategy updates the deployment using a normal k8s ro…
gatewayDeveloperPassState
string
gatewayListClustersResponse
object
3 properties
GatewayCancelSupervisedFineTuningJobBody
object
gatewayListGenericDeploymentTypeVersionsResponse
object
3 properties
gatewayListReinforcementFineTuningJobsResponse
object
3 properties
gatewayListAccountsResponse
object
3 properties
gatewaySamlConfig
object
SAML Configuration Exactly one of metadataurl or metadataxml must be provided.
2 properties
gatewayDeployment
object
47 properties
1 required
GatewayTestEvaluationBody
object
2 properties
2 required
GatewayCreateDatasetBody
object
4 properties
2 required
gatewayGetModelDownloadEndpointResponse
object
1 property
CodeAssertionExecutionOptions
object
3 properties
gatewayListRlorTrainerJobsResponse
object
3 properties
gatewayListBatchInferenceJobsResponse
object
3 properties
gatewayIdentityProviderState
string
gatewayPromoteCheckpointResponse
object
1 property
gatewayCriterion
object
4 properties
ModelKind
string
- HFBASEMODEL: An LLM base model. - HFPEFTADDON: A parameter-efficent fine-tuned addon. - HFTEFTADDON: A token-eficient fine-tuned addon. - FLUMINABASEMODEL: A…
ReinforcementLearningLossConfigMethod
string
gatewayDeploymentState
string
- CREATING: The deployment is still being created. - READY: The deployment is ready to be used. - DELETING: The deployment is being deleted. - FAILED: The depl…
gatewayDeploymentShapeVersion
object
6 properties
gatewayListGenericDeploymentsResponse
object
3 properties
GatewayCreateEvaluationJobBody
object
2 properties
1 required
PricingPlanBillingType
string
GatewayGetModelUploadEndpointBody
object
3 properties
1 required
gatewayGetLedgerResponse
object
1 property
gatewayValidateModelUploadResponse
object
1 property
GatewayPrepareModelBody
object
2 properties
AccountUsageDedicatedDeploymentUsage
object
One dedicated deployment usage aggregation bucket.
9 properties
gatewayCluster
object
8 properties
gatewayWandbConfig
object
WandbConfig is the configuration for the Weights & Biases (wandb) logging which will be used by a training job.
6 properties
gatewayOrpoConfig
object
Hyperparameters for Odds Ratio Preference Optimization (ORPO) training.
1 property
gatewayGetDeploymentMetricsResponse
object
1 property
AccountAccountType
string
gatewayDirectRouteType
string
GatewayDebugReinforcementFineTuningJobBody
object
gatewayPolicySettings
object
3 properties
gatewayValidateModelConfigRequest
object
2 properties
1 required
GatewayAliasEvaluatorVersionBody
object
Assigns or updates a user-specified alias for a given revision.
1 property
1 required
googlelongrunningOperation
object
This resource represents a long-running operation that is the result of a network API call.
5 properties
gatewayBatchInferenceJob
object
14 properties
DeploymentPrecision
string
PricingPlanAcceleratorHourBillingConfig
object
2 properties
2 required
gatewayTrainingShape
object
17 properties
2 required
gatewayTrailMetrics
object
Metrics for a trail, fetched from the tracing service.
6 properties
gatewayPreviewEvaluationResult
object
5 properties
gatewayRouterState
string
- CREATING: The router is being created. - READY: The router is ready for access. - UPDATING: There are in-progress updates happening with the router. - DELETI…
GatewaySplitDatasetBody
object
2 properties
gatewayGenericDeploymentTypeVersion
object
3 properties
GatewayImportModelBody
object
2 properties
GatewayGetEvaluatorUploadEndpointBody
object
2 properties
1 required
gatewayRlorTrainerJob
object
27 properties
TrainingSessionReferenceState
string
ReferenceState indicates whether the session currently references the base model or a loaded LoRA adapter. Updated automatically when ExecuteTrainingSessionLoa…
GatewayExecuteRlorTrainStepBody
object
2 properties
2 required
gatewayGenericDeploymentState
string
- CREATING: The deployment is still being created. - READY: The deployment is ready to be used. - FAILED: The deployment failed to be created. - UPDATING: Ther…
PolicySettingsModelAccessRule
object
5 properties
1 required
PricingPlanTokenBillingConfig
object
5 properties
2 required
gatewayListAuditLogsResponse
object
3 properties
GatewayScaleDeploymentBody
object
1 property
gatewaySplitDatasetResponse
object
3 properties
gatewayListRoutersResponse
object
3 properties
gatewayListSecretsResponse
object
3 properties
gatewayLLMAssertion
object
4 properties
2 required
gatewayListDeploymentShapesResponse
object
3 properties
gatewayGetEvaluatorBuildLogEndpointResponse
object
1 property
gatewayDebugReinforcementFineTuningJobResponse
object
2 properties
1 required
gatewayRefreshSessionTokenResponse
object
Response containing the refreshed session JWT.
4 properties
gatewayEvaluationResult
object
1 property
1 required
GatewayCreateClusterBody
object
2 properties
2 required
gatewayReinforcementLearningLossConfig
object
Loss method + hyperparameters for reinforcement-learning-style fine-tuning (e.g. RFT / RL trainers). For preference jobs (DPO API), the default loss method is…
4 properties
PolicySettingsEffect
string
Policy effect for model-access rules (per-row; not a standalone API enum). - DENY: Block actions that violate the policy.
gatewayListRlorTrainerJobCheckpointsResponse
object
3 properties
gatewayEvaluator
object
14 properties
gatewayQuota
object
5 properties
gatewayConversationConfig
object
3 properties
1 required
gatewayListGenericDeploymentTypesResponse
object
3 properties
EvaluatorSource
object
2 properties
gatewayListCreditRedemptionsResponse
object
3 properties
GatewayResumeSupervisedFineTuningJobBody
object
gatewayGenericDeploymentType
object
4 properties
gatewayTrainingSessionJob
object
TrainingSessionJob groups all TrainingSessions for a specific job run on a given base model. Each job is scoped to an account and bound to a shared trainer.
8 properties
1 required
gatewayGetDpoJobMetricsFileResponse
object
1 property
gatewayListDeployedModelsResponse
object
3 properties
gatewayListDeploymentShardsResponse
object
3 properties
gatewayClusterState
string
- CREATING: The cluster is still being created. - READY: The cluster is ready to be used. - DELETING: The cluster is being deleted. - FAILED: Cluster is not op…
gatewayTrail
object
9 properties
gatewayUser
object
10 properties
1 required
gatewayAutoscalingPolicy
object
5 properties
gatewayGetEvaluatorUploadEndpointResponse
object
1 property
gatewayAcceleratorType
string
AccountSuspendState
string
gatewayGetEvaluatorSourceCodeEndpointResponse
object
1 property
gatewayPricingPlanState
string
gatewaySupervisedFineTuningJob
object
38 properties
1 required
gatewayGenericDeployment
object
7 properties
3 required
gatewayDeployedModelRef
object
5 properties
gatewayListApiKeysResponse
object
3 properties
GatewayCreateEvaluationBody
object
2 properties
1 required
gatewayListDeploymentsResponse
object
3 properties
gatewayUserUploaded
object
gatewayListUsersResponse
object
3 properties
gatewayEvaluationJob
object
13 properties
3 required
gatewayAwsS3Config
object
AwsS3Config is the configuration for AWS S3 dataset access which will be used by a training job.
2 properties
gatewayEstimateSupervisedFineTuningJobCostResponse
object
1 property
gatewayGetEvaluationJobExecutionLogEndpointResponse
object
Response carries the stream log URL (for VirtualizedLogViewer).
3 properties
gatewayScalingSchedule
object
6 properties
4 required
AccountUsageServerlessUsage
object
One serverless usage aggregation bucket.
9 properties
TrainingShapeTrainerMode
string
Trainer execution mode used for validated launch-profile matching.
gatewayRegion
string
gatewayCodeAssertion
object
4 properties
2 required
GatewayRollbackEvaluatorBody
object
Rolls an evaluator back to the configuration captured by a specific revision.
GatewayGetDatasetUploadEndpointBody
object
2 properties
1 required
gatewayDataset
object
18 properties
gatewayPreviewEvaluatorSampleResult
object
4 properties
GatewayValidateEvaluatorUploadBody
object
gatewayDeployedModel
object
12 properties
GatewayResumeRlorTrainerJobBody
object
gatewayGetAccountUsageFilterOptionsResponse
object
Distinct filter values for the account/time range (separate from GetAccountUsage).
GatewayPreviewEvaluationBody
object
2 properties
1 required
gatewayDeploymentShard
object
6 properties
gatewayAzureBlobStorageConfig
object
AzureBlobStorageConfig is the configuration for Azure Blob Storage dataset access which will be used by a training job.
3 properties
gatewayJobProgress
object
Progress of a job, e.g. RLOR, EVJ, BIJ etc.
10 properties
gatewayListIdentityProvidersResponse
object
3 properties
gatewayAccount
object
10 properties
1 required
gatewayListTrainingSessionJobsResponse
object
3 properties
gatewayEvenLoadStrategy
object
Dynamically adjust traffic allocation to balance the load per replica across the deployments as much as possible.
gatewayTrainingSession
object
TrainingSession represents a single training context on a shared trainer. It starts with a base model reference and can have LoRA adapters loaded or promoted v…
8 properties
gatewayListEvaluationJobsResponse
object
3 properties
GatewayCreateApiKeyBody
object
1 property
1 required
gatewayGetTerminationMessageResponse
object
1 property
gatewayEksCluster
object
9 properties
2 required
gatewayCheckpointType
string
- CHECKPOINTTYPEINFERENCEBASE: Inference-ready checkpoint (full-parameter, HuggingFace format). Promotable to a model for serving. - CHECKPOINTTYPEINFERENCEARC…
GatewayPromoteCheckpointBody
object
Promote a checkpoint to a model. When basemodel is provided, the checkpoint GCS path is reconstructed from account metadata and the trainer/deployment ID — no…
4 properties
3 required
gatewayCode
string
- OK: Not an error; returned on success. HTTP Mapping: 200 OK - CANCELLED: The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Close…
gatewayModelState
string
- UPLOADING: The model is still being uploaded (upload is asynchronous). - READY: The model is ready to be used.
googlerpcStatus
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](h…
3 properties
GatewayExecuteTrainingSessionLoadStateBody
object
1 property
1 required
typeDate
object
A full date, with non-zero year, month, and day values A month and day value, with a zero year, such as an anniversary A year on its own, with zero month and d…
3 properties
gatewayDpoJob
object
15 properties
1 required
gatewayModel
object
38 properties
gatewayNotificationSettings
object
NotificationSettings configures notification preferences for an account. (accounts/{account}/notificationSettings) when more notification categories are added.…
1 property
gatewayListDatasetsResponse
object
3 properties
gatewayGetRlorTrainerJobPublicLogsResponse
object
1 property
GatewayResumeDpoJobBody
object
gatewayAwsS3ModelSource
object
5 properties
1 required
gatewayAssertion
object
4 properties
1 required
GatewayDeleteApiKeyBody
object
1 property
1 required
gatewayGetAccountServerlessTokenUsageResponse
object
7 properties
gatewayRedeemCreditCodeResponse
object
RedeemCreditCodeResponse returns the amount of credits redeemed.
1 property
gatewayCriterionType
string
typeMoney
object
Represents an amount of money with its currency type.
3 properties
gatewayDeploymentShardState
string
- CREATING: The deployment shard is still being created. - READY: The deployment shard is ready to be used. - DELETING: The deployment shard is being deleted.…
gatewayUserState
string
gatewayListTrainingSessionsResponse
object
3 properties
gatewayListEvaluatorVersionsResponse
object
3 properties
gatewayGetDatasetUploadEndpointResponse
object
1 property
gatewayListDeveloperPassesResponse
object
3 properties
DeploymentHotLoadBucketType
string
gatewayCreditRedemption
object
3 properties
1 required
GatewayCancelReinforcementFineTuningJobBody
object
gatewayEvaluatorState
string
gatewayPurpose
string
Scheduling purpose for training jobs and deployments.
gatewayCodeSnippets
object
4 properties
gatewayListModelsResponse
object
3 properties
gatewayGetModelUploadEndpointResponse
object
2 properties
gatewayClusterConnectionInfo
object
2 properties
gatewayListDeploymentShapeVersionsResponse
object
3 properties
GatewayCreateModelBody
object
3 properties
1 required
gatewayBaseModelDetails
object
10 properties
gatewayReinforcementFineTuningJob
object
28 properties
2 required
gatewayRlorTrainerJobCheckpoint
object
A checkpoint saved during an RLOR trainer job. Checkpoints are stored in GCS and discovered on-demand (not persisted in the database).
5 properties
gatewayListEvaluationsResponse
object
3 properties
DatasetFormat
string
gatewayGetReinforcementFineTuningJobMetricsFileResponse
object
1 property
gatewayJobState
string
JobState represents the state an asynchronous job can be in. - JOBSTATEPAUSED: Job is paused, typically due to account suspension or manual intervention. - JOB…
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
gatewayAzureBlobModelSource
object
6 properties
2 required
GatewayCancelDpoJobBody
object
gatewayTEFTDetails
object
gatewayListTrainingShapeVersionsResponse
object
3 properties
gatewayListAccountServerlessRateLimitsResponse
object
2 properties
gatewayRefreshSessionTokenRequest
object
Request to refresh an existing session JWT before it expires.
1 property
gatewayPEFTDetails
object
5 properties
3 required
gatewayEvaluation
object
9 properties
3 required
GatewayCreateEvaluatorV2Body
object
2 properties
1 required
gatewayOidcConfig
object
3 properties
3 required
gatewayListEvaluatorsResponse
object
3 properties
gatewayEvaluatorVersion
object
4 properties
gatewayFakeCluster
object
3 properties
gatewayReinforcementFineTuningJobInferenceParameters
object
6 properties
gatewayBaseTrainingConfig
object
17 properties
GatewayCancelRlorTrainerJobBody
object
gatewayDatasetState
string
gatewayListDpoJobsResponse
object
3 properties
gatewayEvaluateOptions
object
3 properties
gatewayPricingPlan
object
PricingPlan defines a custom billing plan for an account Each PricingPlan is associated with a contract, and describes the pricing terms for a specific service.
9 properties
2 required
GatewayPreviewEvaluatorBody
object
3 properties
2 required
gatewayDeveloperPass
object
7 properties
gatewayTimeSeriesPoint
object
2 properties
gatewayRouter
object
13 properties
gatewayPreviewEvaluationResponse
object
3 properties
gatewayModelVersion
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Fireworks AI 9
Other APIs Fireworks AI publishes across the network.
Fireworks AI anthropic-messages.openapi_other API
Fireworks AI Chat API
Fireworks AI Completions API
Fireworks AI Gateway API
Fireworks AI gateway-extra.openapi_Gateway API
Fireworks AI Messages API
Fireworks AI Responses API
Fireworks AI responses.openapi_other API
Fireworks AI text-completion.openapi_other API
Where this information came from
This is an independent, third-party profile of Fireworks AI gateway.openapi_Gateway API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.