> ## Documentation Index > Fetch the complete documentation index at: https://docs.fiddler.ai/llms.txt > Use this file to discover all available pages before exploring further. # Update a surrogate model > Update a surrogate model ## OpenAPI ````yaml PUT /v3/models/{model_id}/deploy-surrogate openapi: 3.0.3 info: title: Fiddler API - 2.0 description: APIs to interact with Fiddler termsOfService: https://fiddler.ai/about/terms contact: email: support@fiddler.ai license: name: Proprietary url: '2.0' version: '2.0' servers: [] security: - BearerAuth: [] tags: - name: access-key description: CRUD operations for API keys - name: span-v3 - name: aggregation-invalidation-request-v3 description: Endpoints related to retrieving aggregation invalidation requests - name: alert-rules-v3 description: CRUD for Alert Rules, Summary, and Stats APIs - name: application-v3 - name: auth description: Authentication strategies and login flows - name: baseline-v3 description: CRUD for baseline - name: catalog-v3 description: >- Entity catalog provides paginated, searchable discovery of entity names (attribute keys, agent names, span types, span names, score names, evaluator config names) and their distinct values. Powered by ClickHouse materialized views — no worker or PostgreSQL dependency. - name: chart-annotation-v3 description: Endpoints related to retrieving chart annotations - name: chart-v3 description: CRUD for chart - name: queries-v3 description: v3 queries API - name: configuration-v3 description: CRUD for configurations - name: cost-evaluators-v3 description: > Paginated roll-up of per-evaluator LLM cost and token usage, aggregated hourly. Available only on deployments with evaluator cost reporting enabled. - name: custom-metrics-v3 - name: dimensionality-reduction-v3 - name: environment-v3 description: Endpoints related to environment management - name: evals - name: datasets - name: evaluation-v3 - name: evaluator-v3 - name: rule-evaluators-v3 - name: experiment-v3 - name: explainability-v3 - name: llm_rca-v3 - name: file-upload description: Endpoints related to file uploading. - name: fql-expressions-v3 description: > Endpoints for listing FQL (Fiddler Query Language) functions available for GenAI custom metrics. Used by the frontend for autocomplete and signature hints in the FQL editor. - name: genai-alert-rules-v3 description: CRUD API for GenAI Alert Rules - name: genai-custom-metrics-v3 description: API for GenAI Custom Metrics - name: genai-metrics-v3 description: >- Endpoints for pre-aggregated GenAI metrics. All metric data is pre-aggregated hourly by a Celery-based metric collector; no real-time aggregation is performed at request time. - name: guardrails-api description: Endpoints related to retrieving Guardrails specific data - name: ingestion-v3 - name: intercom-api description: Endpoints related to intercom APIs - name: jobs-v3 - name: llm-gateway-v3 - name: auth-login - name: auth-logout - name: mcp-client-setup-v3 description: Endpoints for retrieving MCP client setup instructions. - name: metrics-v3 description: Metrics endpoints - name: model-v3 - name: dashboard-v3 - name: model-deployment-v3 - name: monitoring-summary-v3 - name: histograms-v3 - name: organization-roles-v3 description: Update user org role - name: organization-settings-v3 description: Update organization settings such as timezone, email configuration, etc. - name: pagerduty-api description: CRUD for Pagerduty services. - name: project-v3 - name: project-roles-v3 description: Project role assignment management - name: scores-v3 description: Unified CRUD for scores and annotations - name: searchable-text-key-v3 description: >- Manage the global searchable text keys table that controls which OTel attribute keys are routed to the full-text-searchable `ValueContent` column in the unified attributes table. Changes propagate to the backing ClickHouse dictionary within 1-2 minutes and affect all tenants. - name: segments-v3 - name: semantic-mapping-v3 description: >- Manage the global semantic name mappings table that maps raw OTel attribute keys to canonical semantic concepts. Changes propagate to the backing ClickHouse dictionary within 1-2 minutes and affect all tenants. - name: server-info-v3 description: Endpoints related to retrieving server information - name: service-account description: > Service accounts and their API keys. A human Org Admin manages the service accounts of their own organization: create, read, update, and enable/disable (there is no delete — an account is disabled instead), and issue, rename, re-date, enable/disable, and revoke each account's API keys. An API key is an `fks_` secret that inherits the account's grants and cannot manage service accounts; an active, unexpired key must be disabled before it can be revoked, and it authenticates only while both it and its account are active. Scopes here are capability scopes (what the account may do), not OAuth scopes. - name: sessions-v3 description: v3 session APIs - name: team-roles-v3 - name: team-v3 - name: traces-v3 description: v3 trace api for monitoring - name: fetch-sessions-v3 description: v3 fetch sessions api for monitoring - name: user-access-key description: > CRUD operations for user API keys. All endpoints are user-scoped — each user can only operate on their own API keys. No one including Org admins have access to other users' API keys. - name: users-v3 - name: version-compatibility-v3 - name: webhooks externalDocs: url: https://docs.fiddler.ai description: Find out more about Fiddler paths: /v3/models/{model_id}/deploy-surrogate: put: tags: - model-v3 summary: Update a surrogate model description: Update a surrogate model operationId: deploySurrogateUpdateV3 parameters: - $ref: '#/components/parameters/model_id' requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/DeploySurrogateRequest' responses: '202': description: Surrogate model updating task with job id content: application/json: schema: allOf: - $ref: '#/components/schemas/ApiResponse' - type: object properties: data: type: object properties: job: $ref: '#/components/schemas/JobCompact' '400': $ref: '#/components/responses/400' '404': $ref: '#/components/responses/404' '500': $ref: '#/components/responses/500' components: parameters: model_id: name: model_id in: path description: model id path parameter required: true schema: type: string format: uuid schemas: DeploySurrogateRequest: type: object description: Request payload for to deploy a surrogate model required: - env_id - deployment_params properties: env_id: type: string format: uuid description: Unique identifier of the environment associated to the model deployment_params: $ref: '#/components/schemas/_SurrogateDeploymentParams' ApiResponse: type: object description: | Response object for standard API responses. properties: api_version: type: string default: '3.0' enum: - '2.0' - '3.0' description: | API version. kind: type: string default: NORMAL enum: - NORMAL description: | Type of response, indicating a normal response. JobCompact: type: object title: JobCompact description: > Compact version of a job which can be included in the response of relevant APIs. required: - id - name properties: id: type: string format: uuid description: | Unique identifier of the job. name: type: string description: | Name of the job. _SurrogateDeploymentParams: description: Additoinal paramteres specified to deploy surrogate model allOf: - type: object properties: artifact_type: description: Type of the artifact type: string enum: - SURROGATE - $ref: '#/components/schemas/_DeploymentParams' ErrorResponse: type: object description: | Response object for errors returned by the API. properties: api_version: type: string default: '3.0' enum: - '2.0' - '3.0' description: | API version of the response. kind: type: string default: ERROR enum: - ERROR description: | Type of response, usually indicating an error. error: type: object properties: code: type: integer format: int32 description: > Represents the code for this error, typically an HTTP response code. default: 400 enum: - 400 - 401 - 403 - 404 - 409 - 410 - 422 - 429 - 500 - 501 - 503 message: type: string description: > A human-readable message providing more details about the error. If there are multiple errors, it will be the message for the first error. example: Resource Not Found errors: type: array description: > Container for additional information regarding the error, especially for multiple errors. items: type: object properties: reason: type: string description: > Unique identifier for this error, different from the error code. example: ResourceNotFoundException message: type: string description: > A human-readable message providing more details about the error. If there is only one error, this field will match error.message. example: Resource Not Found help: type: string description: > Link to support or documentation providing more information on the error. _DeploymentParams: type: object properties: deployment_type: type: string enum: - BASE_CONTAINER description: Model deployment type image_uri: type: string description: Model deployment docker image uri replicas: type: integer description: Number of model deployment pods to be active example: 2 minimum: 1 maximum: 10 default: 1 cpu: type: integer description: Amount of millicpus to allocate per replica example: 500 minimum: 1 maximum: 4000 default: 1 memory: type: integer description: Amount of MiBs to allocate per replica example: 512 minimum: 150 maximum: 16384 default: 150 responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: BearerAuth: type: http scheme: bearer ````