/

FWfw-ai-external

Docs
History
Schema
Generate

Filter operations

anthropic-messages.openapi_other1

gateway-extra.openapi_Gateway1

gateway.openapi_Gateway214

get/v1/accountsList Accounts
post/v1/auth/refreshRefresh a session JWT before expiry with a fresh TTL.
post/v1/creditCodes:redeemAPIs for credit codes. Redeem Credit Code
post/v1/validateModelConfigValidate Model Config
get/v1/accounts/{account_id}Get Account
get/v1/accounts/{account_id}/accountUsageFilterOptionsDistinct filter values for an account/time range (serverless + dedicated; for FE, separate -yet mirrors GetAccountUsage).
get/v1/accounts/{account_id}/auditLogsList User Audit Logs
get/v1/accounts/{account_id}/batchInferenceJobsList Batch Inference Jobs
post/v1/accounts/{account_id}/batchInferenceJobsCreate 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/summaryGet billing summary information for an account
post/v1/accounts/{account_id}/usageCosts:queryQuery grouped usage cost subtotals for an account.
get/v1/accounts/{account_id}/billingSettingsReturns the singleton BillingSettings for the given account.
patch/v1/accounts/{account_id}/billingSettingsUpdates the singleton BillingSettings for the given account.
get/v1/accounts/{account_id}/billingUsageGet Account Usage
post/v1/accounts/{account_id}/checkpoints/{checkpoint_id}:promotePromote 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}/clustersList Clusters
post/v1/accounts/{account_id}/clustersCreate Cluster
get/v1/accounts/{account_id}/clusters/{cluster_id}Get Cluster
delete/v1/accounts/{account_id}/clusters/{cluster_id}Delete Cluster
patch/v1/accounts/{account_id}/clusters/{cluster_id}Update Cluster
get/v1/accounts/{account_id}/clusters/{cluster_id}:getConnectionInfoGet Cluster Connection Info
get/v1/accounts/{account_id}/creditRedemptionsList Credit Redemptions
get/v1/accounts/{account_id}/datasetsList Datasets
post/v1/accounts/{account_id}/datasetsCreate Dataset
get/v1/accounts/{account_id}/datasets/{dataset_id}Get Dataset
delete/v1/accounts/{account_id}/datasets/{dataset_id}Delete Dataset
patch/v1/accounts/{account_id}/datasets/{dataset_id}Update Dataset
get/v1/accounts/{account_id}/datasets/{dataset_id}:getDownloadEndpointGet Dataset Download Endpoint
post/v1/accounts/{account_id}/datasets/{dataset_id}:getUploadEndpointGet Dataset Upload Endpoint
post/v1/accounts/{account_id}/datasets/{dataset_id}:splitDataset
post/v1/accounts/{account_id}/datasets/{dataset_id}:validateUploadValidate Dataset Upload
get/v1/accounts/{account_id}/deployedModelsList LoRAs
post/v1/accounts/{account_id}/deployedModelsLoad LoRA
get/v1/accounts/{account_id}/deployedModels/{deployed_model_id}Get LoRA
delete/v1/accounts/{account_id}/deployedModels/{deployed_model_id}Unload LoRA
patch/v1/accounts/{account_id}/deployedModels/{deployed_model_id}Update LoRA
get/v1/accounts/{account_id}/deploymentShapesList Deployment Shapes
post/v1/accounts/{account_id}/deploymentShapesCRUD APIs for deployment shape. Create Deployment Shape
get/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}Get Deployment Shape
delete/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}Delete Deployment Shape
patch/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}Update Deployment Shape
get/v1/accounts/{account_id}/deploymentShapes/{deployment_shape_id}/versionsList 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
post/v1/accounts/{account_id}/deploymentShapeVersions:matchMatch Deployment Shape Versions
get/v1/accounts/{account_id}/deploymentsList Deployments
post/v1/accounts/{account_id}/deploymentsCreate Deployment
get/v1/accounts/{account_id}/deployments/{deployment_id}Get Deployment
delete/v1/accounts/{account_id}/deployments/{deployment_id}Delete Deployment
patch/v1/accounts/{account_id}/deployments/{deployment_id}Update Deployment
get/v1/accounts/{account_id}/deployments/{deployment_id}/ledgerGet ledger
delete/v1/accounts/{account_id}/deployments/{deployment_id}/ledgerReset ledger for hot load
get/v1/accounts/{account_id}/deployments/{deployment_id}/shardsList Deployment Shards
get/v1/accounts/{account_id}/deployments/{deployment_id}/terminationMessageGet termination message from deployment
get/v1/accounts/{account_id}/deployments/{deployment_id}:metricsGet Deployment Metrics (Deprecated)
patch/v1/accounts/{account_id}/deployments/{deployment_id}:scaleScale Deployment to a specific number of replicas or to zero
post/v1/accounts/{account_id}/deployments/{deployment_id}:undeleteUndelete Deployment
get/v1/accounts/{account_id}/developerPassesList Developer Passes
post/v1/accounts/{account_id}/developerPassesCRUD 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}:cancelCancel Dpo Job
get/v1/accounts/{account_id}/dpoJobs/{dpo_job_id}:getMetricsFileEndpoint
post/v1/accounts/{account_id}/dpoJobs/{dpo_job_id}:resumeResume Dpo Job
get/v1/accounts/{account_id}/evaluationJobsList Evaluation Jobs
post/v1/accounts/{account_id}/evaluationJobsCreate 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}:getExecutionLogEndpointGet Evaluation Job execution logs (stream log endpoint + tracing IDs).
get/v1/accounts/{account_id}/evaluationsList Evaluations
post/v1/accounts/{account_id}/evaluationsCreate 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/*}" body: "evaluation" }; } Delete Evaluation
post/v1/accounts/{account_id}/evaluations/{evaluation_id}:previewPreview an evaluation with sample data
post/v1/accounts/{account_id}/evaluations:validateAssertionsValidate evaluation assertions
get/v1/accounts/{account_id}/evaluatorsList Evaluators
post/v1/accounts/{account_id}/evaluatorsCreate Evaluator (Deprecated)
get/v1/accounts/{account_id}/evaluators/{evaluator_id}Get Evaluator
delete/v1/accounts/{account_id}/evaluators/{evaluator_id}Delete Evaluator
patch/v1/accounts/{account_id}/evaluators/{evaluator_id}Update Evaluator
get/v1/accounts/{account_id}/evaluators/{evaluator_id}/versionsList 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}:aliasAlias Evaluator Revision - assign or update a user-specified alias
post/v1/accounts/{account_id}/evaluators/{evaluator_id}/versions/{version_id}:rollbackRollback Evaluator to a specific revision
get/v1/accounts/{account_id}/evaluators/{evaluator_id}:getBuildLogEndpointGet Evaluator Build Log Endpoint
get/v1/accounts/{account_id}/evaluators/{evaluator_id}:getSourceCodeSignedUrlGet Evaluator Source Code Endpoint
post/v1/accounts/{account_id}/evaluators/{evaluator_id}:getUploadEndpointGet Evaluator Upload Endpoint
post/v1/accounts/{account_id}/evaluators/{evaluator_id}:validateUploadValidate Evaluator Upload
post/v1/accounts/{account_id}/evaluators:previewEvaluator
post/v1/accounts/{account_id}/evaluatorsV2Create Evaluator
get/v1/accounts/{account_id}/externalKeysList External Keys
post/v1/accounts/{account_id}/externalKeysCreate External Key
get/v1/accounts/{account_id}/externalKeys/{external_key_id}Get External Key
delete/v1/accounts/{account_id}/externalKeys/{external_key_id}Delete External Key
patch/v1/accounts/{account_id}/externalKeys/{external_key_id}Update External Key
get/v1/accounts/{account_id}/identityProvidersList Identity Providers
post/v1/accounts/{account_id}/identityProvidersCreate Identity Provider
get/v1/accounts/{account_id}/identityProviders/{identity_provider_id}Get Identity Provider
delete/v1/accounts/{account_id}/identityProviders/{identity_provider_id}Delete Identity Provider
patch/v1/accounts/{account_id}/identityProviders/{identity_provider_id}Update Identity Provider
get/v1/accounts/{account_id}/modelsList Models
post/v1/accounts/{account_id}/modelsCreate Model
get/v1/accounts/{account_id}/models/{model_id}Get Model
delete/v1/accounts/{account_id}/models/{model_id}Delete Model
patch/v1/accounts/{account_id}/models/{model_id}Update Model
post/v1/accounts/{account_id}/models/{model_id}/versionsCRUD APIs for model versions. Create Model Version
post/v1/accounts/{account_id}/models/{model_id}/versions/{version_id}:deployDeploy Model Version
get/v1/accounts/{account_id}/models/{model_id}/versions:countReturns the number of model versions.
get/v1/accounts/{account_id}/models/{model_id}:getDownloadEndpointGet Model Download Endpoint
post/v1/accounts/{account_id}/models/{model_id}:getUploadEndpointGet Model Upload Endpoint
post/v1/accounts/{account_id}/models/{model_id}:importTransfer model from S3 to GCP storage
post/v1/accounts/{account_id}/models/{model_id}:preparePrepare Model for different precisions
get/v1/accounts/{account_id}/models/{model_id}:validateUploadValidate Model Upload
get/v1/accounts/{account_id}/policySettingsReturns the singleton PolicySettings for the given account.
patch/v1/accounts/{account_id}/policySettingsUpdates the per-account PolicySettings singleton.
get/v1/accounts/{account_id}/pricingPlansList Pricing Plans
get/v1/accounts/{account_id}/pricingPlans/{pricing_plan_id}CRUD APIs for pricing plans. Get Pricing Plan
get/v1/accounts/{account_id}/quotasList 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}/reinforcementFineTuningJobsList Reinforcement Fine-tuning Jobs
post/v1/accounts/{account_id}/reinforcementFineTuningJobsCreate Reinforcement Fine-tuning Job
get/v1/accounts/{account_id}/reinforcementFineTuningJobs/{reinforcement_fine_tuning_job_id}Get Reinforcement Fine-tuning Job
delete/v1/accounts/{account_id}/reinforcementFineTuningJobs/{reinforcement_fine_tuning_job_id}Delete Reinforcement Fine-tuning Job
patch/v1/accounts/{account_id}/reinforcementFineTuningJobs/{reinforcement_fine_tuning_job_id}Update Reinforcement Fine-tuning Job
post/v1/accounts/{account_id}/reinforcementFineTuningJobs/{reinforcement_fine_tuning_job_id}:cancelCancel Reinforcement Fine-tuning Job
post/v1/accounts/{account_id}/reinforcementFineTuningJobs/{reinforcement_fine_tuning_job_id}:debugDebug 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}:resumeResume Reinforcement Fine-tuning Job
get/v1/accounts/{account_id}/rlorTrainerJobsList Reinforcement Fine-tuning Steps
post/v1/accounts/{account_id}/rlorTrainerJobsCreate 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}/checkpointsList checkpoints for an RLOR Trainer Job
post/v1/accounts/{account_id}/rlorTrainerJobs/{rlor_trainer_job_id}/checkpoints/{checkpoint_id}:syncEnsure an RLOR training checkpoint is present in the requested storage availability class. By default this copies a single-region runtime checkpoint into managed durable storage. Set request.target_availability=SINGLE_REGION to stage a durable checkpoint into request.region before restoring there.
get/v1/accounts/{account_id}/rlorTrainerJobs/{rlor_trainer_job_id}/publicLogsGet a signed URL for the public trainer logs of an RLOR Trainer Job.
post/v1/accounts/{account_id}/rlorTrainerJobs/{rlor_trainer_job_id}:cancelCancel Rlor Trainer Job
post/v1/accounts/{account_id}/rlorTrainerJobs/{rlor_trainer_job_id}:resumeResume Rlor Trainer Job
get/v1/accounts/{account_id}/routersList Routers
post/v1/accounts/{account_id}/routersCreate Router
get/v1/accounts/{account_id}/routers/{router_id}CRUD APIs for routers. Get Router
delete/v1/accounts/{account_id}/routers/{router_id}Delete Router
patch/v1/accounts/{account_id}/routers/{router_id}Update Router
get/v1/accounts/{account_id}/secretsList Secrets
post/v1/accounts/{account_id}/secrets
get/v1/accounts/{account_id}/secrets/{secret_id}Get Secret
delete/v1/accounts/{account_id}/secrets/{secret_id}
patch/v1/accounts/{account_id}/secrets/{secret_id}
get/v1/accounts/{account_id}/serverlessModelsList serverless models available to the account (public catalog).
get/v1/accounts/{account_id}/serverlessRateLimitsLists 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}/serverlessTokenUsageServerless pool token throughput (tokens per minute) by time bucket and base model, from production usage metrics.
get/v1/accounts/{account_id}/supervisedFineTuningJobsList Supervised Fine-tuning Jobs
post/v1/accounts/{account_id}/supervisedFineTuningJobsCreate 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}:cancelCancel Supervised Fine-tuning Job
post/v1/accounts/{account_id}/supervisedFineTuningJobs/{supervised_fine_tuning_job_id}:resumeResume Supervised Fine-tuning Job
post/v1/accounts/{account_id}/supervisedFineTuningJobs:estimateCostEstimate the cost of a Supervised Fine-tuning Job
get/v1/accounts/{account_id}/trailsList Trails
post/v1/accounts/{account_id}/trailsCreate Trail
get/v1/accounts/{account_id}/trails/{trail_id}CRUD APIs for trails. Get Trail
delete/v1/accounts/{account_id}/trails/{trail_id}Delete Trail
patch/v1/accounts/{account_id}/trails/{trail_id}Update Trail
get/v1/accounts/{account_id}/trails/{trail_id}:getMetricsGet Trail Metrics (trace counts, token usage from tracing service)
get/v1/accounts/{account_id}/trainingRunsList training runs under an account (Tinker RestClient list_training_runs).
post/v1/accounts/{account_id}/trainingRunsCreate a training run: the durable, account-owned model lineage for a Tinker create_lora_training_client. A session may host many runs, and a run may span sessions across resume.
get/v1/accounts/{account_id}/trainingRuns/{training_run_id}Get a training run (Tinker RestClient get_training_run parity).
post/v1/accounts/{account_id}/trainingRuns/{training_run_id}:abortMaterializationAbort a pending training run when trainer materialization failed or timed out. INTERNAL: api_gateway calls this on failed Tinker create_model.
post/v1/accounts/{account_id}/trainingRuns/{training_run_id}:finalizeMaterializationFinalize a training run after the trainer has successfully materialized its run-scoped model id. INTERNAL: api_gateway calls this after proxying Tinker create_model to the trainer.
get/v1/accounts/{account_id}/trainingSessionsList training sessions under an account.
post/v1/accounts/{account_id}/trainingSessionsCreate a training session under an account.
get/v1/accounts/{account_id}/trainingSessions/{training_session_id}Get a training session.
delete/v1/accounts/{account_id}/trainingSessions/{training_session_id}Delete a training session. Releases the shared-trainer binding before removing the row; the session transitions DELETING → gone.
get/v1/accounts/{account_id}/trainingSessions/{training_session_id}/checkpointsList the checkpoints saved during a TrainingSession. Access is scoped to the session's account.
post/v1/accounts/{account_id}/trainingSessions/{training_session_id}/checkpoints/{checkpoint_id}:promotePromote a checkpoint saved during a TrainingSession into a customer-owned Model, identified by checkpoint_name. Only promotable (inference) checkpoints can be promoted.
get/v1/accounts/{account_id}/trainingSessions/{training_session_id}/chunkOutputsList chunk completion events on a TrainingSession.
post/v1/accounts/{account_id}/trainingSessions/{training_session_id}/chunkOutputsCreate a chunk-completion row on a TrainingSession (per-chunk distributions, dataset refs, checkpoints). Trainer-driven write; the server validates the parent session and materializes the row.
get/v1/accounts/{account_id}/trainingSessions/{training_session_id}/trainingCurvesList scalar training curves for line charts on a TrainingSession.
post/v1/accounts/{account_id}/trainingSessions/{training_session_id}:loadStateLoad or switch the LoRA adapter state for a training session.
post/v1/accounts/{account_id}/trainingSessions/{training_session_id}:logMetricsLog scalar training metrics on a TrainingSession (append-only time-series, upserts on (session, key, step) so retries are idempotent).
get/v1/accounts/{account_id}/trainingShapesList Training Shapes
post/v1/accounts/{account_id}/trainingShapesCRUD APIs for training shape. Create Training Shape
get/v1/accounts/{account_id}/trainingShapes/{training_shape_id}Get Training Shape
delete/v1/accounts/{account_id}/trainingShapes/{training_shape_id}Delete Training Shape
patch/v1/accounts/{account_id}/trainingShapes/{training_shape_id}Update Training Shape
get/v1/accounts/{account_id}/trainingShapes/{training_shape_id}/versionsList 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}/usageLimitIncreaseRequestsLists the account's limit-increase requests (admin), filterable by state.
post/v1/accounts/{account_id}/usageLimitIncreaseRequestsFiles a member's request to raise their own per-user serverless cap.
post/v1/accounts/{account_id}/usageLimitIncreaseRequests/{usage_limit_increase_request_id}:approveApproves a pending limit-increase request (admin).
post/v1/accounts/{account_id}/usageLimitIncreaseRequests/{usage_limit_increase_request_id}:rejectRejects a pending limit-increase request (admin).
get/v1/accounts/{account_id}/usageLimitsReturns the account-level usage-limits singleton (default per-user cap, enforcement, account-wide usage rollup).
patch/v1/accounts/{account_id}/usageLimitsUpdates the account-level usage-limits singleton (default per-user cap, enforcement).
get/v1/accounts/{account_id}/userUsageLimitsLists every user's usage limits in the account (the roster: usage vs. effective cap and over-limit status per user).
get/v1/accounts/{account_id}/usersList Users
post/v1/accounts/{account_id}/usersCreate 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}/apiKeysList API Keys
post/v1/accounts/{account_id}/users/{user_id}/apiKeysCreate API Key
get/v1/accounts/{account_id}/users/{user_id}/apiKeys/accounts/{account_id}/users/{user_id}Get API Key
patch/v1/accounts/{account_id}/users/{user_id}/apiKeys/accounts/{account_id}/users/{user_id}Update API Key. Only `display_name` and `expire_time` may be modified;
post/v1/accounts/{account_id}/users/{user_id}/apiKeys:deleteDelete API Key
get/v1/accounts/{account_id}/users/{user_id}/usageLimitsReturns a single user's usage-limits singleton (override, effective cap, usage, and whether they are over limit).
patch/v1/accounts/{account_id}/users/{user_id}/usageLimitsUpdates a single user's usage-limits singleton (limit_override). Clearing the override reverts the user to the account default.
post/v1/accounts/{account_id}:testevalSimilar to preview evaluation, but no need to create the evaluation entry first.

responses.openapi_other4

text-completion.openapi_other2

gateway.openapi_Gateway

Changes to Get External Key

get/v1/accounts/{account_id}/externalKeys/{external_key_id}

Oct 16, 20263bf245180173 Revision changes
- info
  endpoint added