Embed URL content

POST 
/ai/embeddings/url

Embed website content from a specified URL, including child pages up to 5 levels deep within the same domain. The process crawls and loads content from the main URL and its linked pages into a Telnyx Cloud Storage bucket. As soon as each webpage is added to the bucket, its content is immediately processed for embeddings, that can be used for similarity search and clustering.

application/json

Body

required

url URL (string)required

The URL of the webpage to embed

bucket_name Bucket Name (string)

Name of the bucket to store the embeddings. If not provided, a new bucket will be created.

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object

required

task_id uuid

task_name Task Name (string)

status Status (string)

created_at Created At (string)

finished_at Finished At (string)nullable

user_id uuid

{
  "data": {
    "task_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "task_name": "string",
    "status": "string",
    "created_at": "string",
    "finished_at": "string",
    "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

422: Validation Error

application/json

• Schema
• Example (from schema)

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

• MOD1
• MOD2

string

integer

]

msg Message (string)required

type Error Type (string)required

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/ai/embeddings/url' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "url": "string",
  "bucket_name": "string"
}'

Response samples

• 200
• 422

---

{
  "data": {
    "task_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "task_name": "string",
    "status": "string",
    "created_at": "string",
    "finished_at": "string",
    "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}