PATCH
https://api.fireworks.ai
/
v1
/
accounts
/
{account_id}
/
models
/
{model_id}
curl --request PATCH \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/models/{model_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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>",
    "supportsFireattention": true
  },
  "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
}'
{
  "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>",
    "supportsFireattention": 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,
  "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",
  "defaultSamplingParams": {}
}

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

​
model_id
string
required

The Model Id

Body

application/json

The properties of the model being updated. model.name must be populated with the updated resource's name.

The body is of type object.

Response

200 - application/json

A successful response.

The response is of type object.