Match Deployment Shape Versions

curl --request POST \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapeVersions:match \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "createDeploymentRequest": {
    "deployment": {
      "baseModel": "<string>",
      "enableAddons": true
    }
  }
}
'

import requests

url = "https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapeVersions:match"

payload = { "createDeploymentRequest": { "deployment": {
            "baseModel": "<string>",
            "enableAddons": True
        } } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    createDeploymentRequest: {deployment: {baseModel: '<string>', enableAddons: true}}
  })
};

fetch('https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapeVersions:match', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapeVersions:match",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'createDeploymentRequest' => [
        'deployment' => [
                'baseModel' => '<string>',
                'enableAddons' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapeVersions:match"

	payload := strings.NewReader("{\n  \"createDeploymentRequest\": {\n    \"deployment\": {\n      \"baseModel\": \"<string>\",\n      \"enableAddons\": true\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapeVersions:match")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"createDeploymentRequest\": {\n    \"deployment\": {\n      \"baseModel\": \"<string>\",\n      \"enableAddons\": true\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapeVersions:match")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"createDeploymentRequest\": {\n    \"deployment\": {\n      \"baseModel\": \"<string>\",\n      \"enableAddons\": true\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "deploymentShapeVersions": [
    {
      "name": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "snapshot": {
        "baseModel": "<string>",
        "name": "<string>",
        "displayName": "<string>",
        "description": "<string>",
        "createTime": "2023-11-07T05:31:56Z",
        "updateTime": "2023-11-07T05:31:56Z",
        "modelType": "<string>",
        "parameterCount": "<string>",
        "acceleratorCount": 123,
        "acceleratorType": "ACCELERATOR_TYPE_UNSPECIFIED",
        "precision": "PRECISION_UNSPECIFIED",
        "disableDeploymentSizeValidation": true,
        "enableAddons": true,
        "draftTokenCount": 123,
        "draftModel": "<string>",
        "ngramSpeculationLength": 123,
        "disableSpeculativeDecoding": true,
        "enableSessionAffinity": true,
        "numLoraDeviceCached": 123,
        "maxContextLength": 123,
        "presetType": "PRESET_TYPE_UNSPECIFIED"
      },
      "validated": true,
      "public": true,
      "latestValidated": true,
      "capabilities": [
        "CAPABILITY_UNSPECIFIED"
      ]
    }
  ],
  "nextPageToken": "<string>",
  "totalSize": 123
}

POST

accounts

{account_id}

deploymentShapeVersions:match

Match Deployment Shape Versions

curl --request POST \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapeVersions:match \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "createDeploymentRequest": {
    "deployment": {
      "baseModel": "<string>",
      "enableAddons": true
    }
  }
}
'

import requests

url = "https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapeVersions:match"

payload = { "createDeploymentRequest": { "deployment": {
            "baseModel": "<string>",
            "enableAddons": True
        } } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    createDeploymentRequest: {deployment: {baseModel: '<string>', enableAddons: true}}
  })
};

