Generated reference · API

Sophia API - Knowledge Engine

Sophia is the Knowledge Engine domain of Oshun Platform, handling document ingestion, semantic search, RAG, knowledge graphs, and citation management.

58endpoints61schemas1.0.0version
Source
On this page

Citations (5)#

GET/v1/citationsList citations
POST/v1/citationsCreate a citation
POST/v1/citations/sourcesFind potential citation sources
GET/v1/citations/{citationId}Get citation details
POST/v1/citations/{citationId}/verifyVerify citation

Documents (11)#

GET/v1/documentsList documents
POST/v1/documentsIngest a document
POST/v1/documents/batchIngest batch of documents
GET/v1/documents/{documentId}Get document details
PATCH/v1/documents/{documentId}Update document
DELETE/v1/documents/{documentId}Delete document
POST/v1/documents/{documentId}/archiveArchive a document (soft-delete)
GET/v1/documents/{documentId}/chunksGet document chunks
POST/v1/documents/{documentId}/reindexRe-run embedding + indexing for a document
POST/v1/documents/{documentId}/restoreRestore a previously archived document
GET/v1/ingestion/{jobId}Get ingestion status

Health (1)#

GET/v1/healthService health check

Indexes (5)#

GET/v1/indexesList indexes
POST/v1/indexesCreate an index
GET/v1/indexes/{indexId}Get index details
POST/v1/indexes/{indexId}/rebuildRebuild index
GET/v1/indexes/{indexId}/statsGet index statistics

Ingestion (6)#

GET/v1/jobs/{jobId}Get ingestion job
POST/v1/jobs/{jobId}/cancelCancel an ingestion job
POST/v1/jobs/{jobId}/retryRetry a failed ingestion job
POST/v1/sourcesCreate an ingestion source
DELETE/v1/sources/{sourceId}Delete an ingestion source
POST/v1/validate-urlValidate that a URL is reachable and ingestable

Knowledge Graph (11)#

GET/v1/entitiesList entities
POST/v1/entitiesCreate an entity
POST/v1/entities/mergeMerge entities
POST/v1/entities/resolveResolve entity by name
GET/v1/entities/{entityId}Get entity details
PATCH/v1/entities/{entityId}Update entity
DELETE/v1/entities/{entityId}Delete entity
POST/v1/graph/pathsFind paths between entities
POST/v1/graph/subgraphGet subgraph
GET/v1/relationsList relations
POST/v1/relationsCreate a relation

KnowledgeGraph (9)#

GET/v1/entities/duplicatesEnumerate duplicate-entity candidates
GET/v1/entities/{entityId}/neighborsGet direct neighbours of an entity
POST/v1/graph/all-pathsEnumerate all paths between two entities up to a depth
POST/v1/graph/shortest-pathCompute shortest path between two entities
GET/v1/graph/statisticsGraph-wide summary statistics
POST/v1/graph/traverseTraverse the graph from a seed entity
POST/v1/relationshipsCreate a relationship (typed edge between entities)
GET/v1/relationships/{relationshipId}Get a relationship
DELETE/v1/relationships/{relationshipId}Delete a relationship

KnowledgePacks (5)#

GET/v1/knowledge-packsList knowledge packs
POST/v1/knowledge-packsCreate a knowledge pack
GET/v1/knowledge-packs/{knowledgePackId}Get a knowledge pack
PATCH/v1/knowledge-packs/{knowledgePackId}Update a knowledge pack
DELETE/v1/knowledge-packs/{knowledgePackId}Delete a knowledge pack
POST/v1/askAsk a question with RAG
GET/v1/queries/{queryId}Get a stored query result
POST/v1/searchPerform semantic search
POST/v1/search/hybridPerform hybrid (keyword + semantic) search
POST/v1/similarFind similar content

Schemas (61)#

AnswerChunkobjectAnswerResponseobjectAskQuestionRequestobjectChunkobjectChunkListobjectChunkingStrategystringCitationobjectCitationListobjectCitedSourceobjectCreateCitationRequestobjectCreateEntityRequestobjectCreateIndexRequestobjectCreateIngestionSourceRequestobjectCreateKnowledgePackRequestobjectCreateRelationRequestobjectDocumentobjectDocumentListobjectDocumentStatusstringDocumentTypestringDuplicateEntityListobjectDuplicateEntityPairobjectEmbeddingProviderstringEntityobjectEntityListobjectEntityMatchListobjectEntityTypestringFindSimilarRequestobjectGraphPathRequestobjectGraphStatisticsobjectGraphTraverseRequestobjectHealthStatusobjectHybridSearchRequestobjectIndexobjectIndexListobjectIndexStatsobjectIngestBatchRequestobjectIngestDocumentRequestobjectIngestionJobobjectIngestionSourceobjectIngestionSourceTypestringKnowledgePackobjectKnowledgePackListobjectPaginationMetaobjectPathListobjectRelationobjectRelationListobjectRelationTypestringSearchFilterobjectSearchRequestobjectSearchResponseobjectSearchResultobjectSimilarDocumentsResponseobjectSourceInfoobjectSourceListobjectSubgraphobjectUpdateDocumentRequestobjectUpdateEntityRequestobjectUpdateKnowledgePackRequestobjectValidateUrlRequestobjectValidateUrlResponseobjectVerificationResultobject