Jump to Content
Recipes
API Reference
v0.8
v0.75
v0.76
v1.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
X-Stream
Recipes
API Reference
Embed enriched or non-enriched chunks
Search
JUMP TO
Platform Knowledge Lake service API
Knowledge Lake
Context Search
post
question
Post Question
post
Auth0 OAuth Token API
Authorization
Obtain OAuth Token
post
X-Stream API
Pipeline Component
Ingest documents from an unstructured S3 bucket, Postgres, or normal S3
post
Chunk input text
post
Enrich chunks with contextual summarization and entity extraction
post
Embed enriched or non-enriched chunks
post
X-Stream Knowledge-as-a-Service API
KnowledgeBases
Retrieve list of available Knowledge Bases
get
QAPairs
Extract user question‑answer pairs within a time frame
get
Evaluations
Submit a golden question set for knowledge base evaluation
post
Workflows
List configured workflows and pipelines
get
Trigger a configured workflow by GUID
post
Sessions
Create a new agentic AI session
post
List all conversational sessions
get
Retrieve details of a specific session
get
Enterprise Data Ingestion - OpenAPI 3.0
connector
Check Source Connector
post
Finds Source Connectors
get
Add a new connector
post
Finds Connectors by type
get
Update an existing connector
put
Partially update an existing connector
patch
Find Connector by ID
get
Deletes a Connector
del
connection
Add a new connection
post
get connections
get
Find Connection by ID
get
Update an existing connection
put
Partially update an existing connection
patch
Deletes a Connection
del
job
Add a new job
post
List all jobs
get
Find job by ID
get
schema
Find schema by ID
get
project
Create a new project
post
Retrieve a list of projects
get
Retrieve a specific project with id
get
dataset
Create a new dataset
post
Retrieve a list of datasets
get
Retrieve details of a specific dataset
get
knowledge-bases
Create a new knowledge base
post
Retrieve a list of knowledge bases
get
Retrieve details of a specific knowledge base
get
pipeline-templates
Retrieve a list of available pipeline template types
get
Create a new pipeline template
post
Retrieve pipeline templates with template type for a given tenant
get
Retrieve a pipeline template with its id
get
documents-and-chunks
Retrieve documents for a given dataset
get
Retrieve chunks for a given document in a dataset
get
source
Create a source connector
post
Trigger data ingestion from source
post
Platform Knowledge Lake service API
knowledge-lake
Upload Files
post
Update Document From File
post
Get Documents
get
Post Document
post
Get Document
get
Delete Document
del
Update Document
put
Vector Search
post
Ask Rag Pipeline
get
Search Documents
post
Post Metadata Key Search
post
Context Search
post
Post Context Search Feedback
post
internals
Readiness
get
Liveness
get
question
Post Question
post
List All Questions
get
Post Feedback
post
List All Question-Feedback-Entries
get
Platform Hello World Python service API
llm-inference
Returns Hello World
get
internals
Internal endpoint to check the health of the service
get
Embed enriched or non-enriched chunks
post
https://example.com/embed
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
