> ## Documentation Index
> Fetch the complete documentation index at: https://docs.outerproduct.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Serving Endpoint



## OpenAPI

````yaml https://api.outerproduct.com/openapi.json get /v1/serving/endpoints/{endpoint_id}
openapi: 3.1.0
info:
  title: OuterProduct API
  description: >-
    Public-facing REST API for OuterProduct model distillation, prediction, and
    explanation.
  version: 0.1.8
servers: []
security: []
paths:
  /v1/serving/endpoints/{endpoint_id}:
    get:
      tags:
        - serving
      summary: Get Serving Endpoint
      operationId: get_serving_endpoint_v1_serving_endpoints__endpoint_id__get
      parameters:
        - name: endpoint_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Endpoint Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnlineServingEndpointResource'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerAuth: []
components:
  schemas:
    OnlineServingEndpointResource:
      properties:
        id:
          $ref: '#/components/schemas/ID'
          description: Server-assigned endpoint id.
        endpoint_url:
          type: string
          title: Endpoint Url
          description: >-
            Public base URL of the endpoint, e.g.
            https://ep-{id}.serving.<zone>.
        config:
          $ref: '#/components/schemas/OnlineServingEndpointRequest'
        launched_at:
          $ref: '#/components/schemas/outerproduct_http_types__common__Datetime'
        status:
          $ref: '#/components/schemas/OnlineServingStatus'
      type: object
      required:
        - id
        - endpoint_url
        - config
        - launched_at
        - status
      title: OnlineServingEndpointResource
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ID:
      anyOf:
        - type: string
          format: uuid
        - type: string
    OnlineServingEndpointRequest:
      properties:
        model_id:
          $ref: '#/components/schemas/ID'
          description: The trained model this endpoint serves (``models.id``).
        predict_options:
          $ref: '#/components/schemas/OnlinePredictionOptions'
        max_qps:
          type: integer
          minimum: 1
          title: Max Qps
          description: Advisory per-endpoint request-rate ceiling.
          default: 50
      type: object
      required:
        - model_id
      title: OnlineServingEndpointRequest
    outerproduct_http_types__common__Datetime:
      type: string
      format: date-time
    OnlineServingStatus:
      properties:
        status_code:
          type: string
          enum:
            - ready
            - dormant
            - in_progress
            - failed
          title: Status Code
        last_updated_at:
          $ref: '#/components/schemas/outerproduct_http_types__common__Datetime'
        stage:
          anyOf:
            - type: string
            - type: 'null'
          title: Stage
          description: >-
            Human-readable sub-step while ``in_progress`` (e.g.
            provisioning_routing).
        failure_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Failure Message
          description: Populated when ``status_code == 'failed'``.
      type: object
      required:
        - status_code
        - last_updated_at
      title: OnlineServingStatus
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    OnlinePredictionOptions:
      properties:
        binary_classification_threshold:
          anyOf:
            - type: number
            - type: 'null'
          title: Binary Classification Threshold
          description: >-
            Probability cutoff used to derive a predicted class for binary
            classification models. Null leaves predictions as raw scores.
          default: 0.5
        num_classes_to_return:
          anyOf:
            - type: integer
            - type: 'null'
          title: Num Classes To Return
          description: >-
            For multiclass models, cap the number of top class probabilities
            returned per row. Null returns all.
      type: object
      title: OnlinePredictionOptions
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key or OAuth2/OIDC access token
      description: >-
        An API key or OAuth2/OIDC access token sent as `Authorization: Bearer
        <token>`.

````