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

# Get Embedding Configuration

> Read automatic embedding availability without credential metadata.



## OpenAPI

````yaml https://platform.tracecat.com/api/openapi.json get /workspaces/{workspace_id}/search/configuration
openapi: 3.1.0
info:
  title: Tracecat API
  summary: Tracecat API
  description: The open source AI automation platform for security teams and agents.
  termsOfService: >-
    https://docs.google.com/document/d/e/2PACX-1vQvDe3SoVAPoQc51MgfGCP71IqFYX_rMVEde8zC4qmBCec5f8PLKQRdxa6tsUABT8gWAR9J-EVs2CrQ/pub
  contact:
    name: Tracecat Founders
    email: founders@tracecat.com
  license:
    name: AGPL-3.0
    url: https://www.gnu.org/licenses/agpl-3.0.html
  version: '1'
servers:
  - url: /api
security: []
tags:
  - name: public
    description: Public facing endpoints
  - name: workflows
    description: Workflow management
  - name: actions
    description: Action management
  - name: triggers
    description: Workflow triggers
  - name: secrets
    description: Secret management
  - name: variables
    description: Workspace variable management
paths:
  /workspaces/{workspace_id}/search/configuration:
    get:
      tags:
        - search
      summary: Get Embedding Configuration
      description: Read automatic embedding availability without credential metadata.
      operationId: search-get_embedding_configuration
      parameters:
        - name: workspace_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Workspace Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddingConfigurationRead'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddingErrorResponse'
          description: Bad Request
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddingErrorResponse'
          description: Conflict
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddingErrorResponse'
          description: Too Many Requests
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddingErrorResponse'
          description: Bad Gateway
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddingErrorResponse'
          description: Gateway Timeout
      security:
        - APIKeyCookie: []
components:
  schemas:
    EmbeddingConfigurationRead:
      properties:
        available:
          type: boolean
          title: Available
        version:
          type: integer
          title: Version
        state:
          $ref: '#/components/schemas/SearchState'
        configuration:
          anyOf:
            - $ref: '#/components/schemas/EmbeddingModelRead'
            - type: 'null'
        reindex_required:
          type: boolean
          title: Reindex Required
          default: false
      type: object
      required:
        - available
        - version
        - state
      title: EmbeddingConfigurationRead
      description: Availability from existing provider settings and current indexing state.
    EmbeddingErrorResponse:
      properties:
        detail:
          $ref: '#/components/schemas/EmbeddingErrorRead'
      type: object
      required:
        - detail
      title: EmbeddingErrorResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SearchState:
      type: string
      enum:
        - disabled
        - active
        - paused
        - reindex_required
      title: SearchState
      description: Workspace availability states controlling search and indexing.
    EmbeddingModelRead:
      properties:
        provider:
          type: string
          enum:
            - openai
            - gemini
            - bedrock
            - ollama
            - vllm
          title: Provider
        model:
          type: string
          enum:
            - 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
          title: Model
        dimensions:
          type: integer
          title: Dimensions
        tokenizer:
          type: string
          title: Tokenizer
        input_token_limit:
          type: integer
          title: Input Token Limit
        input_character_limit:
          type: integer
          title: Input Character Limit
        batch_size_limit:
          type: integer
          title: Batch Size Limit
        batch_token_limit:
          type: integer
          title: Batch Token Limit
      type: object
      required:
        - provider
        - model
        - dimensions
        - tokenizer
        - input_token_limit
        - input_character_limit
        - batch_size_limit
        - batch_token_limit
      title: EmbeddingModelRead
      description: Public metadata needed for status and bounded chunk preparation.
    EmbeddingErrorRead:
      properties:
        code:
          $ref: '#/components/schemas/EmbeddingErrorCode'
        retryable:
          type: boolean
          title: Retryable
        retry_after:
          anyOf:
            - type: number
            - type: 'null'
          title: Retry After
      type: object
      required:
        - code
        - retryable
      title: EmbeddingErrorRead
    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
    EmbeddingErrorCode:
      type: string
      enum:
        - CREDENTIAL_INVALID
        - CONFIGURATION_INVALID
        - CONFIGURATION_CHANGED
        - INPUT_INVALID
        - RATE_LIMITED
        - TIMEOUT
        - UNAVAILABLE
        - RESPONSE_INVALID
        - NOT_CONFIGURED
      title: EmbeddingErrorCode
      description: >-
        Stable public failures; provider messages must never cross this
        boundary.
  securitySchemes:
    APIKeyCookie:
      type: apiKey
      in: cookie
      name: fastapiusersauth

````