Sign in

v27

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-22216424765.0 KB
gateway.openapi_Gateway

Create Model

post/v1/accounts/{account_id}/models

Path parameters

account_idstring required

The Account Id

Request body

modelIdstring required

ID of the model.

clusterstring

The resource name of the BYOC cluster to which this model belongs. e.g. accounts/my-account/clusters/my-cluster. Empty if it belongs to a Fireworks cluster.

Response

A successful response.

namestring
displayNamestring

Human-readable display name of the model. e.g. "My Model" Must be fewer than 64 characters long.

descriptionstring

The description of the model. Must be fewer than 1000 characters long.

createTimestring date-time

The creation time of the model.

state'STATE_UNSPECIFIED' | 'UPLOADING' | 'READY'
  • UPLOADING: The model is still being uploaded (upload is asynchronous).
  • READY: The model is ready to be used.
kind'KIND_UNSPECIFIED' | 'HF_BASE_MODEL' | 'HF_PEFT_ADDON' | 'HF_TEFT_ADDON' | 'FLUMINA_BASE_MODEL' | 'FLUMINA_ADDON' | 'DRAFT_ADDON' | 'FIRE_AGENT' | 'LIVE_MERGE' | 'CUSTOM_MODEL' | 'EMBEDDING_MODEL' | 'SNAPSHOT_MODEL'
  • HF_BASE_MODEL: An LLM base model.
  • HF_PEFT_ADDON: A parameter-efficent fine-tuned addon.
  • HF_TEFT_ADDON: A token-eficient fine-tuned addon.
  • FLUMINA_BASE_MODEL: A Flumina base model.
  • FLUMINA_ADDON: A Flumina addon.
  • DRAFT_ADDON: A draft model used for speculative decoding in a deployment.
  • FIRE_AGENT: A FireAgent model.
  • LIVE_MERGE: A live-merge model.
  • CUSTOM_MODEL: A customized model
  • EMBEDDING_MODEL: An Embedding model.
  • SNAPSHOT_MODEL: A snapshot model.
githubUrlstring

The URL to GitHub repository of the model.

huggingFaceUrlstring

The URL to the Hugging Face model.

teftDetailsGatewayTEFTDetails
publicboolean

If true, the model will be publicly readable.

contextLengthinteger

The maximum context length supported by the model.

supportsImageInputboolean

If set, images can be provided as input to the model.

supportsToolsboolean

If set, tools (i.e. functions) can be provided as input to the model, and the model may respond with one or more tool calls.

importedFromstring

The name of the the model from which this was imported. This field is empty if the model was not imported.

fineTuningJobstring

If the model was created from a fine-tuning job, this is the fine-tuning job name.

defaultDraftModelstring

The default draft model to use when creating a deployment. If empty, speculative decoding is disabled by default.

defaultDraftTokenCountinteger

The default draft token count to use when creating a deployment. Must be specified if default_draft_model is specified.

clusterstring

The resource name of the BYOC cluster to which this model belongs. e.g. accounts/my-account/clusters/my-cluster. Empty if it belongs to a Fireworks cluster.

calibratedboolean

If true, the model is calibrated and can be deployed to non-FP16 precisions.

tunableboolean

If true, the model can be fine-tuned. The value will be true if the tunable field is true, and the model is validated against the model_type field.

supportsLoraboolean

Whether this model supports LoRA.

useHfApplyChatTemplateboolean

If true, the model will use the Hugging Face apply_chat_template API to apply the chat template.

updateTimestring date-time

The update time for the model.

defaultSamplingParamsobject

A json object that contains the default sampling parameters for the model.

rlTunableboolean

If true, the model is RL tunable.

supportedPrecisionsDeploymentPrecision[]
supportedPrecisionsWithCalibrationDeploymentPrecision[]
trainingContextLengthinteger

The maximum context length supported by the model.

snapshotType'FULL_SNAPSHOT' | 'INCREMENTAL_SNAPSHOT'
supportsServerlessboolean

If true, the model has a serverless deployment.