HTTP/REST API Compatibility

HTTP/REST API Compatibility

Detailed API compatibility reference for HeliosDB’s HTTP/REST interface.

Protocol Support

Feature	Status	Notes
HTTP/1.1	Supported	Full support
HTTP/2	Supported	Multiplexing, server push
HTTP/3 (QUIC)	Planned	Coming in v7.1
WebSocket	Supported	Real-time subscriptions
Server-Sent Events	Supported	Streaming updates

Authentication Methods

Method	Status	Use Case
API Key	Supported	Server-to-server
JWT (Bearer Token)	Supported	User sessions
OAuth 2.0	Supported	Third-party integration
Basic Auth	Supported	Simple authentication
mTLS (Client Certs)	Supported	High-security environments

Content Types

Request Content Types

Content-Type	Status	Notes
application/json	Supported	Default
application/x-ndjson	Supported	Newline-delimited JSON
application/msgpack	Supported	Binary, more compact
application/x-www-form-urlencoded	Supported	Form data
multipart/form-data	Supported	File uploads

Response Content Types

Accept Header	Status	Notes
application/json	Supported	Default
application/msgpack	Supported	30-50% smaller
text/csv	Supported	Tabular export
application/x-parquet	Supported	Columnar format

API Endpoints

Query Operations

Endpoint	Method	Description	Status
/api/v1/query	POST	Execute SQL query	Supported
/api/v1/query/async	POST	Async query execution	Supported
/api/v1/query/{id}	GET	Get async query result	Supported
/api/v1/query/{id}/cancel	POST	Cancel running query	Supported

Table Operations

Endpoint	Method	Description	Status
/api/v1/tables	GET	List tables	Supported
/api/v1/tables	POST	Create table	Supported
/api/v1/tables/{name}	GET	Get table schema	Supported
/api/v1/tables/{name}	DELETE	Drop table	Supported
/api/v1/tables/{name}/rows	GET	Query rows	Supported
/api/v1/tables/{name}/rows	POST	Insert rows	Supported
/api/v1/tables/{name}/rows	PUT	Update rows	Supported
/api/v1/tables/{name}/rows	DELETE	Delete rows	Supported

Vector Operations

Endpoint	Method	Description	Status
/api/v1/vectors/search	POST	Vector similarity search	Supported
/api/v1/vectors/upsert	POST	Upsert vectors	Supported
/api/v1/vectors/{id}	GET	Get vector by ID	Supported
/api/v1/vectors/{id}	DELETE	Delete vector	Supported

Schema Operations

Endpoint	Method	Description	Status
/api/v1/databases	GET	List databases	Supported
/api/v1/databases	POST	Create database	Supported
/api/v1/databases/{name}	DELETE	Drop database	Supported
/api/v1/schemas	GET	List schemas	Supported
/api/v1/indexes	GET	List indexes	Supported
/api/v1/indexes	POST	Create index	Supported

Admin Operations

Endpoint	Method	Description	Status
/api/v1/health	GET	Health check	Supported
/api/v1/metrics	GET	Prometheus metrics	Supported
/api/v1/info	GET	Server info	Supported
/api/v1/config	GET	Configuration	Supported

Databricks SQL API Compatibility

HeliosDB implements Databricks SQL Statement Execution API compatibility.

Endpoint	Method	Status
/api/2.0/sql/statements	POST	Supported
/api/2.0/sql/statements/{id}	GET	Supported
/api/2.0/sql/statements/{id}/cancel	POST	Supported

Pinecone API Compatibility

Full Pinecone Vector API compatibility for seamless migration.

Endpoint	Method	Status
/vectors/upsert	POST	Supported
/vectors/query	POST	Supported
/vectors/fetch	GET	Supported
/vectors/delete	POST	Supported
/vectors/update	POST	Supported
/describe_index_stats	GET	Supported

Query Parameters

Pagination

Parameter	Type	Description	Default
limit	integer	Maximum rows to return	100
offset	integer	Number of rows to skip	0
page	integer	Page number (1-based)	1
page_size	integer	Rows per page	100

Filtering

Parameter	Type	Description	Example
filter	string	SQL WHERE clause	status='active'
sort	string	ORDER BY clause	created_at DESC
fields	string	SELECT columns	id,name,email

Response Format

Parameter	Type	Description	Options
format	string	Response format	json, msgpack, csv
pretty	boolean	Pretty print JSON	true, false

Error Responses

Standard Error Format

{
  "error": {
    "code": "INVALID_QUERY",
    "message": "Syntax error near 'SELEC'",
    "details": {
      "line": 1,
      "column": 1,
      "suggestion": "Did you mean 'SELECT'?"
    }
  },
  "request_id": "req_abc123"
}

HTTP Status Codes

Code	Meaning	Description
200	OK	Success
201	Created	Resource created
400	Bad Request	Invalid input
401	Unauthorized	Auth required
403	Forbidden	Access denied
404	Not Found	Resource not found
429	Too Many Requests	Rate limited
500	Internal Error	Server error
503	Service Unavailable	Maintenance

Compression

Algorithm	Accept-Encoding	Content-Encoding
gzip	gzip	gzip
Brotli	br	br
Zstandard	zstd	zstd

---

Last Updated: January 2026