---
title: "Embed documents"
method: POST
path: "/ai/embeddings"
tags: ["Embeddings"]
---

# Embed documents

`POST /ai/embeddings`

Perform embedding on a Telnyx Storage Bucket using the a embedding model.
The current supported file types are:
- PDF
- HTML
- txt/unstructured text files
- json
- csv
- audio / video (mp3, mp4, mpeg, mpga, m4a, wav, or webm ) - Max of 100mb file size.

Any files not matching the above types will be attempted to be embedded as unstructured text.

This process can be slow, so it runs in the background and the user can check
the status of the task using the endpoint `/ai/embeddings/{task_id}`.

 **Important Note**: When you update documents in a Telnyx Storage bucket, their associated embeddings are automatically kept up to date. If you add or update a file, it is automatically embedded. If you delete a file, the embeddings are deleted for that particular file.

You can also specify a custom `loader` param. Currently the only supported loader value is
`intercom` which loads Intercom article jsons as specified by [the Intercom article API](https://developers.intercom.com/docs/references/rest-api/api.intercom.io/Articles/article/)
This loader will split each article into paragraphs and save additional parameters relevant to Intercom docs, such as
`article_url` and `heading`. These values will be returned by the `/v2/ai/embeddings/similarity-search` endpoint in the `loader_metadata` field.

## Request body

- EmbeddingBucketRequest
  - `bucket_name` string, required
  - `document_chunk_size` integer
  - `document_chunk_overlap_size` integer
  - `embedding_model` 'thenlper/gte-large' | 'intfloat/multilingual-e5-large' — Supported models to vectorize and embed documents.
  - `loader` 'default' | 'intercom' — Supported types of custom document loaders for embeddings.

## Response `200`

Successful Response

- EmbeddingResponse
  - `data` object, required
    - `task_id` string, uuid
    - `task_name` string
    - `status` string
    - `created_at` string
    - `finished_at` string, nullable
    - `user_id` string, uuid

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api/revisions/e32d46c5945b/schema)