Find semantically similar passages within one document

Falls back to a lexical search and queues embedding indexing when no index exists yet (cold start).

GET /documents/{documentId}/search/semantic

Path parameters

documentId string Required

Headers

Authorization string Required
Bearer <session token>: the signed-in user’s Scaffold session token.
x-org-id string Required

Query parameters

q string Required
limit integer
provider string

cURL Node Python

curl -X GET "https://api.scaffoldyourdocs.com/documents/document_example/search/semantic" \
  -H "Authorization: Bearer <session token>" \
  -H "x-org-id: org_example"

const response = await fetch("https://api.scaffoldyourdocs.com/documents/document_example/search/semantic", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <session token>",
    "x-org-id": "org_example"
  }
});

import requests

response = requests.get(
    "https://api.scaffoldyourdocs.com/documents/document_example/search/semantic",
    headers={
        "Authorization": "Bearer <session token>",
        "x-org-id": "org_example"
    }
)