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

# List all candidate embedding models under the given credential type

> Return all candidate embedding models under the credential type.

Unlike ``/knowledge_bases/embedding_models``, which narrows the
list to what the knowledge base's dimension policy accepts, this
endpoint reports the provider's full catalogue — it answers "what
can this credential do", not "what can I build a KB with".

Args:
    body (ListEmbeddingModelsRequest): The request body.

Returns:
    `ListEmbeddingModelsResponse`: The response body.



## OpenAPI

````yaml /versions/2.0.6dev/en/deploy/openapi.json get /embedding-model/
openapi: 3.1.0
info:
  title: AgentScope
  version: 2.0.6dev
servers: []
security: []
paths:
  /embedding-model/:
    get:
      tags:
        - embedding-model
      summary: List all candidate embedding models under the given credential type
      description: |-
        Return all candidate embedding models under the credential type.

        Unlike ``/knowledge_bases/embedding_models``, which narrows the
        list to what the knowledge base's dimension policy accepts, this
        endpoint reports the provider's full catalogue — it answers "what
        can this credential do", not "what can I build a KB with".

        Args:
            body (ListEmbeddingModelsRequest): The request body.

        Returns:
            `ListEmbeddingModelsResponse`: The response body.
      operationId: list_embedding_models_embedding_model__get
      parameters:
        - name: provider
          in: query
          required: true
          schema:
            type: string
            title: Provider
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEmbeddingModelsResponse'
        '404':
          description: Not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ListEmbeddingModelsResponse:
      properties:
        models:
          items:
            $ref: '#/components/schemas/EmbeddingModelCard'
          type: array
          title: Models
          description: The candidate embedding models.
        total:
          type: integer
          title: Total
          description: The total number of candidates.
      type: object
      required:
        - models
        - total
      title: ListEmbeddingModelsResponse
      description: List the candidate embedding models response.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    EmbeddingModelCard:
      properties:
        type:
          type: string
          const: embedding_model
          title: Type
          default: embedding_model
        name:
          type: string
          title: Name
          description: The model name used in API calls.
        label:
          type: string
          title: Label
          description: Human-readable label for the frontend.
        status:
          type: string
          enum:
            - active
            - deprecated
            - sunset
          title: Status
          description: The model lifecycle status.
          default: active
        input_types:
          items:
            type: string
          type: array
          title: Input Types
          description: Supported input media types.
          default:
            - text/plain
        output_types:
          items:
            type: string
          type: array
          title: Output Types
          description: Supported output media types.
          default:
            - application/x-embedding
        dimensions:
          type: integer
          exclusiveMinimum: 0
          title: Dimensions
          description: Default output vector dimensions for this model.
        supported_dimensions:
          anyOf:
            - items:
                type: integer
              type: array
            - type: 'null'
          title: Supported Dimensions
          description: >-
            If set, the only dimensions this model can produce. ``None`` means
            dimensions are fixed at :attr:`dimensions` and cannot be overridden.
        context_size:
          anyOf:
            - type: integer
              exclusiveMinimum: 0
            - type: 'null'
          title: Context Size
          description: Maximum input length (in tokens) per request.
        parameter_schema:
          additionalProperties: true
          type: object
          title: Parameter Schema
          description: >-
            JSON Schema for user-configurable parameters (built from the
            Parameters class + YAML overrides).
        parameter_overrides:
          additionalProperties:
            additionalProperties: true
            type: object
          type: object
          title: Parameter Overrides
          description: Raw parameter overrides from the YAML file.
      type: object
      required:
        - name
        - label
        - dimensions
      title: EmbeddingModelCard
      description: |-
        A card describing an embedding model's capabilities.

        Mirrors :class:`~agentscope.model.ModelCard` but tailored for
        embedding models.  Uses ``input_types`` / ``output_types`` to
        describe model capabilities, and ``parameter_schema`` (built from
        the embedding class's ``Parameters`` + YAML ``parameter_overrides``)
        to tell the frontend which knobs the user can adjust.

        The output type ``application/x-embedding`` indicates that the
        model produces dense vector embeddings.
    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

````