POST
/
v1
/
accounts
/
{account_id}
/
models

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

account_id
string
required

The Account Id

Body

application/json
model
object

The properties of the Model being created.

modelId
string
required

ID of the model.

cluster
string

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

200 - application/json
name
string
displayName
string

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

description
string

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

createTime
string

The creation time of the model.

createdBy
string

The email address of the user who created this model.

state
enum<string>
default: STATE_UNSPECIFIED

The state of the model.

Available options:
STATE_UNSPECIFIED,
UPLOADING,
READY
status
object

Contains detailed message when the last model operation fails.

kind
enum<string>
default: KIND_UNSPECIFIED

The kind of model. If not specified, the default is HF_PEFT_ADDON.

Available options:
KIND_UNSPECIFIED,
HF_BASE_MODEL,
HF_PEFT_ADDON,
HF_TEFT_ADDON,
FLUMINA_BASE_MODEL,
FLUMINA_ADDON,
DRAFT_ADDON
githubUrl
string

The URL to GitHub repository of the model.

huggingFaceUrl
string

The URL to the Hugging Face model.

baseModelDetails
object

Base model details. Required if kind is HF_BASE_MODEL. Must not be set otherwise.

peftDetails
object

PEFT addon details. Required if kind is HF_PEFT_ADDON or HF_TEFT_ADDON.

teftDetails
object

TEFT addon details. Required if kind is HF_TEFT_ADDON. Must not be set otherwise.

public
boolean

If true, the model will be publicly readable.

conversationConfig
object

If set, the Chat Completions API will be enabled for this model.

contextLength
integer

The maximum context length supported by the model.

supportsImageInput
boolean

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

supportsTools
boolean

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.

importedFrom
string

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

fineTuningJob
string

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

defaultDraftModel
string

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

defaultDraftTokenCount
integer

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

precisions
enum<string>[]
Available options:
PRECISION_UNSPECIFIED,
FP16,
FP8,
FP8_MM,
FP8_AR,
FP8_MM_KV_ATTN,
FP8_KV,
FP8_MM_V2,
FP8_V2,
FP8_MM_KV_ATTN_V2
deployedModelRefs
object[]

Populated from GetModel API call only.

cluster
string

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.

deprecationDate
object

If specified, this is the date when the serverless deployment of the model will be taken down.

Was this page helpful?

Get ModelUpdate Model