Get Cluster

 - 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 operational.
Consult 'status' for detailed messaging.
Cluster needs to be deleted and re-created.

- OK: Not an error; returned on success.

HTTP Mapping: 200 OK
 - CANCELLED: The operation was cancelled, typically by the caller.

HTTP Mapping: 499 Client Closed Request
 - UNKNOWN: Unknown error.  For example, this error may be returned when
a `Status` value received from another address space belongs to
an error space that is not known in this address space.  Also
errors raised by APIs that do not return enough error information
may be converted to this error.

HTTP Mapping: 500 Internal Server Error
 - INVALID_ARGUMENT: The client specified an invalid argument.  Note that this differs
from `FAILED_PRECONDITION`.  `INVALID_ARGUMENT` indicates arguments
that are problematic regardless of the state of the system
(e.g., a malformed file name).

HTTP Mapping: 400 Bad Request
 - DEADLINE_EXCEEDED: The deadline expired before the operation could complete. For operations
that change the state of the system, this error may be returned
even if the operation has completed successfully.  For example, a
successful response from a server could have been delayed long
enough for the deadline to expire.

HTTP Mapping: 504 Gateway Timeout
 - NOT_FOUND: Some requested entity (e.g., file or directory) was not found.

Note to server developers: if a request is denied for an entire class
of users, such as gradual feature rollout or undocumented allowlist,
`NOT_FOUND` may be used. If a request is denied for some users within
a class of users, such as user-based access control, `PERMISSION_DENIED`
must be used.

HTTP Mapping: 404 Not Found
 - ALREADY_EXISTS: The entity that a client attempted to create (e.g., file or directory)
already exists.

HTTP Mapping: 409 Conflict
 - PERMISSION_DENIED: The caller does not have permission to execute the specified
operation. `PERMISSION_DENIED` must not be used for rejections
caused by exhausting some resource (use `RESOURCE_EXHAUSTED`
instead for those errors). `PERMISSION_DENIED` must not be
used if the caller can not be identified (use `UNAUTHENTICATED`
instead for those errors). This error code does not imply the
request is valid or the requested entity exists or satisfies
other pre-conditions.

HTTP Mapping: 403 Forbidden
 - UNAUTHENTICATED: The request does not have valid authentication credentials for the
operation.

HTTP Mapping: 401 Unauthorized
 - RESOURCE_EXHAUSTED: Some resource has been exhausted, perhaps a per-user quota, or
perhaps the entire file system is out of space.

HTTP Mapping: 429 Too Many Requests
 - FAILED_PRECONDITION: The operation was rejected because the system is not in a state
required for the operation's execution.  For example, the directory
to be deleted is non-empty, an rmdir operation is applied to
a non-directory, etc.

Service implementors can use the following guidelines to decide
between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:
 (a) Use `UNAVAILABLE` if the client can retry just the failing call.
 (b) Use `ABORTED` if the client should retry at a higher level. For
     example, when a client-specified test-and-set fails, indicating the
     client should restart a read-modify-write sequence.
 (c) Use `FAILED_PRECONDITION` if the client should not retry until
     the system state has been explicitly fixed. For example, if an "rmdir"
     fails because the directory is non-empty, `FAILED_PRECONDITION`
     should be returned since the client should not retry unless
     the files are deleted from the directory.

HTTP Mapping: 400 Bad Request
 - ABORTED: The operation was aborted, typically due to a concurrency issue such as
a sequencer check failure or transaction abort.

See the guidelines above for deciding between `FAILED_PRECONDITION`,
`ABORTED`, and `UNAVAILABLE`.

HTTP Mapping: 409 Conflict
 - OUT_OF_RANGE: The operation was attempted past the valid range.  E.g., seeking or
reading past end-of-file.

Unlike `INVALID_ARGUMENT`, this error indicates a problem that may
be fixed if the system state changes. For example, a 32-bit file
system will generate `INVALID_ARGUMENT` if asked to read at an
offset that is not in the range [0,2^32-1], but it will generate
`OUT_OF_RANGE` if asked to read from an offset past the current
file size.

There is a fair bit of overlap between `FAILED_PRECONDITION` and
`OUT_OF_RANGE`.  We recommend using `OUT_OF_RANGE` (the more specific
error) when it applies so that callers who are iterating through
a space can easily look for an `OUT_OF_RANGE` error to detect when
they are done.

