---
title: "POST /embedding"
method: POST
path: "/embedding"
---

# POST /embedding

`POST /embedding`

## Request

- Base URL: `https://api.jigsawstack.com/v1`
- URL: `https://api.jigsawstack.com/v1/embedding`
- Auth: API key in header `x-api-key`

## Request body

- object
  - `text` string, nullable
  - `url` string, nullable
  - `file_store_key` string, nullable
  - `file_content` unknown
  - `type` 'text' | 'text-other' | 'image' | 'audio' | 'pdf', required
  - `dimensions` number
  - `token_overflow_mode` 'truncate' | 'error'
  - `instruction` string
  - `query` boolean
  - `speaker_fingerprint` union
    - string
    - boolean

## Response `200`

Successful response

- object
  - `success` boolean: Whether the request was successful
  - `data` object: Response data
  - `error` object: Error details if request failed
    - `message` string: Error message
    - `code` string: Error code

## Other responses

- `400`: Bad Request - The request was malformed or contained invalid parameters
- `401`: Unauthorized - Authentication credentials are missing or invalid
- `403`: Forbidden - The request is not allowed
- `404`: Not Found - The requested resource was not found
- `500`: Internal Server Error - Something went wrong on our end

---

[API](https://skmtc.dev/jigsawstack/apis/jigsawstack-api.md) · [All operations](https://skmtc.dev/jigsawstack/apis/jigsawstack-api/llms.txt) · [OpenAPI document](https://skmtc.dev/jigsawstack/apis/jigsawstack-api/revisions/8bd803916bde?raw)