Queue a document for semantic-search indexing

POST /documents/{documentId}/index

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

Body

provider string
Embedding provider name. Defaults to the configured provider.

cURL Node Python

curl -X POST "https://api.scaffoldyourdocs.com/documents/document_example/index" \
  -H "Authorization: Bearer <session token>" \
  -H "x-org-id: org_example" \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch("https://api.scaffoldyourdocs.com/documents/document_example/index", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <session token>",
    "x-org-id": "org_example",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({})
});

import requests

response = requests.post(
    "https://api.scaffoldyourdocs.com/documents/document_example/index",
    headers={
        "Authorization": "Bearer <session token>",
        "x-org-id": "org_example",
        "Content-Type": "application/json"
    },
    json={},
)