HTTP Mapping: 400 Bad Request
 - UNIMPLEMENTED: The operation is not implemented or is not supported/enabled in this
service.

HTTP Mapping: 501 Not Implemented
 - INTERNAL: Internal errors.  This means that some invariants expected by the
underlying system have been broken.  This error code is reserved
for serious errors.

HTTP Mapping: 500 Internal Server Error
 - UNAVAILABLE: The service is currently unavailable.  This is most likely a
transient condition, which can be corrected by retrying with
a backoff. Note that it is not always safe to retry
non-idempotent operations.

See the guidelines above for deciding between `FAILED_PRECONDITION`,
`ABORTED`, and `UNAVAILABLE`.

HTTP Mapping: 503 Service Unavailable
 - DATA_LOSS: Unrecoverable data loss or corruption.

HTTP Mapping: 500 Internal Server Error

Mimics [https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto]

The 12-digit AWS account ID where this cluster lives.

The IAM role ARN used to manage Fireworks resources on AWS.
If not specified, the default is arn:aws:iam::<aws_account_id>:role/FireworksManagerRole

The IAM role ARN used by the inference pods on the cluster.

The IAM role ARN used by the EKS load balancer controller (i.e. the load balancer
automatically created for the k8s gateway resource). If not specified, no gateway
will be created.

The IAM role ARN used by Google Managed Prometheus role that will write metrics
to Fireworks managed Prometheus. The role must be assumable by the
`system:serviceaccount:gmp-system:collector` service account on the EKS cluster.
If not specified, no metrics will be written to GCP.

The AWS region where this cluster lives. See https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html
for a list of available regions.

The ID of the GCP workload identity pool provider in the Fireworks
project for this cluster. The pool ID is assumed to be "byoc-pool"

An Amazon Elastic Kubernetes Service cluster.
Next ID: 16

A fake cluster using https://pkg.go.dev/k8s.io/client-go/kubernetes/fake

A developer-facing error message in English.

Mimics [https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto]

BearerAuth

Next ID: 15

Fireworks AI Docs

Introducing the Fireworks Build SDK

Basics of the Build SDK

Tutorial

Developing Evaluators

Reference

Learn to create, deploy, and manage resources using Firectl

Getting started

Authentication for access to your account

Authentication

List various resources in a Fireworks account

List resources

Create a Deployment on Fireworks AI platform

Create a deployment

Create a fine-tuning job with a base model

Create a fine-tuning job

Create a Dataset on the Fireworks platform

Create a dataset

Create model

Deletes a resource(s) in a Fireworks account

Delete resources

Load LoRA

Unload LoRA

Download a model from third-party locations

Download a model

Retrieves information from the Fireworks platform

Get resources

Updates resources on the Fireworks platform

Update resources

Undelete resources on the Fireworks platform

Undelete resources

Introduction

Creates a model response for the given chat conversation.

Create Chat Completion

Creates a completion for the provided prompt and parameters.

Create Completion

