GoodMem
ReferenceAPIREST APIEmbedders

List embedders

Retrieves a list of embedder configurations accessible to the caller, with optional filtering.

LABEL FILTERS: Supply dynamic query parameters in the form label.<key>=<value> (for example, label.environment=production).

PERMISSION-BASED FILTERING: With LIST_EMBEDDER_OWN permission, you can only see your own embedders (ownerId filter is ignored if set to another user). With LIST_EMBEDDER_ANY permission, you can see all embedders or filter by any ownerId. This is a read-only operation with no side effects.

GET
/v1/embedders
x-api-key<token>

In: header

Query Parameters

ownerId?string

Filter embedders by owner ID. With LIST_EMBEDDER_ANY permission, omitting this shows all accessible embedders; providing it filters by that owner. With LIST_EMBEDDER_OWN permission, only your own embedders are shown regardless of this parameter.

providerType?string

Filter embedders by provider type. Allowed values match the ProviderType schema.

Value in"OPENAI" | "VLLM" | "TEI" | "LLAMA_CPP" | "VOYAGE" | "COHERE" | "JINA"

Response Body

curl -X GET "http://localhost:8080/v1/embedders?ownerId=550e8400-e29b-41d4-a716-446655440000&providerType=OPENAI"
{
  "embedders": [
    {
      "embedderId": "550e8400-e29b-41d4-a716-446655440000",
      "displayName": "OpenAI Ada-2",
      "description": "OpenAI's text embedding model with 1536 dimensions",
      "providerType": "OPENAI",
      "endpointUrl": "https://api.openai.com/v1",
      "apiPath": "/embeddings",
      "modelIdentifier": "text-embedding-3-small",
      "dimensionality": 1536,
      "distributionType": "DENSE",
      "maxSequenceLength": 8192,
      "credentials": {
        "apiKey": {
          "inlineSecret": "sk-1234567890abcdef",
          "secretRef": {
            "uri": "vault://path/to/secret"
          },
          "headerName": "Authorization",
          "prefix": "Bearer "
        },
        "gcpAdc": {
          "scopes": [
            "https://www.googleapis.com/auth/cloud-platform"
          ],
          "quotaProjectId": "my-quota-project"
        }
      },
      "version": "1.0.0",
      "monitoringEndpoint": "https://monitoring.example.com/embedders/status",
      "ownerId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": 1617293472000,
      "updatedAt": 1617293472000,
      "createdById": "550e8400-e29b-41d4-a716-446655440000",
      "updatedById": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}
Empty
Empty
Empty