API Reference

Complete reference for the SymbioseDB SDK and REST API endpoints.

SDK Installation

npm install @symbiosedb/sdk

        import { SymbioseDB } from '@symbiosedb/sdk';

const db = new SymbioseDB({
  connectionString: process.env.DATABASE_URL
});
      

QUERY db.query(sql, params)

Execute a SQL query with parameterized values.

CYPHER db.cypher(query, params)

Execute a Cypher graph query on Apache AGE.

VECTOR db.vector.search(embedding, options)

Perform semantic similarity search with pgvector.

GET /api/v1/tables

List all tables in the database.

GET /api/v1/tables/:name/rows

Retrieve rows from a table with filtering and pagination.

POST /api/v1/tables/:name/rows

Insert new rows into a table.

PUT /api/v1/tables/:name/rows/:id

Update a row by ID.

DELETE /api/v1/tables/:name/rows/:id

Delete a row by ID.

POST /api/v1/query

Execute raw SQL, Cypher, or GraphQL queries.

For complete SDK documentation with TypeScript types and examples, visit: