Get Model

Get Model

curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/models/{model_id} \
  --header 'Authorization: Bearer <token>'

{
  "name": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "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>",
    "supportsFireattention": true,
    "defaultPrecision": "PRECISION_UNSPECIFIED",
    "supportsMtp": true
  },
  "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,
  "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",
  "defaultSamplingParams": {},
  "rlTunable": true,
  "supportedPrecisions": [
    "PRECISION_UNSPECIFIED"
  ],
  "supportedPrecisionsWithCalibration": [
    "PRECISION_UNSPECIFIED"
  ],
  "trainingContextLength": 123,
  "snapshotType": "FULL_SNAPSHOT"
}

GET

accounts

{account_id}

models

{model_id}

Get Model

curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/models/{model_id} \
  --header 'Authorization: Bearer <token>'

{
  "name": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "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>",
    "supportsFireattention": true,
    "defaultPrecision": "PRECISION_UNSPECIFIED",
    "supportsMtp": true
  },
  "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,
  "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",
  "defaultSamplingParams": {},
  "rlTunable": true,
  "supportedPrecisions": [
    "PRECISION_UNSPECIFIED"
  ],
  "supportedPrecisionsWithCalibration": [
    "PRECISION_UNSPECIFIED"
  ],
  "trainingContextLength": 123,
  "snapshotType": "FULL_SNAPSHOT"
}

Authorizations

Authorization

string

header

required

Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>

Path Parameters

account_id

string

required

The Account Id

model_id

string

required

The Model Id

Query Parameters

readMask

string

The fields to be returned in the response. If empty or "*", all fields will be returned.

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<date-time>

The creation time of the model.

state

enum<string>

default:STATE_UNSPECIFIED

The state of the model.

Available options:

STATE_UNSPECIFIED,

UPLOADING,

READY

status

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

Contains detailed message when the last model operation fails.

Show child attributes

status.code

enum<string>

default:OK

The status code.

Available options:

OK,

CANCELLED,

UNKNOWN,

INVALID_ARGUMENT,

DEADLINE_EXCEEDED,

NOT_FOUND,

ALREADY_EXISTS,

PERMISSION_DENIED,

UNAUTHENTICATED,

RESOURCE_EXHAUSTED,

FAILED_PRECONDITION,

ABORTED,

OUT_OF_RANGE,

UNIMPLEMENTED,

INTERNAL,

UNAVAILABLE,

DATA_LOSS

status.message

string

A developer-facing error message in English.

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,

CUSTOM_MODEL,

EMBEDDING_MODEL,

SNAPSHOT_MODEL

githubUrl

string

The URL to GitHub repository of the model.

huggingFaceUrl

string

The URL to the Hugging Face model.

baseModelDetails

Next ID: 11 · object

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

Show child attributes

baseModelDetails.worldSize

integer<int32>

The default number of GPUs the model is served with. If not specified, the default is 1.

baseModelDetails.checkpointFormat

enum<string>

default:CHECKPOINT_FORMAT_UNSPECIFIED

Available options:

CHECKPOINT_FORMAT_UNSPECIFIED,

NATIVE,

HUGGINGFACE

baseModelDetails.parameterCount

string<int64>

The number of model parameters. For serverless models, this determines the price per token.

baseModelDetails.moe

boolean

If true, this is a Mixture of Experts (MoE) model. For serverless models, this affects the price per token.

baseModelDetails.tunable

boolean

If true, this model is available for fine-tuning.

baseModelDetails.modelType

string

The type of the model.

baseModelDetails.supportsFireattention

boolean

Whether this model supports fireattention.

baseModelDetails.defaultPrecision

enum<string>

default:PRECISION_UNSPECIFIED

Default precision of the model.

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,

FP4,

BF16,

FP4_BLOCKSCALED_MM,

FP4_MX_MOE

baseModelDetails.supportsMtp

boolean

If true, this model supports MTP.

peftDetails

PEFT addon details. Next ID: 6 · object

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

Show child attributes

peftDetails.baseModel

string

required

peftDetails.r

integer<int32>

required

The rank of the update matrices. Must be between 4 and 64, inclusive.

peftDetails.targetModules

string[]

required

peftDetails.baseModelType

string

The type of the model.

peftDetails.mergeAddonModelName

string

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.

Show child attributes

conversationConfig.style

string

required

The chat template to use.

conversationConfig.system

string

The system prompt (if the chat style supports it).

conversationConfig.template

string

The Jinja template (if style is "jinja").

contextLength

integer<int32>

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<int32>

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

deployedModelRefs

Next ID: 6 · object[]

Populated from GetModel API call only.

Show child attributes

deployedModelRefs.name

string

deployedModelRefs.deployment

string

The resource name of the base deployment the model is deployed to.

deployedModelRefs.state

enum<string>

default:STATE_UNSPECIFIED

The state of the deployed model.

Available options:

STATE_UNSPECIFIED,

UNDEPLOYING,

DEPLOYING,

DEPLOYED,

UPDATING

deployedModelRefs.default

boolean

If true, this is the default target when querying this model without the #<deployment> suffix. The first deployment a model is deployed to will have this field set to true automatically.

deployedModelRefs.public

boolean

If true, the deployed model will be publicly reachable.

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

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: · object

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

Show child attributes

deprecationDate.year

integer<int32>

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

deprecationDate.month

integer<int32>

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

deprecationDate.day

integer<int32>

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

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<date-time>

The update time for the model.

defaultSamplingParams

object

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

Show child attributes

defaultSamplingParams.{key}

number<float>

rlTunable

boolean

If true, the model is RL tunable.

supportedPrecisions

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,

FP4,

BF16,

FP4_BLOCKSCALED_MM,

FP4_MX_MOE

supportedPrecisionsWithCalibration

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,

FP4,

BF16,

FP4_BLOCKSCALED_MM,

FP4_MX_MOE

trainingContextLength

integer<int32>

The maximum context length supported by the model.

snapshotType

enum<string>

default:FULL_SNAPSHOT

Available options:

FULL_SNAPSHOT,

INCREMENTAL_SNAPSHOT

List Models

Get Model Download Endpoint

⌘I

API Reference

Inference

Deployments

Fine-tuning

Multimedia

Admin

Build SDK (Deprecated)

Authorizations

Path Parameters

Query Parameters

Response