RolloutService

Preview rollout defaults

Changed on

Returns the values a create request would pick for any field left unset, plus the capacity context needed to display them, without creating a rollout. Responses are display state only and re-validated authoritatively at create and start; do not copy response values back into a create request.

post/v2/projects/{projectId}/endpoints/{endpointId}/rollouts/preview-defaults

Request

  • Base URL
    https://api.together.ai
  • URL
    https://api.together.ai/v2/projects/{projectId}/endpoints/{endpointId}/rollouts/preview-defaults
  • Auth
    HTTP bearer

Path parameters

projectIdstring required

Project identifier.

endpointIdstring required

Endpoint identifier.

Request body

OR
OR

Response

OK

frozenPairboolean

True when both deployments stand in the endpoint traffic split, so the rollout resumes from the current split rather than from zero. See warnings for standing split shapes that StartRollout will still reject.

estimatedSeedPercentinteger

Percentage of the pair's traffic currently reaching the target, the floor the suggested steps start above. Unset when not a frozen pair or unknown; 0 is a real measurement.

sourceReplicasinteger required

Source deployment replica count the defaults were computed from. Zero is a real value.

targetReplicasinteger required

Target deployment replica count the defaults were computed from. Zero is a real value.

targetMinReplicasinteger required

Target deployment autoscaling minimum replica count. Zero is a real value.

targetMaxReplicasinteger required

Target deployment autoscaling maximum replica count. Zero is a real value.

landingMinReplicasinteger

Expected autoscaling minimum replicas for the completed target; unset while the final target replicas cannot be resolved.

landingMaxReplicasinteger

Expected autoscaling maximum replicas for the completed target; unset while the final target replicas cannot be resolved.

Example response

{
  "spec": {
    "sourceDeploymentId": "dep_source123",
    "targetDeploymentId": "dep_target456",
    "canary": {
      "steps": [
        {
          "traffic": 25
        },
        {
          "traffic": 50
        },
        {
          "traffic": 100
        }
      ],
      "stepInterval": "300s"
    },
    "metrics": [
      {
        "name": "router_latency",
        "stat": "METRIC_STAT_TYPE_PERCENTILE",
        "percentile": 95,
        "thresholdCheck": {
          "value": 30000,
          "operator": "THRESHOLD_OPERATOR_LT"
        },
        "window": "300s"
      }
    ]
  },
  "sourceReplicas": 4,
  "targetReplicas": 1,
  "targetMinReplicas": 1,
  "targetMaxReplicas": 8,
  "warnings": [],
  "frozenPair": false
}

Changes