API
The NXTL API exposes the building blocks used by the SDK and plugins, enabling you to create low-level integrations and personalized experiences from any technology stack.
Base URL and access
- Base URL:
https://service.nxtl.ai - Authentication: pass your project API key in the
X-Api-Keyheader and include theprojectIdin the JSON body (forPOST) or query string (forGET).
Endpoints
Core
| Endpoint | Use it to… |
|---|---|
POST /conversation | Process context to generate an assistant message, retrieve and rerank relevant entries, and determine optimal user journey and matrix. |
POST /transformation | Process context to generate an artifact for a specific matrix. |
POST /transposition | Process context to generate conversational suggestions. |
Supplementary
| Endpoint | Use it to… |
|---|---|
POST /reranking | Process context to rerank retrieved entries. |
CRUD
| Endpoint | Use it to… |
|---|---|
GET /crud/artifacts | Fetch all project artifacts. |
DELETE /crud/deleteEntry | Delete an entry. |
DELETE /crud/deleteMatrix | Delete a matrix configuration. |
DELETE /crud/deleteUserJourney | Delete a user journey. |
GET /crud/entries | Fetch all project entries. |
GET /crud/matrices | Fetch all project matrices. |
POST /crud/retrieveEntries | Retrieve entries using semantic search. |
POST /crud/setArtifact | Create or update an artifact. |
POST /crud/setMatrix | Create or update a matrix configuration. |
POST /crud/syncEntries | Synchronize a batch of entries. |
POST /crud/syncEntry | Synchronize a single entry. |
GET /crud/userJourneys | Fetch all project user journeys. |
POST /crud/userJourneys | Create or update user journeys. |
Last updated on