Creates a model response, optionally interacting with custom tools via the Model Context Protocol (MCP). This endpoint supports conversational continuation and streaming. Explore our cookbooks for detailed examples: - [Basic MCP Usage](https://github.com/fw-ai/cookbook/blob/main/learn/response-api/fireworks_mcp_examples.ipynb) - [Streaming with MCP](https://github.com/fw-ai/cookbook/blob/main/learn/response-api/fireworks_mcp_with_streaming.ipynb) - [Conversational History with `previous_response_id`](https://github.com/fw-ai/cookbook/blob/main/learn/response-api/fireworks_previous_response_cookbook.ipynb) - [Basic Streaming](https://github.com/fw-ai/cookbook/blob/main/learn/response-api/fireworks_streaming_example.ipynb) - [Controlling Response Storage](https://github.com/fw-ai/cookbook/blob/main/learn/response-api/mcp_server_with_store_false_argument.ipynb)


Create a model response

Create embeddings

Generate an image with FLUX.1 [schnell] FP8

Generate or edit an image with FLUX.1 Kontext

Get generated image from FLUX.1 Kontext

Streaming Transcription

Transcribe audio

Translate audio

Create Batch Request

Check Batch Status

Get Account

List Deployments

Get Deployment

Create Deployment

Update Deployment

Delete Deployment

Undelete Deployment

List Models

Get Model

Create Model

Update Model

Prepare Model for different precisions

Get Model Upload Endpoint

Get Model Download Endpoint

Validate Model Upload

Delete Model

List LoRAs

Get LoRA

Update LoRA

List Supervised Fine-tuning Jobs

Get Supervised Fine-tuning Job

Create Supervised Fine-tuning Job

Delete Supervised Fine-tuning Job

List Reinforcement Fine-tuning Jobs

Get Reinforcement Fine-tuning Job

Create Reinforcement Fine-tuning Job

Delete Reinforcement Fine-tuning Job

List Datasets

Get Dataset

Create Dataset

Provides a streamlined way to upload a dataset file in a single API request. This path can handle file sizes up to 150Mb. For larger file sizes use [Get Dataset Upload Endpoint](get-dataset-upload-endpoint).


Upload Dataset Files

Get Dataset Upload Endpoint

Validate Dataset Upload

Update Dataset

Delete Dataset

List Users

Get User

Create User

Update User

List API Keys

Create API Key

Delete API Key

List Batch Jobs

Get Batch Job

Create Batch Job

Update Batch Job

Cancels an existing batch job if it is queued, pending, or running.

Cancel Batch Job

Get Batch Job Logs

Delete Batch Job

Batch Delete Batch Jobs

List Clusters

Create Cluster

Update Cluster

Delete Cluster

Retrieve connection settings for the cluster to be put in kubeconfig

Get Cluster Connection Info

List Environments

Create Environment

Get Environment

Update Environment

Connects the environment to a node pool.
Returns an error if there is an existing pending connection.

Connect Environment

Disconnects the environment from the node pool. Returns an error
if the environment is not connected to a node pool.

Disconnect Environment

Delete Environment

Batch Delete Environments

List Node Pools

Get Node Pool

Create Node Pool

Update Node Pool

Get Node Pool Stats

Delete Node Pool

Batch Delete Node Pools

List Node Pool Bindings

Create Node Pool Binding

Delete Node Pool Binding

List Snapshots

Get Snapshot

Create Snapshot

Delete Snapshot

List Aws Iam Role Bindings

Create Aws Iam Role Binding

Delete Aws Iam Role Binding

Company account access

What should I do if I can't access my company account after being invited when I already have a personal account?

Close account

How do I close my Fireworks.ai account?

Multiple accounts login

I have multiple Fireworks accounts. When I try to login with Google on Fireworks' web UI, I'm getting signed into the wrong account. How do I fix this?

GitHub authentication email

What email does GitHub authentication use?

LinkedIn authentication email

What email does LinkedIn authentication use?

Pricing structure

How much does Fireworks cost?

Fine-tuned model fees

Are there extra fees for serving fine-tuned models?

Bulk usage discounts

Are there discounts for bulk usage?

Serverless discounts

Are there discounts for bulk spend on serverless deployments?

Credits & billing system

How does billing and credit usage work?

Account suspension reasons

Why might my account be suspended even with remaining credits?

Missing credits issue

I bought credits but don’t see them reflected in my account. Did they disappear?

Invoice vs credits

Why did I receive an invoice when I only deposited credits?

Credit receipts

Where's my receipt for purchased credits?

Models API billing

Are calls to the Models API billable?

Serverless prompt caching billing

Is prompt caching billed differently for serverless models?

Performance optimization

What are the techniques to improve performance?

Performance benchmarking

How can we benchmark?

Model latency ranges

What’s the latency for small, medium, and large LLM models?

Performance factors

What factors affect model latency and performance?

Performance best practices

What are the best practices for optimizing performance?

Serverless latency guarantees

Is latency guaranteed for serverless models?

Serverless SLAs

Are there any SLAs for serverless models?

Serverless quotas

Are there any quotas for serverless?

Fine-tuned serverless costs

Are there costs associated with deploying fine-tuned models to serverless infrastructure?

Model removal notice

Do you provide notice before removing model availability?

Batch jobs

Clusters

Environments

Node pools

Node pool bindings

Snapshots

AWS IAM role bindings

Get Cluster

Authorizations

Path Parameters

Query Parameters

Response