Skip to Content

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-Key header and include the projectId in the JSON body (for POST) or query string (for GET).

Endpoints

Core

EndpointUse it to…
POST /conversationProcess context to generate an assistant message, retrieve and rerank relevant entries, and determine optimal user journey and matrix.
POST /transformationProcess context to generate an artifact for a specific matrix.
POST /transpositionProcess context to generate conversational suggestions.

Supplementary

EndpointUse it to…
POST /rerankingProcess context to rerank retrieved entries.

CRUD

EndpointUse it to…
GET /crud/artifactsFetch all project artifacts.
DELETE /crud/deleteEntryDelete an entry.
DELETE /crud/deleteMatrixDelete a matrix configuration.
DELETE /crud/deleteUserJourneyDelete a user journey.
GET /crud/entriesFetch all project entries.
GET /crud/matricesFetch all project matrices.
POST /crud/retrieveEntriesRetrieve entries using semantic search.
POST /crud/setArtifactCreate or update an artifact.
POST /crud/setMatrixCreate or update a matrix configuration.
POST /crud/syncEntriesSynchronize a batch of entries.
POST /crud/syncEntrySynchronize a single entry.
GET /crud/userJourneysFetch all project user journeys.
POST /crud/userJourneysCreate or update user journeys.
Last updated on