# API Overview

# API Overview

Curiosity Workspace exposes APIs that let you:

  • ingest and update graph data
  • query the graph (traversals, filtering, aggregations)
  • perform search (text, vector, hybrid)
  • run custom business logic via endpoints
  • build custom interfaces and integrations

This section focuses on how to think about the API surface, not only the raw endpoints.

# API surface areas (conceptual)

  • Data / Graph API
    • create/update schemas
    • upsert nodes and edges
    • run graph queries
  • Search API
    • execute text and vector retrieval
    • apply facets/filters and sort modes
  • AI APIs
    • embeddings-based similarity and retrieval
    • LLM interactions (when enabled/configured)
  • Endpoints API
    • run custom endpoints securely (internal and external callers)
  • Admin APIs
    • tokens, permissions, configuration, monitoring hooks (admin only)

# Authentication patterns

Common patterns include:

  • User auth: calls made from the UI as a logged-in user
  • API tokens: ingestion connectors and integrations
  • Endpoint tokens: external systems calling custom endpoints

Always align tokens with least privilege and environment boundaries (dev vs prod).

# Versioning and environments

Treat your workspace configuration like code:

  • version connector code and endpoint code
  • promote configs across environments with review
  • keep production changes reproducible

# Next steps