Create Model

POST

accounts

{account_id}

models

curl --request POST \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/models \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": {
    "displayName": "<string>",
    "description": "<string>",
    "kind": "KIND_UNSPECIFIED",
    "githubUrl": "<string>",
    "huggingFaceUrl": "<string>",
    "baseModelDetails": {
      "worldSize": 123,
      "checkpointFormat": "CHECKPOINT_FORMAT_UNSPECIFIED",
      "parameterCount": "<string>",
      "moe": true,
      "tunable": true,
      "modelType": "<string>"
    },
    "peftDetails": {
      "baseModel": "<string>",
      "r": 123,
      "targetModules": [
        "<string>"
      ],
      "mergeAddonModelName": "<string>"
    },
    "teftDetails": {},
    "public": true,
    "conversationConfig": {
      "style": "<string>",
      "system": "<string>",
      "template": "<string>"
    },
    "contextLength": 123,
    "supportsImageInput": true,
    "supportsTools": true,
    "defaultDraftModel": "<string>",
    "defaultDraftTokenCount": 123,
    "deprecationDate": {
      "year": 123,
      "month": 123,
      "day": 123
    },
    "supportsLora": true,
    "useHfApplyChatTemplate": true
  },
  "modelId": "<string>",
  "cluster": "<string>"
}'

{
  "name": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "state": "STATE_UNSPECIFIED",
  "status": {
    "code": "OK",
    "message": "<string>"
  },
  "kind": "KIND_UNSPECIFIED",
  "githubUrl": "<string>",
  "huggingFaceUrl": "<string>",
  "baseModelDetails": {
    "worldSize": 123,
    "checkpointFormat": "CHECKPOINT_FORMAT_UNSPECIFIED",
    "parameterCount": "<string>",
    "moe": true,
    "tunable": true,
    "modelType": "<string>"
  },
  "peftDetails": {
    "baseModel": "<string>",
    "r": 123,
    "targetModules": [
      "<string>"
    ],
    "baseModelType": "<string>",
    "mergeAddonModelName": "<string>"
  },
  "teftDetails": {},
  "public": true,
  "conversationConfig": {
    "style": "<string>",
    "system": "<string>",
    "template": "<string>"
  },
  "contextLength": 123,
  "supportsImageInput": true,
  "supportsTools": true,
  "importedFrom": "<string>",
  "fineTuningJob": "<string>",
  "defaultDraftModel": "<string>",
  "defaultDraftTokenCount": 123,
  "precisions": [
    "PRECISION_UNSPECIFIED"
  ],
  "deployedModelRefs": [
    {
      "name": "<string>",
      "deployment": "<string>",
      "state": "STATE_UNSPECIFIED",
      "default": true,
      "public": true
    }
  ],
  "cluster": "<string>",
  "deprecationDate": {
    "year": 123,
    "month": 123,
    "day": 123
  },
  "calibrated": true,
  "tunable": true,
  "supportsLora": true,
  "useHfApplyChatTemplate": true,
  "updateTime": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

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

modelId

string

required

ID of the model.

model

object

The properties of the Model being created.

model.displayName

string

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

model.description

string

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

model.state

enum<string>

default:STATE_UNSPECIFIED

The state of the model.

Available options:

STATE_UNSPECIFIED,

UPLOADING,

READY

model.status

object

Contains detailed message when the last model operation fails.

model.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,

FIRE_AGENT,

LIVE_MERGE

model.githubUrl

string

The URL to GitHub repository of the model.

model.huggingFaceUrl

string

The URL to the Hugging Face model.

model.baseModelDetails

object

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

model.peftDetails

object

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

model.teftDetails

object

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

model.public

boolean

If true, the model will be publicly readable.

model.conversationConfig

object

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

model.contextLength

integer

The maximum context length supported by the model.

model.supportsImageInput

boolean

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

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.

model.defaultDraftModel

string

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

model.defaultDraftTokenCount

integer

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

model.deprecationDate

object

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

model.supportsLora

boolean

Whether this model supports LoRA.

model.useHfApplyChatTemplate

boolean

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

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

A successful response.

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,

FIRE_AGENT,

LIVE_MERGE

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,

NF4

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.

calibrated

boolean

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

tunable

boolean

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.

supportsLora

boolean

Whether this model supports LoRA.

useHfApplyChatTemplate

boolean

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

updateTime

string

The update time for the model.

Get Model Update Model

curl --request POST \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/models \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": {
    "displayName": "<string>",
    "description": "<string>",
    "kind": "KIND_UNSPECIFIED",
    "githubUrl": "<string>",
    "huggingFaceUrl": "<string>",
    "baseModelDetails": {
      "worldSize": 123,
      "checkpointFormat": "CHECKPOINT_FORMAT_UNSPECIFIED",
      "parameterCount": "<string>",
      "moe": true,
      "tunable": true,
      "modelType": "<string>"
    },
    "peftDetails": {
      "baseModel": "<string>",
      "r": 123,
      "targetModules": [
        "<string>"
      ],
      "mergeAddonModelName": "<string>"
    },
    "teftDetails": {},
    "public": true,
    "conversationConfig": {
      "style": "<string>",
      "system": "<string>",
      "template": "<string>"
    },
    "contextLength": 123,
    "supportsImageInput": true,
    "supportsTools": true,
    "defaultDraftModel": "<string>",
    "defaultDraftTokenCount": 123,
    "deprecationDate": {
      "year": 123,
      "month": 123,
      "day": 123
    },
    "supportsLora": true,
    "useHfApplyChatTemplate": true
  },
  "modelId": "<string>",
  "cluster": "<string>"
}'

{
  "name": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "state": "STATE_UNSPECIFIED",
  "status": {
    "code": "OK",
    "message": "<string>"
  },
  "kind": "KIND_UNSPECIFIED",
  "githubUrl": "<string>",
  "huggingFaceUrl": "<string>",
  "baseModelDetails": {
    "worldSize": 123,
    "checkpointFormat": "CHECKPOINT_FORMAT_UNSPECIFIED",
    "parameterCount": "<string>",
    "moe": true,
    "tunable": true,
    "modelType": "<string>"
  },
  "peftDetails": {
    "baseModel": "<string>",
    "r": 123,
    "targetModules": [
      "<string>"
    ],
    "baseModelType": "<string>",
    "mergeAddonModelName": "<string>"
  },
  "teftDetails": {},
  "public": true,
  "conversationConfig": {
    "style": "<string>",
    "system": "<string>",
    "template": "<string>"
  },
  "contextLength": 123,
  "supportsImageInput": true,
  "supportsTools": true,
  "importedFrom": "<string>",
  "fineTuningJob": "<string>",
  "defaultDraftModel": "<string>",
  "defaultDraftTokenCount": 123,
  "precisions": [
    "PRECISION_UNSPECIFIED"
  ],
  "deployedModelRefs": [
    {
      "name": "<string>",
      "deployment": "<string>",
      "state": "STATE_UNSPECIFIED",
      "default": true,
      "public": true
    }
  ],
  "cluster": "<string>",
  "deprecationDate": {
    "year": 123,
    "month": 123,
    "day": 123
  },
  "calibrated": true,
  "tunable": true,
  "supportsLora": true,
  "useHfApplyChatTemplate": true,
  "updateTime": "2023-11-07T05:31:56Z"
}

API Documentation

LLM API

Embeddings API

Image API

Audio API

Accounts

Deployments

Models

LoRAs

Supervised Fine Tuning Jobs

Users

Datasets

API Keys

Authorizations

Path Parameters

Body

Response