GoodMem
ReferenceAPIREST APIEmbedders

Get an embedder by ID

Retrieves the details of a specific embedder configuration by its unique identifier. Requires READ_EMBEDDER_OWN permission for embedders you own (or READ_EMBEDDER_ANY for admin users to view any user's embedders). This is a read-only operation with no side effects.

GET
/v1/embedders/{id}
x-api-key<token>

In: header

Path Parameters

idstring

The unique identifier of the embedder to retrieve

Response Body

curl -X GET "http://localhost:8080/v1/embedders/550e8400-e29b-41d4-a716-446655440000"
{
  "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",
  "supportedModalities": [
    "TEXT"
  ],
  "labels": "{\"environment\": \"production\", \"team\": \"nlp\"}",
  "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
Empty