API Reference
Inference
Deployments
Fine-tuning
Evals
Multimedia
Admin
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",
"huggingfaceFiles": [
"<string>"
],
"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,
"trainingContextLength": 123,
"snapshotType": "FULL_SNAPSHOT",
"supportsServerless": true,
"supervisedLoraTunable": true,
"supervisedFullParameterTunable": true,
"rlLoraTunable": true,
"rlFullParameterTunable": true
}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",
"huggingfaceFiles": [
"<string>"
],
"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,
"trainingContextLength": 123,
"snapshotType": "FULL_SNAPSHOT",
"supportsServerless": true,
"supervisedLoraTunable": true,
"supervisedFullParameterTunable": true,
"rlLoraTunable": true,
"rlFullParameterTunable": true
}Authorizations
Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>
Query Parameters
The fields to be returned in the response. If empty or "*", all fields will be returned.
Response
A successful response.
Human-readable display name of the model. e.g. "My Model" Must be fewer than 64 characters long.
The description of the model. Must be fewer than 1000 characters long.
The creation time of the model.
The state of the model.
STATE_UNSPECIFIED, UPLOADING, READY Contains detailed message when the last model operation fails.
Show child attributes
Show child attributes
The kind of model. If not specified, the default is HF_PEFT_ADDON.
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 The URL to GitHub repository of the model.
The URL to the Hugging Face model.
Base model details. Required if kind is HF_BASE_MODEL. Must not be set otherwise.
Show child attributes
Show child attributes
PEFT addon details. Required if kind is HF_PEFT_ADDON or HF_TEFT_ADDON.
Show child attributes
Show child attributes
TEFT addon details. Required if kind is HF_TEFT_ADDON. Must not be set otherwise.
If true, the model will be publicly readable.
If set, the Chat Completions API will be enabled for this model.
Show child attributes
Show child attributes
The maximum context length supported by the model.
If set, images can be provided as input to the model.
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.
The name of the the model from which this was imported. This field is empty if the model was not imported.
If the model was created from a fine-tuning job, this is the fine-tuning job name.
The default draft model to use when creating a deployment. If empty, speculative decoding is disabled by default.
The default draft token count to use when creating a deployment. Must be specified if default_draft_model is specified.
Populated from GetModel API call only.
Show child attributes
Show child attributes
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.
If specified, this is the date when the serverless deployment of the model will be taken down.
Show child attributes
Show child attributes
If true, the model is calibrated and can be deployed to non-FP16 precisions.
Deprecated: V1 training stack only — LoRA only, limited architecture support. If the model has use_training_v2=true and your account has AllowTrainingV2, use supervised_lora_tunable and supervised_full_parameter_tunable instead.
Whether this model supports LoRA.
If true, the model will use the Hugging Face apply_chat_template API to apply the chat template.
The update time for the model.
A json object that contains the default sampling parameters for the model.
Show child attributes
Show child attributes
Deprecated: V1 training stack only — LoRA only, limited architecture support. If the model has use_training_v2=true and your account has AllowTrainingV2, use rl_lora_tunable and rl_full_parameter_tunable instead.
The maximum context length supported by the model.
FULL_SNAPSHOT, INCREMENTAL_SNAPSHOT If true, the model has a serverless deployment.
V2 only. Whether the model supports LoRA supervised fine-tuning and DPO (lora_rank > 0). True when a validated LORA_TRAINER training shape exists.
V2 only. Whether the model supports full-parameter supervised fine-tuning and DPO (lora_rank = 0). True when a validated POLICY_TRAINER training shape exists.
V2 only. Whether the model supports LoRA reinforcement learning (lora_rank > 0). True when a validated LORA_TRAINER training shape exists plus a deployment shape.
V2 only. Whether the model supports full-parameter reinforcement learning (lora_rank = 0). True when validated POLICY_TRAINER + FORWARD_ONLY training shapes exist plus a deployment shape.
Was this page helpful?