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

# Create text embeddings

> OpenAI-compatible embeddings endpoint. Accepts a single string or an
array of strings as `input` and routes through the gateway's provider
layer. Returns the standard OpenAI `EmbeddingResponse`. When the input
is a single string, the response also exposes a flat `embedding` field
(Prisme.ai convenience extension) in addition to `data[0].embedding`.

`analytics_context` is a Prisme.ai extension used to enrich analytics
events.

Governance overlays may reject the call (forwarded as 403 / 429 with
the upstream `result.status`, e.g. `MODEL_NOT_ALLOWED`,
`INVALID_DIMENSIONS`).




## OpenAPI

````yaml /api-reference/llm-gateway/swagger.yml post /v1/embeddings
openapi: 3.0.3
info:
  version: 1.0.0
  title: LLM Gateway API
  description: |
    Public REST API for the Prisme.ai LLM Gateway - OpenAI-compatible
    chat completions and embeddings, plus a managed model catalogue
    with governance overrides per organization.

    The gateway abstracts multi-provider LLM access (OpenAI, Azure OpenAI,
    Anthropic, Google Vertex, AWS Bedrock, OpenAI-compatible providers) behind
    an OpenAI-compatible request/response shape. It enforces per-tenant
    governance (allowed models, default models, quotas) and emits analytics
    events (`analytics.llm.completion`) usable for cost and carbon reporting.

    This spec documents only the public REST surface (endpoints exposed via
    Prisme.ai workspace webhooks). Internal helpers (private automations
    prefixed with `_`) and load-test mocks are not part of the public contract.
  contact:
    name: Prisme.ai
    url: https://prisme.ai
servers:
  - url: https://{host}/v2/workspaces/slug:llm-gateway/webhooks
    description: Prisme.ai workspace webhooks
    variables:
      host:
        default: api.studio.prisme.ai
        description: API host (override for self-hosted or sandbox)
security:
  - BearerAuth: []
  - OrgApiKeyAuth: []
tags:
  - name: Completions
    description: OpenAI-compatible chat completions (with optional SSE streaming).
  - name: Embeddings
    description: OpenAI-compatible text embeddings.
  - name: Models
    description: Model catalogue (CRUD + bulk replace + governance-aware listing).
  - name: Defaults
    description: >-
      Resolved default models for completions / embeddings / image generation /
      file parsing.
  - name: Test
    description: Smoke-test reachability of a model through the gateway.
paths:
  /v1/embeddings:
    post:
      tags:
        - Embeddings
      summary: Create text embeddings
      description: |
        OpenAI-compatible embeddings endpoint. Accepts a single string or an
        array of strings as `input` and routes through the gateway's provider
        layer. Returns the standard OpenAI `EmbeddingResponse`. When the input
        is a single string, the response also exposes a flat `embedding` field
        (Prisme.ai convenience extension) in addition to `data[0].embedding`.

        `analytics_context` is a Prisme.ai extension used to enrich analytics
        events.

        Governance overlays may reject the call (forwarded as 403 / 429 with
        the upstream `result.status`, e.g. `MODEL_NOT_ALLOWED`,
        `INVALID_DIMENSIONS`).
      operationId: createEmbedding
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddingRequest'
      responses:
        '200':
          description: Successful embedding response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddingResponse'
        '400':
          description: |
            Invalid request. Includes governance/provider rejections forwarded
            from the inner worker (e.g. `INVALID_DIMENSIONS`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Model not allowed for this caller (governance overlay).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Governance quota exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    EmbeddingRequest:
      type: object
      required:
        - model
        - input
      properties:
        model:
          type: string
          maxLength: 256
          description: Embedding model id from the catalogue.
        input:
          description: Either a single string or an array of strings to embed.
          oneOf:
            - type: string
            - type: array
              items:
                type: string
        dimensions:
          description: |
            Requested output dimensionality. Must be one of the model's
            `supported_dimensions` when set; otherwise rejected with
            `INVALID_DIMENSIONS`.
        analytics_context:
          type: object
          description: '**Prisme.ai extension.** Caller-supplied analytics context.'
          additionalProperties: true
    EmbeddingResponse:
      type: object
      description: |
        OpenAI-compatible embeddings response. When `input` was a single
        string, the response also exposes a flat root-level `embedding` field
        (Prisme.ai convenience extension) in addition to `data[0].embedding`.
      required:
        - object
        - model
        - data
      properties:
        object:
          type: string
          enum:
            - list
        model:
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/Embedding'
        usage:
          type: object
          properties:
            prompt_tokens:
              type: integer
            total_tokens:
              type: integer
        embedding:
          type: array
          description: |
            **Prisme.ai extension.** Convenience copy of `data[0].embedding`
            present only when the request `input` was a single string.
          items:
            type: number
            format: float
    Error:
      type: object
      required:
        - error
      description: |
        Standard error envelope. `error` carries either a stable PascalCase
        identifier or a free-text label (legacy endpoints) - `code` is the
        canonical machine-readable identifier going forward.
      properties:
        error:
          type: string
          description: Stable PascalCase identifier or short error label.
        message:
          type: string
          description: Human-readable error message.
        code:
          type: string
          description: |
            Machine-readable error code. Observed values include
            `RATE_LIMITED`, `MODEL_NOT_ALLOWED`, `MODEL_NOT_FOUND`,
            `MODEL_EXISTS`, `MISSING_MODEL_ID`, `MISSING_TYPE`, `INVALID_BODY`,
            `INVALID_ITEMS`, `INVALID_DIMENSIONS`, `PAYLOAD_TOO_LARGE`,
            `METHOD_NOT_ALLOWED`, `PROVIDER_ERROR`, `PROVIDER_NO_RESPONSE`.
        details:
          description: Optional structured context (e.g. list of invalid items).
          additionalProperties: true
        status:
          type: integer
          description: HTTP status mirror, when present.
        retryAfter:
          type: integer
          description: Seconds to wait before retrying (rate-limit responses).
        provider:
          type: string
          description: Upstream provider name (provider-error responses).
        model:
          type: string
          description: Model id involved in the error (provider-error responses).
        provider_error_type:
          type: string
          description: Upstream provider's own error class name.
    Embedding:
      type: object
      required:
        - object
        - index
        - embedding
      properties:
        object:
          type: string
          enum:
            - embedding
        index:
          type: integer
        embedding:
          type: array
          items:
            type: number
            format: float
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |
        User-bound credential carrying an identity: either a session JWT
        or a user access token (`at:*`) generated from the user settings UI.
        Send as `Authorization: Bearer <token>`.
        Org API keys (`iak_*`) are **not** accepted here - they carry
        no user identity. Use the `x-prismeai-api-key` header instead
        (see `OrgApiKeyAuth`).
    OrgApiKeyAuth:
      type: apiKey
      in: header
      name: x-prismeai-api-key
      description: |
        Organization API key (`iak_{orgSlug}_{uuid}`). Unlike
        `Authorization: Bearer`, this credential is **not** tied to a user
        identity - it is bound to the org and its effective access is
        defined by the scopes / permission rules attached to it (it can
        be restricted to a single project, or kept broader).
        Send as `x-prismeai-api-key: iak_...`.

````