---
title: "Get Embedding Configuration"
method: GET
path: "/workspaces/{workspace_id}/search/configuration"
tags: ["search"]
---

# Get Embedding Configuration

`GET /workspaces/{workspace_id}/search/configuration`

## Request

- Base URL: `https://platform.tracecat.com/api`
- URL: `https://platform.tracecat.com/api/workspaces/{workspace_id}/search/configuration`
- Auth: API key in cookie `fastapiusersauth`

Read automatic embedding availability without credential metadata.

## Path parameters

- `workspace_id` string, uuid, required

## Response `200`

Successful Response

- EmbeddingConfigurationRead: Availability from existing provider settings and current indexing state.
  - `available` boolean, required
  - `version` integer, required
  - `state` 'disabled' | 'active' | 'paused' | 'reindex_required', required: Workspace availability states controlling search and indexing.
  - `configuration` EmbeddingModelRead: Public metadata needed for status and bounded chunk preparation.
    - `provider` 'openai' | 'gemini' | 'bedrock' | 'ollama' | 'vllm', required
    - `model` 'text-embedding-3-small' | 'text-embedding-3-large' | 'gemini-embedding-001' | 'amazon.titan-embed-text-v2:0' | 'all-minilm' | 'all-minilm:latest' | 'all-minilm:22m' | 'sentence-transformers/all-MiniLM-L6-v2', required
    - `dimensions` integer, required
    - `tokenizer` string, required
    - `input_token_limit` integer, required
    - `input_character_limit` integer, required
    - `batch_size_limit` integer, required
    - `batch_token_limit` integer, required
  - `reindex_required` boolean

## Other responses

- `400`: Bad Request
- `409`: Conflict
- `422`: Validation Error
- `429`: Too Many Requests
- `502`: Bad Gateway
- `504`: Gateway Timeout

---

[API](https://skmtc.dev/tracecat/apis/tracecat-api.md) - [All operations](https://skmtc.dev/tracecat/apis/tracecat-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tracecat/apis/tracecat-api/revisions/2efdda25045f?raw)