fetch('https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapeVersions:match', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapeVersions:match",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'createDeploymentRequest' => [
        'deployment' => [
                'baseModel' => '<string>',
                'enableAddons' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapeVersions:match"

	payload := strings.NewReader("{\n  \"createDeploymentRequest\": {\n    \"deployment\": {\n      \"baseModel\": \"<string>\",\n      \"enableAddons\": true\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapeVersions:match")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"createDeploymentRequest\": {\n    \"deployment\": {\n      \"baseModel\": \"<string>\",\n      \"enableAddons\": true\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fireworks.ai/v1/accounts/{account_id}/deploymentShapeVersions:match")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"createDeploymentRequest\": {\n    \"deployment\": {\n      \"baseModel\": \"<string>\",\n      \"enableAddons\": true\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "deploymentShapeVersions": [
    {
      "name": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "snapshot": {
        "baseModel": "<string>",
        "name": "<string>",
        "displayName": "<string>",
        "description": "<string>",
        "createTime": "2023-11-07T05:31:56Z",
        "updateTime": "2023-11-07T05:31:56Z",
        "modelType": "<string>",
        "parameterCount": "<string>",
        "acceleratorCount": 123,
        "acceleratorType": "ACCELERATOR_TYPE_UNSPECIFIED",
        "precision": "PRECISION_UNSPECIFIED",
        "disableDeploymentSizeValidation": true,
        "enableAddons": true,
        "draftTokenCount": 123,
        "draftModel": "<string>",
        "ngramSpeculationLength": 123,
        "disableSpeculativeDecoding": true,
        "enableSessionAffinity": true,
        "numLoraDeviceCached": 123,
        "maxContextLength": 123,
        "presetType": "PRESET_TYPE_UNSPECIFIED"
      },
      "validated": true,
      "public": true,
      "latestValidated": true,
      "capabilities": [
        "CAPABILITY_UNSPECIFIED"
      ]
    }
  ],
  "nextPageToken": "<string>",
  "totalSize": 123
}

Use this endpoint to discover the deployment shape versions compatible with a model before creating a deployment. Pass a Create Deployment request in the body — at minimum createDeploymentRequest.deployment.baseModel — and the response returns the latest validated shape versions that can serve that model, ready to pass as deploymentShape. Match applies the full server-side compatibility logic for you: PEFT base-model resolution (for LoRA addons and live merge, shapes are matched against the PEFT base model), model-type and parameter-count tiers, embedding vs. non-embedding models, the MULTI_LORA capability gate when enableAddons is set, and hiding of FP4 shapes for full-parameter fine-tunes. List Deployment Shape Versions only lists versions of a shape you already know and cannot answer “which shapes work with this model?” — use Match for that.

The account in the URL must be your own account — the account that will own the deployment (you must be a member of it, so accounts/fireworks fails with a permission error). The model in the request body, however, can live in any account you can deploy from, including publisher accounts like accounts/fireworks; public shapes from the publisher’s account flow into the results.

Example: Match shapes for a model

curl -X POST "https://api.fireworks.ai/v1/accounts/YOUR_ACCOUNT_ID/deploymentShapeVersions:match" \
  -H "Authorization: Bearer $FIREWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "createDeploymentRequest": {
      "deployment": {
        "baseModel": "accounts/fireworks/models/gpt-oss-120b"
      }
    }
  }'

To match shapes for a deployment with LoRA addons enabled, include enableAddons in the request — only shapes with the MULTI_LORA capability are returned:

curl -X POST "https://api.fireworks.ai/v1/accounts/YOUR_ACCOUNT_ID/deploymentShapeVersions:match" \
  -H "Authorization: Bearer $FIREWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "createDeploymentRequest": {
      "deployment": {
        "baseModel": "accounts/fireworks/models/gpt-oss-120b",
        "enableAddons": true
      }
    }
  }'

Then pass one of the returned shape versions as deploymentShape in the Create Deployment request. See What is a deployment shape? for why you should always create deployments from a shape.

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

Body

application/json

The deployment create request to match deployment shape versions for.

createDeploymentRequest

object

required

The deployment create request to match deployment shape versions for. The full CreateDeploymentRequest schema is accepted here — including fields like deployment.enableAddons that affect shape compatibility — only the most common fields are listed below. See the Create Deployment reference page for the complete request schema.

Show child attributes

Response

200 - application/json

A successful response.

deploymentShapeVersions

A deployment shape version is a specific version of a deployment shape. Versions are immutable, only created on updates and deleted when the deployment shape is deleted. · object[]

Show child attributes

nextPageToken

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

totalSize

integer<int32>

The total number of deployment shape versions.

⌘I

API Reference

Inference

Deployments

Training

Training SDK

Evals

Admin

Match Deployment Shape Versions

Example: Match shapes for a model

Authorizations

Path Parameters

Body

Response

​Example: Match shapes for a model

Authorizations

Path Parameters

Body

Response

Example: Match shapes for a model