# Get a single serving endpoint

Launch stage: GA

`GET /api/2.0/serving-endpoints/{name}`

Retrieves the details for a single serving endpoint.

API scopes: model-serving

## Path parameters

- `name` (string, required)
  The name of the serving endpoint. This field is required.
  Example: `feed-ads`
  Constraints: `[ 1 .. 63 ] characters`

## Returns

Returns the InferenceEndpointDetailed object.

## Response

### External model endpoint

```json
{
  "ai_gateway": {
    "guardrails": {
      "input": {
        "invalid_keywords": [
          "keyword1",
          "keyword2"
        ],
        "pii": {
          "behavior": "BLOCK"
        },
        "safety": true,
        "valid_topics": [
          "topic1",
          "topic2"
        ]
      },
      "output": {
        "invalid_keywords": [
          "keyword1",
          "keyword2"
        ],
        "pii": {
          "behavior": "BLOCK"
        },
        "safety": true,
        "valid_topics": [
          "topic1",
          "topic2"
        ]
      }
    },
    "inference_table_config": {
      "catalog_name": "my-catalog",
      "enabled": true,
      "schema_name": "my-schema",
      "table_name_prefix": "my-prefix"
    },
    "rate_limits": [
      {
        "calls": 100,
        "key": "user",
        "renewal_period": "minute"
      }
    ],
    "usage_tracking_config": {
      "enabled": true
    }
  },
  "config": {
    "config_version": 1,
    "served_entities": [
      {
        "creation_timestamp": 1699617587000,
        "creator": "user@email.com",
        "external_model": {
          "name": "text-embedding-ada-002",
          "openai_config": {
            "openai_api_key": "{{secrets/my_scope/my_openai_api_key}}"
          },
          "provider": "openai",
          "task": "llm/v1/embeddings"
        },
        "name": "openai_embeddings",
        "state": {
          "deployment": "DEPLOYMENT_READY",
          "deployment_state_message": ""
        }
      }
    ],
    "traffic_config": {
      "routes": [
        {
          "served_model_name": "openai_embeddings",
          "traffic_percentage": 100
        }
      ]
    }
  },
  "creation_timestamp": 1699617587000,
  "creator": "user@email.com",
  "id": "69962db6b9db47c4a8a222d2ac79d7f8",
  "last_updated_timestamp": 1699617587000,
  "name": "openai_endpoint",
  "permission_level": "CAN_MANAGE",
  "route_optimized": false,
  "state": {
    "ready": "READY"
  },
  "tags": {
    "key": "team",
    "value": "gen-ai"
  }
}
```

### Feature Serving endpoint

```json
{
  "config": {
    "config_version": 1,
    "served_entities": [
      {
        "creation_timestamp": 1700089760000,
        "creator": "user@email.com",
        "entity_name": "feature_store.me.travel_spec",
        "name": "feature-spec-travel",
        "scale_to_zero_enabled": true,
        "state": {
          "deployment": "DEPLOYMENT_READY",
          "deployment_state_message": ""
        },
        "workload_size": "Small",
        "workload_type": "CPU"
      }
    ],
    "traffic_config": {
      "routes": [
        {
          "served_model_name": "feature-spec-travel",
          "traffic_percentage": 100
        }
      ]
    }
  },
  "creation_timestamp": 1700089637000,
  "creator": "user@email.com",
  "id": "e3bd3e471d6045d6b75f384279e4b6ab",
  "last_updated_timestamp": 1700089760000,
  "name": "feature-spec-endpoint",
  "permission_level": "CAN_MANAGE",
  "route_optimized": false,
  "state": {
    "config_update": "NOT_UPDATING",
    "ready": "READY"
  },
  "tags": [
    {
      "key": "team",
      "value": "data science"
    }
  ]
}
```

### Foundation Model Endpoint

