# CodeAlive ## Docs - [Authentication](https://docs.codealive.ai/api-reference/authentication.md): Learn how to authenticate with the CodeAlive API - [ (Auth policies: ApiKeyOrJwt)](https://docs.codealive.ai/api-reference/chat/auth-policies:-apikeyorjwt.md) - [Cancel an in-flight chat stream. (Auth policies: ApiKeyOrJwt)](https://docs.codealive.ai/api-reference/chat/cancel-an-in-flight-chat-stream-auth-policies:-apikeyorjwt.md): User-initiated cancellation for the active `POST /api/chat/completions` stream. Returns 202 Accepted whether or not a stream was actually found — the request is idempotent and the client doesn't need to know if it lost a race with stream completion. Wave 7 of `cha… - [Chat Completions](https://docs.codealive.ai/api-reference/chat/completions.md): Stream AI-powered responses with full codebase context - [Streams chat completions for a conversation (Auth policies: ApiKeyOrJwt)](https://docs.codealive.ai/api-reference/chat/streams-chat-completions-for-a-conversation-auth-policies:-apikeyorjwt.md): Sample request with IDs: POST /api/chat/completions { "stream": true, "messages": [ { "role": "user", "content": "Hello, how are you?" } ], "dataSources": [ { "type": "workspace",… - [Downloads ontology for one or more data sources. (Auth policies: ApiKeyOrJwt)](https://docs.codealive.ai/api-reference/datasource/downloads-ontology-for-one-or-more-data-sources-auth-policies:-apikeyorjwt.md): Sample requests: By name: GET /api/datasources/ontology?Names=my-repository By ID: GET /api/datasources/ontology?DataSourceIds=67f664fd4c2a00698a52bb6f Legacy ID parameter alias: GET /api/datasources/ontology?Ids=67f664fd4c2a00698a52bb6f… - [Gets all available data sources that have been processed (LastProcessedAt != null). This endpoint is primarily for backward compatibility and should be deleted. Consider using /ready endpoint instead. (Auth policies: ApiKeyOrJwt)](https://docs.codealive.ai/api-reference/datasource/gets-all-available-data-sources-that-have-been-processed-lastprocessedat-!=-nullthis-endpoint-is-primarily-for-backward-compatibility-and-should-be-deleted-consider-using-ready-endpoint-instead-auth-policies:-apikeyorjwt.md) - [Gets all data sources (repositories and workspaces) regardless of their state. This endpoint is primarily intended for administrative use cases where all data sources need to be accessed regardless of their processing status. (Auth policies: ApiKeyOrJwt)](https://docs.codealive.ai/api-reference/datasource/gets-all-data-sources-repositories-and-workspaces-regardless-of-their-statethis-endpoint-is-primarily-intended-for-administrative-use-cases-where-all-data-sourcesneed-to-be-accessed-regardless-of-their-processing-status-auth-policies:-apikeyorjwt.md) - [Gets data sources ready for use (repositories with PartiallyReady or Ready status) (Auth policies: ApiKeyOrJwt)](https://docs.codealive.ai/api-reference/datasource/gets-data-sources-ready-for-use-repositories-with-partiallyready-or-ready-status-auth-policies:-apikeyorjwt.md) - [Get Available Data Sources](https://docs.codealive.ai/api-reference/datasources/active.md): Retrieve data sources in "Ready" state for chat and search operations - [List All Data Sources](https://docs.codealive.ai/api-reference/datasources/list.md): Retrieve all data sources regardless of their processing status - [Dify External Knowledge API - Retrieval endpoint. Searches CodeAlive repositories and workspaces for relevant code artifacts. (Auth policies: ApiKeyOrJwt)](https://docs.codealive.ai/api-reference/dify/dify-external-knowledge-api--retrieval-endpointsearches-codealive-repositories-and-workspaces-for-relevant-code-artifacts-auth-policies:-apikeyorjwt.md): This endpoint implements the Dify External Knowledge API specification, allowing Dify AI applications to query CodeAlive repositories as knowledge bases. - [API Guide](https://docs.codealive.ai/api-reference/guide.md): Practical guide to using the CodeAlive API - [API Introduction](https://docs.codealive.ai/api-reference/introduction.md): Complete API reference for CodeAlive platform - [Dify Knowledge Retrieval](https://docs.codealive.ai/api-reference/knowledge/retrieval.md): Dify External Knowledge API for searching CodeAlive repositories and workspaces - [Fetch Artifacts](https://docs.codealive.ai/api-reference/search/artifacts.md): Retrieve full content for artifacts by their identifiers - [ (Auth policies: ApiKeyOrJwt)](https://docs.codealive.ai/api-reference/search/auth-policies:-apikeyorjwt.md) - [ (Auth policies: ApiKeyOrJwt)](https://docs.codealive.ai/api-reference/search/auth-policies:-apikeyorjwt-1.md): Known gap: CodeAlive.Domain.DTOs.GrepSearchResultDto.Summary on the returned results is currently always `null` on this endpoint. The agent-tool path (`GrepSearchFunction.ExecuteAsync`) enriches each hit with `Realized.ShortSummary` via a separate Mongo round-trip, but the public HTTP path here maps… - [Batch retrieve artifact content by identifier (Auth policies: ApiKeyOrJwt)](https://docs.codealive.ai/api-reference/search/batch-retrieve-artifact-content-by-identifier-auth-policies:-apikeyorjwt.md) - [Search](https://docs.codealive.ai/api-reference/search/query.md): Execute semantic search queries across your codebase - [Retrieve grouped relationships for a single artifact by profile (Auth policies: ApiKeyOrJwt)](https://docs.codealive.ai/api-reference/search/retrieve-grouped-relationships-for-a-single-artifact-by-profile-auth-policies:-apikeyorjwt.md) - [Search for code artifacts (Auth policies: ApiKeyOrJwt)](https://docs.codealive.ai/api-reference/search/search-for-code-artifacts-auth-policies:-apikeyorjwt.md): Sample requests: Basic search with IDs: GET /api/search?Query=how%20to%20connect%20to%20database&DataSourceIds=67f664fd4c2a00698a52bb6f&Mode=fast Search with workspace/repository names: GET /api/search?Query=authentication&Names=MyWorkspace&Names=my-reposito… - [AI Code Review](https://docs.codealive.ai/features/ai-code-review.md): Automated intelligent code reviews for every pull request - [Codebase Chat](https://docs.codealive.ai/features/codebase-chat.md): Have AI-powered conversations with deep understanding of your code - [Multi-Repository & Workspaces](https://docs.codealive.ai/features/multi-repo.md): Search and analyze across multiple repositories and workspaces - [Semantic Code Search](https://docs.codealive.ai/features/semantic-search.md): Find code by meaning and intent across your entire codebase - [Welcome to CodeAlive](https://docs.codealive.ai/index.md): Context Engine for AI-powered Code Review & Codebase Deep Research - [Installation](https://docs.codealive.ai/installation.md): Install CodeAlive to your AI coding agents with one command - [Model Context Protocol (MCP)](https://docs.codealive.ai/integrations/mcp.md): Connect CodeAlive to AI assistants via Model Context Protocol for deep codebase understanding - [Amazon Q Developer](https://docs.codealive.ai/integrations/mcp/amazon-q.md): Connect CodeAlive with Amazon Q Developer CLI and IDE - [ChatGPT](https://docs.codealive.ai/integrations/mcp/chatgpt.md): Connect CodeAlive with ChatGPT using Custom GPTs and Actions - [Claude Code Integration](https://docs.codealive.ai/integrations/mcp/claude-code.md): Connect CodeAlive with Claude Code for enhanced AI-powered development - [Claude Desktop](https://docs.codealive.ai/integrations/mcp/claude-desktop.md): Connect CodeAlive with Claude Desktop application - [Cline](https://docs.codealive.ai/integrations/mcp/cline.md): Connect CodeAlive with Cline autonomous coding agent - [Codex](https://docs.codealive.ai/integrations/mcp/codex.md): Connect CodeAlive with OpenAI Codex CLI, Desktop App, and IDE Extension - [Continue](https://docs.codealive.ai/integrations/mcp/continue.md): Connect CodeAlive with Continue open-source AI code assistant - [Cursor](https://docs.codealive.ai/integrations/mcp/cursor.md): Integrate CodeAlive with Cursor IDE for AI-powered development - [Gemini CLI](https://docs.codealive.ai/integrations/mcp/gemini-cli.md): Connect CodeAlive with Google Gemini CLI - [OpenClaw](https://docs.codealive.ai/integrations/mcp/openclaw.md): Connect CodeAlive with OpenClaw for semantic code search and codebase intelligence - [OpenCode](https://docs.codealive.ai/integrations/mcp/opencode.md): Connect CodeAlive with OpenCode AI terminal assistant - [Other Agents](https://docs.codealive.ai/integrations/mcp/other-agents.md): Connect CodeAlive with Roo Code, Zed, Goose, and more - [Self-Hosting Guide](https://docs.codealive.ai/integrations/mcp/self-hosting.md): Deploy CodeAlive MCP server on your own infrastructure - [VS Code + GitHub Copilot](https://docs.codealive.ai/integrations/mcp/vscode.md): Connect CodeAlive with GitHub Copilot in VS Code using native MCP support - [Windsurf](https://docs.codealive.ai/integrations/mcp/windsurf.md): Connect CodeAlive with Windsurf AI coding assistant - [Claude Code Plugin](https://docs.codealive.ai/integrations/plugin-claude-code.md): Install the CodeAlive plugin for Claude Code — includes skill, subagent, and authentication hooks - [Share the plugin with Codex CLI](https://docs.codealive.ai/integrations/share-plugin-with-codex.md): Reuse the Claude Code plugin's skill from Codex CLI and other skill-aware agents, with a launchd agent that follows every plugin update. - [Agent Skills & Plugins](https://docs.codealive.ai/integrations/skills.md): Install CodeAlive skills for intelligent codebase exploration patterns - [Quickstart](https://docs.codealive.ai/quickstart.md): Get started with CodeAlive in minutes - [Tips & Tricks](https://docs.codealive.ai/tips-and-tricks.md): Get the most out of CodeAlive with these practical tips - [Troubleshooting](https://docs.codealive.ai/troubleshooting.md): Solutions for common issues with CodeAlive - [Example Workflows](https://docs.codealive.ai/workflows.md): Real-world patterns for using CodeAlive with AI coding agents ## OpenAPI Specs - [swagger](https://app.codealive.ai/swagger/v2025-04-17/swagger.json) ## Optional - [GitHub](https://github.com/CodeAlive-AI) - [Dashboard](https://app.codealive.ai)