Documentation

English

Français

English

Français

Source Administration ​

Document List ​

GET /datastore/v1/data-sources/{data_source_id}/documents

bash
curl -X GET "https://apis.wikit.ai/datastore/v1/data-sources/$SEMANTICS_DATASOURCE_ID/documents" \
  -H "Authorization: Bearer $SEMANTICS_TOKEN" \
  -H "X-Wikit-Organization-Id: $SEMANTICS_ORG_ID"

Adding Document(s) ​

POST /datastore/v1/data-sources/{data_source_id}/documents/upload

bash
curl -X POST "https://apis.wikit.ai/datastore/v1/data-sources/$SEMANTICS_DATASOURCE_ID/documents/upload" \
  -H "Authorization: Bearer $SEMANTICS_TOKEN" \
  -H "X-Wikit-Organization-Id: $SEMANTICS_ORG_ID" \
  -H "Content-Type: multipart/form-data" \
  -F "documents=@/path/to/file-to-upload.txt"

To add several documents:

bash
curl -X POST "https://apis.wikit.ai/datastore/v1/data-sources/$SEMANTICS_DATASOURCE_ID/documents/upload" \
  -H "Authorization: Bearer $SEMANTICS_TOKEN" \
  -H "X-Wikit-Organization-Id: $SEMANTICS_ORG_ID" \
  -H "Content-Type: multipart/form-data" \
  -F "documents=@/path/to/file-1.pdf" \
  -F "documents=@/path/to/file-2.docx"

Updating a Document ​

PUT /datastore/v1/data-sources/{data_source_id}/documents/{document_id}

Allows you to modify a document's information: name, URL, and metadata.

bash
curl -X PUT "https://apis.wikit.ai/datastore/v1/data-sources/$SEMANTICS_DATASOURCE_ID/documents/$SEMANTICS_DOCUMENT_ID" \
  -H "Authorization: Bearer $SEMANTICS_TOKEN" \
  -H "X-Wikit-Organization-Id: $SEMANTICS_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My document.pdf",
    "url": "https://example.com/document.pdf",
    "metadata": {}
  }'

Deleting a Document ​

DELETE /datastore/v1/data-sources/{data_source_id}/documents/{document_id}

bash
curl -X DELETE "https://apis.wikit.ai/datastore/v1/data-sources/$SEMANTICS_DATASOURCE_ID/documents/$SEMANTICS_DOCUMENT_ID" \
  -H "Authorization: Bearer $SEMANTICS_TOKEN" \
  -H "X-Wikit-Organization-Id: $SEMANTICS_ORG_ID"

Viewing Document Metadata ​

GET /datastore/v1/data-sources/{data_source_id}/documents/{document_id}

bash
curl -X GET "https://apis.wikit.ai/datastore/v1/data-sources/$SEMANTICS_DATASOURCE_ID/documents/$SEMANTICS_DOCUMENT_ID" \
  -H "Authorization: Bearer $SEMANTICS_TOKEN" \
  -H "X-Wikit-Organization-Id: $SEMANTICS_ORG_ID"

List of Chunks for a Document ​

GET /datastore/v1/data-sources/{data_source_id}/documents/{document_id}/chunks

bash
curl -X GET "https://apis.wikit.ai/datastore/v1/data-sources/$SEMANTICS_DATASOURCE_ID/documents/$SEMANTICS_DOCUMENT_ID/chunks" \
  -H "Authorization: Bearer $SEMANTICS_TOKEN" \
  -H "X-Wikit-Organization-Id: $SEMANTICS_ORG_ID"

Viewing a Chunk ​

GET /datastore/v1/documents/{document_id}/chunks/{chunk_id}

bash
curl -X GET "https://apis.wikit.ai/datastore/v1/documents/$SEMANTICS_DOCUMENT_ID/chunks/$SEMANTICS_CHUNK_ID" \
  -H "Authorization: Bearer $SEMANTICS_TOKEN" \
  -H "X-Wikit-Organization-Id: $SEMANTICS_ORG_ID"