FWfw-ai-external
gateway.openapi_Gateway

CRUD APIs for deployment shape. Create Deployment Shape

Changed on
post/v1/accounts/{account_id}/deploymentShapes

Request

Path parameters

account_idstring required

The Account Id

Query parameters

deploymentShapeIdstring

The ID of the deployment shape. If not specified, a random ID will be generated.

Request body

namestring
displayNamestring

Human-readable display name of the deployment shape. e.g. "My Deployment Shape" Must be fewer than 64 characters long.

descriptionstring

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

createTimestring date-time

The creation time of the deployment shape.

updateTimestring date-time

The update time for the deployment shape.

baseModelstring required

Mutable, but only via UpdateDeploymentShape and only to a compatible model: one with the same model_type, parameter_count, and embedding status. The derived model_type / parameter_count fields (OUTPUT_ONLY, IMMUTABLE) are therefore preserved across a swap. Any incompatible change is rejected.

modelTypestring

The model type of the base model.

parameterCountstring int64

The parameter count of the base model .

acceleratorCountinteger

The number of accelerators used per replica. If not specified, the default is the estimated minimum required by the base model.

acceleratorType'ACCELERATOR_TYPE_UNSPECIFIED' | 'NVIDIA_A100_80GB' | 'NVIDIA_H100_80GB' | 'AMD_MI300X_192GB' | 'NVIDIA_A10G_24GB' | 'NVIDIA_A100_40GB' | 'NVIDIA_L4_24GB' | 'NVIDIA_H200_141GB' | 'NVIDIA_B200_180GB' | 'AMD_MI325X_256GB' | 'AMD_MI350X_288GB' | 'NVIDIA_B300_288GB' | 'NVIDIA_GB200' | 'NVIDIA_GB300'
precision'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'
disableDeploymentSizeValidationboolean

If true, the deployment size validation is disabled.

enableAddonsboolean

If true, LORA addons are enabled for deployments created from this shape. Deprecated: set enable_addons on the deployment instead.

draftTokenCountinteger

The number of candidate tokens to generate per step for speculative decoding. Default is the base model's draft_token_count.

draftModelstring

The draft model name for speculative decoding. e.g. accounts/fireworks/models/my-draft-model If empty, speculative decoding using a draft model is disabled. Default is the base model's default_draft_model. Deprecated: set default_draft_model on the base model instead.

ngramSpeculationLengthinteger

The length of previous input sequence to be considered for N-gram speculation.

disableSpeculativeDecodingboolean

DEPRECATED: This field is a no-op. Speculative decoding is configured on deployment.

enableSessionAffinityboolean

Whether to apply sticky routing based on user field.

numLoraDeviceCachedinteger
maxContextLengthinteger

The maximum context length supported by the model (context window). If set to 0 or not specified, the model's default maximum context length will be used.

presetType'PRESET_TYPE_UNSPECIFIED' | 'MINIMAL' | 'FAST' | 'THROUGHPUT' | 'FULL_PRECISION' | 'AGENTIC_CODING' | 'CHAT' | 'SUMMARIZATION' | 'MULTI_LORA'

Response

A successful response.

namestring
displayNamestring

Human-readable display name of the deployment shape. e.g. "My Deployment Shape" Must be fewer than 64 characters long.

descriptionstring

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

createTimestring date-time

The creation time of the deployment shape.

updateTimestring date-time

The update time for the deployment shape.

baseModelstring required

Mutable, but only via UpdateDeploymentShape and only to a compatible model: one with the same model_type, parameter_count, and embedding status. The derived model_type / parameter_count fields (OUTPUT_ONLY, IMMUTABLE) are therefore preserved across a swap. Any incompatible change is rejected.

modelTypestring

The model type of the base model.

parameterCountstring int64

The parameter count of the base model .

acceleratorCountinteger

The number of accelerators used per replica. If not specified, the default is the estimated minimum required by the base model.

acceleratorType'ACCELERATOR_TYPE_UNSPECIFIED' | 'NVIDIA_A100_80GB' | 'NVIDIA_H100_80GB' | 'AMD_MI300X_192GB' | 'NVIDIA_A10G_24GB' | 'NVIDIA_A100_40GB' | 'NVIDIA_L4_24GB' | 'NVIDIA_H200_141GB' | 'NVIDIA_B200_180GB' | 'AMD_MI325X_256GB' | 'AMD_MI350X_288GB' | 'NVIDIA_B300_288GB' | 'NVIDIA_GB200' | 'NVIDIA_GB300'
precision'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'
disableDeploymentSizeValidationboolean

If true, the deployment size validation is disabled.

enableAddonsboolean

If true, LORA addons are enabled for deployments created from this shape. Deprecated: set enable_addons on the deployment instead.

draftTokenCountinteger

The number of candidate tokens to generate per step for speculative decoding. Default is the base model's draft_token_count.

draftModelstring

The draft model name for speculative decoding. e.g. accounts/fireworks/models/my-draft-model If empty, speculative decoding using a draft model is disabled. Default is the base model's default_draft_model. Deprecated: set default_draft_model on the base model instead.

ngramSpeculationLengthinteger

The length of previous input sequence to be considered for N-gram speculation.

disableSpeculativeDecodingboolean

DEPRECATED: This field is a no-op. Speculative decoding is configured on deployment.

enableSessionAffinityboolean

Whether to apply sticky routing based on user field.

numLoraDeviceCachedinteger
maxContextLengthinteger

The maximum context length supported by the model (context window). If set to 0 or not specified, the model's default maximum context length will be used.

presetType'PRESET_TYPE_UNSPECIFIED' | 'MINIMAL' | 'FAST' | 'THROUGHPUT' | 'FULL_PRECISION' | 'AGENTIC_CODING' | 'CHAT' | 'SUMMARIZATION' | 'MULTI_LORA'

Changes

  • 3bf245180173Revision changes
    • warning

      added the new MULTI_LORA enum value to the response property for the response status

    • warning

      added the new NVIDIA_B300_288GB enum value to the response property for the response status

    • warning

      added the new NVIDIA_GB200 enum value to the response property for the response status

    • warning

      added the new NVIDIA_GB300 enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the new MULTI_LORA enum value to the request property

    • info

      added the new NVIDIA_B300_288GB enum value to the request property

    • info

      added the new NVIDIA_GB200 enum value to the request property

    • info

      added the new NVIDIA_GB300 enum value to the request property

    • info

      added the optional property to the response with the status

  • 3c3ed322dd52Revision changes
    • warning

      added the new AGENTIC_CODING enum value to the response property for the response status

    • warning

      added the new CHAT enum value to the response property for the response status

    • warning

      added the new SUMMARIZATION enum value to the response property for the response status

    • info

      added the new AGENTIC_CODING enum value to the request property

    • info

      added the new CHAT enum value to the request property

    • info

      added the new SUMMARIZATION enum value to the request property