```json
{
  "config": {
    "config_version": 1,
    "served_entities": [
      {
        "foundation_model": {
          "description": "Llama 3.1 is a state-of-the-art 70B parameter dense language model trained and released by Meta. The model supports a context length of 128K tokens. The model is optimized for multilingual dialogue use cases and aligned with human preferences for helpfulness and safety. It is not intended for use in languages other than English. Meta Llama 3.1 is licensed under the Meta Llama 3.1 Community License, Copyright © Meta Platforms, Inc. All Rights Reserved. Customers are responsible for ensuring compliance with applicable model licenses.",
          "display_name": "Meta Llama 3.1 70B Instruct",
          "docs": "https://docs.databricks.com/machine-learning/foundation-models/supported-models.html#meta-llama-31-70b-instruct",
          "name": "meta-llama-3-1-70b-instruct",
          "task": "llm/v1/chat"
        },
        "name": "databricks-meta-llama-3-1-70b-instruct",
        "state": {
          "deployment": "DEPLOYMENT_READY",
          "deployment_state_message": ""
        }
      }
    ]
  },
  "name": "databricks-meta-llama-3-1-70b-instruct",
  "route_optimized": false,
  "state": {
    "ready": "READY"
  }
}
```

### Models in Unity Catalog endpoint

```json
{
  "config": {
    "config_version": 1,
    "served_entities": [
      {
        "creation_timestamp": 1700089760000,
        "creator": "user@email.com",
        "entity_name": "myCatalog.mySchema.my-ads-model",
        "entity_version": "10",
        "name": "my-ads-model-10",
        "scale_to_zero_enabled": true,
        "state": {
          "deployment": "DEPLOYMENT_READY",
          "deployment_state_message": ""
        },
        "workload_size": "Small",
        "workload_type": "CPU"
      }
    ],
    "traffic_config": {
      "routes": [
        {
          "served_model_name": "my-ads-model-10",
          "traffic_percentage": 100
        }
      ]
    }
  },
  "creation_timestamp": 1700089637000,
  "creator": "user@email.com",
  "id": "e3bd3e471d6045d6b75f384279e4b6ab",
  "last_updated_timestamp": 1700089760000,
  "name": "uc-model-endpoint",
  "permission_level": "CAN_MANAGE",
  "route_optimized": false,
  "state": {
    "config_update": "NOT_UPDATING",
    "ready": "READY"
  },
  "tags": [
    {
      "key": "team",
      "value": "data science"
    }
  ]
}
```

### Workspace model endpoint

```json
{
  "config": {
    "config_version": 1,
    "served_entities": [
      {
        "creation_timestamp": 1700089760000,
        "creator": "user@email.com",
        "entity_name": "my-ads-model",
        "entity_version": "3",
        "name": "my-ads-model-3",
        "scale_to_zero_enabled": true,
        "state": {
          "deployment": "DEPLOYMENT_READY",
          "deployment_state_message": ""
        },
        "workload_size": "Small",
        "workload_type": "CPU"
      },
      {
        "creation_timestamp": 1700089760000,
        "creator": "user@email.com",
        "entity_name": "my-ads-model",
        "entity_version": "4",
        "name": "my-ads-model-4",
        "scale_to_zero_enabled": true,
        "state": {
          "deployment": "DEPLOYMENT_READY",
          "deployment_state_message": ""
        },
        "workload_size": "Small",
        "workload_type": "CPU"
      }
    ],
    "traffic_config": {
      "routes": [
        {
          "served_model_name": "my-ads-model-3",
          "traffic_percentage": 80
        },
        {
          "served_model_name": "my-ads-model-4",
          "traffic_percentage": 20
        }
      ]
    }
  },
  "creation_timestamp": 1700089637000,
  "creator": "user@email.com",
  "id": "e3bd3e471d6045d6b75f384279e4b6ab",
  "last_updated_timestamp": 1700089760000,
  "name": "workspace-model-endpoint",
  "permission_level": "CAN_MANAGE",
  "route_optimized": false,
  "state": {
    "config_update": "NOT_UPDATING",
    "ready": "READY"
  },
  "tags": [
    {
      "key": "team",
      "value": "data science"
    }
  ]
}
```

