Embeddings

Embed URL content

Changed on

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.

post/ai/embeddings/url

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/ai/embeddings/url
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores. Generate a unique UUID v4 for each operation and reuse it only when retrying that operation with the same request. Invalid headers—including duplicate, empty, malformed, or overlong values—return 400 with error code 10015. A request already in progress with the same key returns 409; reusing the key with a different request returns 422. Only successful responses are replayed, for up to 24 hours. Do not include sensitive data in the key.

Request body

urlstring required

The URL of the webpage to embed

bucket_namestring required

Name of the bucket to store the embeddings. This bucket must already exist.

Response

Successful Response

Changes

  • 9621f6123ebcRevision changes
    • warning

      added the new 10011 enum value to the // response property for the response status

    • warning

      added the new domain_graduation_limit_exceeded enum value to the // response property for the response status

  • a6a61a29ecddRevision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added to the response body anyOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status