Jump to Content

Recipes API Reference

API Reference

Recipes API Reference

Platform Knowledge Lake service API

Knowledge Lake
- Context Searchpost
question
- Post Questionpost

Auth0 OAuth Token API

Authorization
- Obtain OAuth Tokenpost

X-Stream API

Pipeline Component

X-Stream Knowledge-as-a-Service API

KnowledgeBases
- Retrieve list of available Knowledge Basesget
QAPairs
- Extract user question‑answer pairs within a time frameget
Evaluations
- Submit a golden question set for knowledge base evaluationpost
Workflows
- List configured workflows and pipelinesget
- Trigger a configured workflow by GUIDpost
Sessions

Enterprise Data Ingestion - OpenAPI 3.0

connector
connection
job
schema
- Find schema by IDget
project
dataset
knowledge-bases
pipeline-templates
documents-and-chunks
- Retrieve documents for a given datasetget
- Retrieve chunks for a given document in a datasetget
source
- Create a source connectorpost
- Trigger data ingestion from sourcepost

Platform Knowledge Lake service API

knowledge-lake
internals
- Readinessget
- Livenessget
question

Platform Hello World Python service API

llm-inference
- Returns Hello Worldget
internals
- Internal endpoint to check the health of the serviceget

Ingest documents from an unstructured S3 bucket, Postgres, or normal S3

post https://example.com/ingest

Language

Click Try It! to start a request and see the response here!