Fireworks AI

Fireworks AI Gateway.openapi Gateway API

The gateway.openapi_Gateway API from Fireworks AI — 126 operation(s) for gateway.openapi_gateway.

GitHub OpenAPI

Operations 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… #
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). #
POST /v1/accounts/{account_id}/checkpoints/{checkpoint_id}:promote Promote a checkpoint to a model. #
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 Gateway split dataset #
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 Gateway list dpo jobs #
POST /v1/accounts/{account_id}/dpoJobs Gateway create dpo job #
GET /v1/accounts/{account_id}/dpoJobs/{dpo_job_id} Gateway get dpo job #
DELETE /v1/accounts/{account_id}/dpoJobs/{dpo_job_id} Gateway delete dpo job #
POST /v1/accounts/{account_id}/dpoJobs/{dpo_job_id}:cancel Cancel Dpo Job #
GET /v1/accounts/{account_id}/dpoJobs/{dpo_job_id}:getMetricsFileEndpoint Gateway get dpo job metrics file endpoint #
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… #
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 Gateway preview evaluator #
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 Gateway get reinforcement fine tuning job metrics file endpoint #
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 Gateway create secret #
GET /v1/accounts/{account_id}/secrets/{secret_id} Get Secret #
PATCH /v1/accounts/{account_id}/secrets/{secret_id} Gateway update secret #
DELETE /v1/accounts/{account_id}/secrets/{secret_id} Gateway delete secret #
GET /v1/accounts/{account_id}/serverlessRateLimits Lists effective global rate limits for shared serverless pool deployments… #
GET /v1/accounts/{account_id}/serverlessTokenUsage Serverless pool token throughput (tokens per minute) by time bucket and base… #
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 #

Documentation

📖
Documentation
https://docs.fireworks.ai/guides/querying-text-models
📖
APIReference
https://docs.fireworks.ai/api-reference/post-chatcompletions
📖
APIReference
https://docs.fireworks.ai/api-reference/post-completions
📖
Documentation
https://docs.fireworks.ai/guides/querying-vision-language-models
📖
Documentation
https://docs.fireworks.ai/guides/querying-embeddings-models
📖
Documentation
https://docs.fireworks.ai/guides/querying-rerank-models
📖
Documentation
https://docs.fireworks.ai/guides/querying-image-language-models
📖
APIReference
https://docs.fireworks.ai/api-reference/generate-a-new-image-from-a-text-prompt
📖
Documentation
https://docs.fireworks.ai/guides/audio
📖
APIReference
https://docs.fireworks.ai/api-reference/audio-transcriptions
📖
Documentation
https://docs.fireworks.ai/guides/batch-inference
📖
Documentation
https://docs.fireworks.ai/fine-tuning/fine-tuning-models
📖
APIReference
https://docs.fireworks.ai/api-reference/files
📖
APIReference
https://docs.fireworks.ai/api-reference/list-models
📖
Documentation
https://docs.fireworks.ai/guides/ondemand-deployments
📖
APIReference
https://docs.fireworks.ai/api-reference

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/fireworks-ai/refs/heads/main/openapi/fireworks-ai-gateway-openapi-gateway-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/fireworks-ai/refs/heads/main/asyncapi/fireworks-ai-asyncapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/fireworks-ai-gateway-openapi-gateway-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

fireworks-ai-gateway-openapi-gateway-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Gateway REST Gateway.openapi Gateway API
  version: 4.259.0
tags:


# --- truncated at 32 KB (490 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fireworks-ai/refs/heads/main/openapi/fireworks-ai-gateway-openapi-gateway-api-openapi.yml