# Inkeep > Documentation for Inkeep ## Pages - [Inkeep Documentation](inkeep-documentation.md) - [Core concepts (/concepts)](core-concepts-concepts.md): Learn about the key building blocks of Inkeep - Agents, Sub Agents, tools, data components, and more. - [The No-Code + Code Agent Builder (/overview)](the-no-code-code-agent-builder-overview.md): Inkeep is a platform for building Agent Chat Assistants and AI Workflows. - [Pricing (/pricing)](pricing-pricing.md): Learn about Inkeep's pricing plans and features - [Troubleshooting Guide (/troubleshooting)](troubleshooting-guide-troubleshooting.md): Learn how to diagnose and resolve issues when something breaks in your Inkeep agent system. - [Inkeep API (/api-reference)](inkeep-api-api-reference.md): Explore the Inkeep Agents API endpoints for managing, running, and evaluating agents. - [Join & Follow (/community/inkeep-community)](join-follow-communityinkeep-community.md): To get help, share ideas, and provide feedback, join our community: - [License (/community/license)](license-communitylicense.md): License for the Inkeep Agent Framework - [CrewAI vs Inkeep (/comparisons/crewai)](crewai-vs-inkeep-comparisonscrewai.md): Compare CrewAI with Inkeep - [Lindy vs Inkeep (/comparisons/lindy)](lindy-vs-inkeep-comparisonslindy.md): Compare Lindy with Inkeep - [n8n vs Inkeep (/comparisons/n8n)](n8n-vs-inkeep-comparisonsn8n.md): Compare n8n with Inkeep - [OpenAI AgentKit vs Inkeep (/comparisons/openai-agent-kit)](openai-agentkit-vs-inkeep-comparisonsopenai-agent-kit.md): Compare OpenAI AgentKit with Inkeep - [Connect Your Data with Context7 (/connect-your-data/context7)](connect-your-data-with-context7-connect-your-datacontext7.md): Learn how to connect your code repositories and documentation to your agents using Context7 - [Connect Your Data with Firecrawl (/connect-your-data/firecrawl)](connect-your-data-with-firecrawl-connect-your-datafirecrawl.md): Connect websites to your agents using Firecrawl - [Crawl to discover pages](crawl-to-discover-pages.md): crawl_result = app.crawl( - [Extract URLs](extract-urls.md): urls = [page.metadata.url for page in crawl_result.data - [Batch scrape](batch-scrape.md): batch_job = app.batch_scrape(urls, formats=["markdown"]) - [This creates a directory for our documents and saves each scraped page as a numbered markdown file](this-creates-a-directory-for-our-documents-and-saves-each-scraped-page-as-a-numb.md): output_dir = Path("data/documents") - [Initialize Pinecone](initialize-pinecone.md): pc = Pinecone(api_key=os.environ["PINECONE_API_KEY"]) - [Create assistant](create-assistant.md): assistant = pc.assistant.Assistant( - [Upload markdown files to assistant](upload-markdown-files-to-assistant.md): for md_file in Path("data/documents").glob("*.md"): - [Connect Your Data with Inkeep Unified Search (/connect-your-data/inkeep)](connect-your-data-with-inkeep-unified-search-connect-your-datainkeep.md): Learn how to connect your data sources to your agents using Inkeep Unified Search's comprehensive knowledge base plat... - [Connecting Your Data (/connect-your-data/overview)](connecting-your-data-connect-your-dataoverview.md): Learn how to connect your data sources to your agents through MCP servers - [Connect Your Data with Pinecone (/connect-your-data/pinecone)](connect-your-data-with-pinecone-connect-your-datapinecone.md): Connect documents to your agents using Pinecone Assistant's MCP server - [Connect Your Data with Ref (/connect-your-data/ref)](connect-your-data-with-ref-connect-your-dataref.md): Learn how to connect your documentation and code repositories to your agents using Ref - [Deploy to Vercel (/deployment/vercel)](deploy-to-vercel-deploymentvercel.md): Deploy the Inkeep Agent Framework to Vercel - [Doltgres Database](doltgres-database.md): INKEEP_AGENTS_MANAGE_DATABASE_URL= - [Postgres Database](postgres-database.md): INKEEP_AGENTS_RUN_DATABASE_URL= - [Doltgres Database](doltgres-database-2.md): INKEEP_AGENTS_MANAGE_DATABASE_URL= - [Postgres Database](postgres-database-2.md): INKEEP_AGENTS_RUN_DATABASE_URL= - [Postgres Database](postgres-database-3.md): INKEEP_AGENTS_RUN_DATABASE_URL= - [HTTP/2 204](http2-204.md): A comprehensive endpoint that verifies database connectivity before serving traffic. - [Healthy response](healthy-response.md): curl - [Unhealthy response (503 Service Unavailable)](unhealthy-response-503-service-unavailable.md): { - [Add Inkeep Skills and MCP Server to your IDE or coding tools (/get-started/ai-coding-setup-for-ide)](add-inkeep-skills-and-mcp-server-to-your-ide-or-coding-tools-get-startedai-codin.md): Install Skills and MCP to help AI coding assistants build Inkeep agents. - [Push / Pull (/get-started/push-pull)](push-pull-get-startedpush-pull.md): Push and pull your agents to and from the Visual Builder - [Quick Start (/get-started/quick-start)](quick-start-get-startedquick-start.md): Get started with Inkeep Agents in <1min - [Live Debugger, Traces, and OTEL Telemetry (/get-started/traces)](live-debugger-traces-and-otel-telemetry-get-startedtraces.md): Set up SigNoz to enable full observability with traces and live debugging capabilities for your agents. - [SigNoz](signoz.md): SIGNOZ_URL= - [SigNoz Configuration](signoz-configuration.md): SIGNOZ_URL= - [OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=https://ingest.us.signoz.cloud:443/v1/traces](otel-exporter-otlp-traces-endpointhttpsingestussignozcloud443v1traces.md) - [OTEL_EXPORTER_OTLP_TRACES_HEADERS="signoz-ingestion-key="](otel-exporter-otlp-traces-headerssignoz-ingestion-keyyour-ingestion-key.md): To get your SigNoz API key: - [Talk to your agent via A2A (JSON-RPC) (/talk-to-your-agents/a2a)](talk-to-your-agent-via-a2a-json-rpc-talk-to-your-agentsa2a.md): Use the Agent2Agent JSON-RPC protocol to send messages to your agent and receive results, with optional streaming. - [How to call your AI Agent using the Chat API (/talk-to-your-agents/chat-api)](how-to-call-your-ai-agent-using-the-chat-api-talk-to-your-agentschat-api.md): Learn about details of the Vercel AI SDK data stream protocol that powers the`/run/api/chat`API endpoint. - [MCP Server (/talk-to-your-agents/mcp-server)](mcp-server-talk-to-your-agentsmcp-server.md): Learn how to use the MCP server to talk to your agents - [Overview (/talk-to-your-agents/overview)](overview-talk-to-your-agentsoverview.md): Learn how to talk to your agents - [Webhook Triggers (/talk-to-your-agents/triggers)](webhook-triggers-talk-to-your-agentstriggers.md): Create webhook endpoints for external services to invoke your Agents - [Upgrading your Inkeep version (/tutorials/upgrading)](upgrading-your-inkeep-version-tutorialsupgrading.md): Upgrade the packages that make up the Inkeep Agent Framework - [Sub Agent Relationships (/typescript-sdk/agent-relationships)](sub-agent-relationships-typescript-sdkagent-relationships.md): Learn how to add Sub Agent relationships to your agent - [Agents & Sub Agents (/typescript-sdk/agent-settings)](agents-sub-agents-typescript-sdkagent-settings.md): Learn how to customize your Agents. - [CLI Reference (/typescript-sdk/cli-reference)](cli-reference-typescript-sdkcli-reference.md): Complete reference for the Inkeep CLI commands - [Install the CLI globally](install-the-cli-globally.md): npm install -g @inkeep/agents-cli - [Install the dashboard package (for visual agents orchestration)](install-the-dashboard-package-for-visual-agents-orchestration.md): npm install @inkeep/agents-manage-ui - [Configure Runtime Limits (/typescript-sdk/configure-runtime-limits)](configure-runtime-limits-typescript-sdkconfigure-runtime-limits.md): Customize execution limits, timeouts, and constraints for your deployment - [Configure Runtime Limits](configure-runtime-limits.md): The Inkeep Agent Framework includes sensible defaults for execution limits, timeouts, and constraints. However, certa... - [Context Fetchers (/typescript-sdk/context-fetchers)](context-fetchers-typescript-sdkcontext-fetchers.md): Learn how to use context fetchers to fetch data from external sources and make it available to your agents - [Data Operations (/typescript-sdk/data-operations)](data-operations-typescript-sdkdata-operations.md): Learn about data operations emitted by agents and how to use the x-emit-operations header to control their visibility. - [Add External Agents to your Agent (/typescript-sdk/external-agents)](add-external-agents-to-your-agent-typescript-sdkexternal-agents.md): Learn how to configure and use external agents using the A2A protocol - [Headers (/typescript-sdk/headers)](headers-typescript-sdkheaders.md): Pass dynamic context to your Agents via HTTP headers for personalized interactions - [Conversation Memory (/typescript-sdk/memory)](conversation-memory-typescript-sdkmemory.md): Understand how conversation history is managed and included in the context window for both main and delegated agents - [Model Configuration (/typescript-sdk/models)](model-configuration-typescript-sdkmodels.md): Configure AI models for your Agents and Sub Agents - [Project Management (/typescript-sdk/project-management)](project-management-typescript-sdkproject-management.md): Learn how to manage projects in the Inkeep Agent Framework - [Triggers (/typescript-sdk/triggers)](triggers-typescript-sdktriggers.md): Create webhook endpoints that allow external services to invoke your agents - [Workspace Configuration (/typescript-sdk/workspace-configuration)](workspace-configuration-typescript-sdkworkspace-configuration.md): Learn how to configure your workspace - [Use development config (specify from any project directory)](use-development-config-specify-from-any-project-directory.md): inkeep push --config ../inkeep.dev.config.ts - [or with absolute path](or-with-absolute-path.md): inkeep push --config /path/to/workspace/inkeep.dev.config.ts - [Access Control (/visual-builder/access-control)](access-control-visual-builderaccess-control.md): Multi-tenant authentication with organizations, team management, and fine-grained project permissions - [Context Fetchers (/visual-builder/context-fetchers)](context-fetchers-visual-buildercontext-fetchers.md): Learn how to use context fetchers to fetch data from external sources and make it available to your agents - [Headers (/visual-builder/headers)](headers-visual-builderheaders.md): Pass dynamic context to your agents via HTTP headers for personalized interactions - [Get started with the Visual Agent Builder (/visual-builder/sub-agents)](get-started-with-the-visual-agent-builder-visual-buildersub-agents.md): Create Agents with a No-Code Visual Agent Builder - [Environment Configuration (/community/contributing/environment-configuration)](environment-configuration-communitycontributingenvironment-configuration.md): How to configure the environment variables for the Inkeep Agent Framework - [Environment Configuration](environment-configuration.md): The Inkeep Agents framework uses a **centralized environment configuration**. This approach provides a single source ... - [Start development](start-development.md): pnpm dev - [Contribute to Inkeep Open Source project (/community/contributing/overview)](contribute-to-inkeep-open-source-project-communitycontributingoverview.md): How to contribute to the Inkeep Agent Framework - [Making a Contribution](making-a-contribution.md): Thank you for your interest in contributing to the Agent Framework! This document provides guidelines and information... - [Launch the Visual Builder](launch-the-visual-builder.md): Before getting started, ensure you have the following installed on your system: - [Push your project](push-your-project.md): A key advantage of the Inkeep agent framework is its seamless code-to-visual workflow: define your agents programmati... - [Set up live traces](set-up-live-traces.md): For full instructions, see [Traces](/get-started/traces). Short version: - [Set up credentials](set-up-credentials.md): For Nango setup (cloud or local), follow [Use Nango as a credential store](/typescript-sdk/credentials/nango). Short ... - [Development Workflow](development-workflow.md): This project uses Husky for Git hooks to maintain code quality. The hooks are automatically installed when you run`p... - [CLI Development](cli-development.md): When developing the CLI, you can run the local version directly without global installation: - [Run the local CLI from the repository root](run-the-local-cli-from-the-repository-root.md): node agents-cli/dist/index.js --version - [From repository root](from-repository-root.md): node agents-cli/dist/index.js push agents-cookbook/template-projects/weather-project - [Use local development version](use-local-development-version.md): node /path/to/agents/agents-cli/dist/index.js --version - [Use globally installed published version](use-globally-installed-published-version.md): inkeep --version - [Commit Messages](commit-messages.md): We recommend conventional commit format (not enforced by tooling): - [Pull Requests](pull-requests.md): 1. Fork the repository - [Continuous Integration](continuous-integration.md): Our CI pipeline runs on all pull requests and includes: - [AI coding assistants and coding practices](ai-coding-assistants-and-coding-practices.md): Many of our best coding practices for AI assistants live in`AGENTS.md`. We render it below for reference. - [Questions?](questions.md): If you have questions about contributing, please: - [Data Layer constraints on Project relationships (/community/contributing/project-constraints)](data-layer-constraints-on-project-relationships-communitycontributingproject-con.md): How the Inkeep Agent Framework ensures data integrity with project constraints - [Project Constraints and Validation](project-constraints-and-validation.md): The Inkeep Agent Framework implements multiple layers of validation to ensure that all agents and resources are assoc... - [Spans and Traces (/community/contributing/spans)](spans-and-traces-communitycontributingspans.md): OpenTelemetry spans for distributed tracing and observability in the Inkeep Agent Framework - [OpenTelemetry configuration](opentelemetry-configuration.md): OTEL_EXPORTER_OTLP_TRACES_ENDPOINT= - [A2A (/api-reference/a2a)](a2a-api-referencea2a.md): Agent-to-Agent communication endpoints - [Agents (/api-reference/agents)](agents-api-referenceagents.md): Operations for managing agents - [API Keys (/api-reference/api-keys)](api-keys-api-referenceapi-keys.md): Operations for managing API keys - [Artifact Components (/api-reference/artifact-components)](artifact-components-api-referenceartifact-components.md): Operations for managing artifact components - [Branches (/api-reference/branches)](branches-api-referencebranches.md): Operations for managing branches - [Chat (/api-reference/chat)](chat-api-referencechat.md): Chat completions endpoints - [CLI (/api-reference/cli)](cli-api-referencecli.md): CLI authentication endpoints - [Context Configs (/api-reference/context-configs)](context-configs-api-referencecontext-configs.md): Operations for managing context configurations - [Conversations (/api-reference/conversations)](conversations-api-referenceconversations.md): Operations for managing conversations - [Credential Stores (/api-reference/credential-stores)](credential-stores-api-referencecredential-stores.md): Operations for managing credential stores - [Credentials (/api-reference/credentials)](credentials-api-referencecredentials.md): Operations for managing credentials - [Data Components (/api-reference/data-components)](data-components-api-referencedata-components.md): Operations for managing data components - [Evaluations (/api-reference/evaluations)](evaluations-api-referenceevaluations.md): Operations for managing evaluations - [External Agents (/api-reference/external-agents)](external-agents-api-referenceexternal-agents.md): Operations for managing external agents - [Function Tools (/api-reference/function-tools)](function-tools-api-referencefunction-tools.md): Operations for managing function tools - [Functions (/api-reference/functions)](functions-api-referencefunctions.md): Operations for managing functions - [GitHub (/api-reference/github)](github-api-referencegithub.md): GitHub App integration endpoints - [Invitations (/api-reference/invitations)](invitations-api-referenceinvitations.md): Operations for managing invitations - [MCP Catalog (/api-reference/mcp-catalog)](mcp-catalog-api-referencemcp-catalog.md): Operations for MCP catalog - [MCP (/api-reference/mcp)](mcp-api-referencemcp.md): MCP (Model Context Protocol) endpoints - [OAuth (/api-reference/oauth)](oauth-api-referenceoauth.md): OAuth authentication endpoints - [Project Members (/api-reference/project-members)](project-members-api-referenceproject-members.md): Operations for managing project members - [Project Permissions (/api-reference/project-permissions)](project-permissions-api-referenceproject-permissions.md): Operations for managing project permissions - [Projects (/api-reference/projects)](projects-api-referenceprojects.md): Operations for managing projects - [Refs (/api-reference/refs)](refs-api-referencerefs.md): Operations for the resolved ref (branch name, tag name, or commit hash) - [SubAgents (/api-reference/subagents)](subagents-api-referencesubagents.md): Operations for managing sub agents - [Third-Party MCP Servers (/api-reference/third-party-mcp-servers)](third-party-mcp-servers-api-referencethird-party-mcp-servers.md): Operations for managing third-party MCP servers - [Tools (/api-reference/tools)](tools-api-referencetools.md): Operations for managing MCP tools - [Triggers (/api-reference/triggers)](triggers-api-referencetriggers.md): Operations for managing triggers - [User Organizations (/api-reference/user-organizations)](user-organizations-api-referenceuser-organizations.md): Operations for managing user organizations - [User Project Memberships (/api-reference/user-project-memberships)](user-project-memberships-api-referenceuser-project-memberships.md): Operations for managing user project memberships - [Webhooks (/api-reference/webhooks)](webhooks-api-referencewebhooks.md): Webhook endpoints - [Workflows (/api-reference/workflows)](workflows-api-referenceworkflows.md): Workflow trigger endpoints - [Configure Authentication (/deployment/authentication)](configure-authentication-deploymentauthentication.md): Set up authentication and authorization for user sign-in and team management - [Deploy to AWS EC2 (/deployment/aws-ec2)](deploy-to-aws-ec2-deploymentaws-ec2.md): Deploy to AWS EC2 with Docker Compose - [Replace these with your in production!](replace-these-with-your-vm-external-ip-in-production.md): NANGO_SERVER_URL= - [Modify these in production environments!](modify-these-in-production-environments.md): NANGO_DASHBOARD_USERNAME=admin@example.com - [Change to "production" if deploying to production](change-to-production-if-deploying-to-production.md): ENVIRONMENT=production - [AI Provider Keys (you need at least one)](ai-provider-keys-you-need-at-least-one.md): ANTHROPIC_API_KEY= - [Uncomment and set each of these with (openssl rand -hex 32)](uncomment-and-set-each-of-these-with-openssl-rand-hex-32.md): INKEEP_AGENTS_MANAGE_API_BYPASS_SECRET= - [Uncomment and set these for the Manage UI at http://:3000](uncomment-and-set-these-for-the-manage-ui-at-httpvm-external-ip3000.md): PUBLIC_INKEEP_AGENTS_MANAGE_API_URL= - [Better Auth secret (paste your generated secret)](better-auth-secret-paste-your-generated-secret.md): BETTER_AUTH_SECRET= - [Initial admin credentials](initial-admin-credentials.md): INKEEP_AGENTS_MANAGE_UI_USERNAME=admin@example.com - [SpiceDB connection, localhost. Can replace with cloud endpoint and preshared key](spicedb-connection-localhost-can-replace-with-cloud-endpoint-and-preshared-key.md): SPICEDB_ENDPOINT=localhost:50051 - [Build a Custom Docker Image (/deployment/docker-build)](build-a-custom-docker-image-deploymentdocker-build.md): How to build your own Docker images - [Deploy using Docker (Local Development) (/deployment/docker-local)](deploy-using-docker-local-development-deploymentdocker-local.md): * [Install Docker Desktop](https://www.docker.com/products/docker-desktop/) - [AI Provider Keys (you need at least one)](ai-provider-keys-you-need-at-least-one-2.md): ANTHROPIC_API_KEY= - [Better Auth secret (paste your generated secret)](better-auth-secret-paste-your-generated-secret-2.md): BETTER_AUTH_SECRET= - [Initial admin credentials](initial-admin-credentials-2.md): INKEEP_AGENTS_MANAGE_UI_USERNAME=admin@example.com - [SpiceDB connection, localhost. Can replace with cloud endpoint and preshared key](spicedb-connection-localhost-can-replace-with-cloud-endpoint-and-preshared-key-2.md): SPICEDB_ENDPOINT=localhost:50051 - [Deploy to GCP Cloud Run (/deployment/gcp-cloud-run)](deploy-to-gcp-cloud-run-deploymentgcp-cloud-run.md): Deploy to GCP Cloud Run with Docker Containers - [Deploy to GCP Compute Engine (/deployment/gcp-compute-engine)](deploy-to-gcp-compute-engine-deploymentgcp-compute-engine.md): Deploy to GCP Compute Engine with Docker Compose - [Add Docker's official GPG key:](add-dockers-official-gpg-key.md): sudo apt-get update - [Add the repository to Apt sources:](add-the-repository-to-apt-sources.md): echo \ - [Replace these with your in production!](replace-these-with-your-vm-external-ip-in-production-2.md): NANGO_SERVER_URL= - [Modify these in production environments!](modify-these-in-production-environments-2.md): NANGO_DASHBOARD_USERNAME=admin@example.com - [Change to "production" if deploying to production](change-to-production-if-deploying-to-production-2.md): ENVIRONMENT=production - [AI Provider Keys (you need at least one)](ai-provider-keys-you-need-at-least-one-3.md): ANTHROPIC_API_KEY= - [Uncomment and set each of these with (openssl rand -hex 32)](uncomment-and-set-each-of-these-with-openssl-rand-hex-32-2.md): INKEEP_AGENTS_MANAGE_API_BYPASS_SECRET= - [Uncomment and set these for the Manage UI at http://:3000](uncomment-and-set-these-for-the-manage-ui-at-httpvm-external-ip3000-2.md): PUBLIC_INKEEP_AGENTS_MANAGE_API_URL= - [Better Auth secret (paste your generated secret)](better-auth-secret-paste-your-generated-secret-3.md): BETTER_AUTH_SECRET= - [Initial admin credentials](initial-admin-credentials-3.md): INKEEP_AGENTS_MANAGE_UI_USERNAME=admin@example.com - [SpiceDB connection, localhost. Can replace with cloud endpoint and preshared key](spicedb-connection-localhost-can-replace-with-cloud-endpoint-and-preshared-key-3.md): SPICEDB_ENDPOINT=localhost:50051 - [Deploy to Hetzner (/deployment/hetzner)](deploy-to-hetzner-deploymenthetzner.md): Deploy to Hetzner with Docker Compose - [Add Docker's official GPG key:](add-dockers-official-gpg-key-2.md): sudo apt-get update - [Add the repository to Apt sources:](add-the-repository-to-apt-sources-2.md): echo \ - [Replace these with your in production!](replace-these-with-your-vm-external-ip-in-production-3.md): NANGO_SERVER_URL= - [Modify these in production environments!](modify-these-in-production-environments-3.md): NANGO_DASHBOARD_USERNAME=admin@example.com - [Change to "production" if deploying to production](change-to-production-if-deploying-to-production-3.md): ENVIRONMENT=production - [AI Provider Keys (you need at least one)](ai-provider-keys-you-need-at-least-one-4.md): ANTHROPIC_API_KEY= - [Uncomment and set each of these with (openssl rand -hex 32)](uncomment-and-set-each-of-these-with-openssl-rand-hex-32-3.md): INKEEP_AGENTS_MANAGE_API_BYPASS_SECRET= - [Uncomment and set these for the Manage UI at http://:3000](uncomment-and-set-these-for-the-manage-ui-at-httpvm-external-ip3000-3.md): PUBLIC_INKEEP_AGENTS_MANAGE_API_URL= - [Uncomment and set these to access Manage UI at http://:3000](uncomment-and-set-these-to-access-manage-ui-at-httpvm-external-ip3000.md): INKEEP_AGENTS_MANAGE_UI_USERNAME= - [Datadog (/deployment/add-other-services/datadog-apm)](datadog-deploymentadd-other-servicesdatadog-apm.md): Add Datadog APM to your Inkeep Agent Framework services - [Sentry (/deployment/add-other-services/sentry)](sentry-deploymentadd-other-servicessentry.md): Add Sentry monitoring to your agent services - [Get Started with Inkeep Cloud (/deployment/inkeep-cloud/get-started)](get-started-with-inkeep-cloud-deploymentinkeep-cloudget-started.md): Get started with Inkeep Cloud - [Overview](overview.md): With Inkeep Cloud, we manage the infrastructure for you so you can focus on building your agents. In this guide, will... - [User-Level vs Project-Level MCP Servers (/deployment/inkeep-cloud/user-vs-project-mcp)](user-level-vs-project-level-mcp-servers-deploymentinkeep-clouduser-vs-project-mc.md): Understand the difference between user-level and project-level MCP servers and how they affect your team workflow - [Overview (/talk-to-your-agents)](overview-talk-to-your-agents.md): Pre-built chat components to integrate Inkeep agents into your application - [Build chat UIs with Vercel AI Elements (/talk-to-your-agents/vercel-ai-sdk/ai-elements)](build-chat-uis-with-vercel-ai-elements-talk-to-your-agentsvercel-ai-sdkai-elemen.md): Use Vercel AI Elements to quickly assemble production-ready chat interfaces that connect to your Inkeep agent. - [Use Inkeep agents with Vercel AI SDK (/talk-to-your-agents/vercel-ai-sdk/inkeep-provider)](use-inkeep-agents-with-vercel-ai-sdk-talk-to-your-agentsvercel-ai-sdkinkeep-prov.md): A custom AI SDK provider that lets you use Inkeep agents with generateText, streamText, and other AI SDK functions. - [Create custom UIs using the Vercel AI SDK (/talk-to-your-agents/vercel-ai-sdk/use-chat)](create-custom-uis-using-the-vercel-ai-sdk-talk-to-your-agentsvercel-ai-sdkuse-ch.md): Use the Vercel AI SDK's useChat hook to build React chat interfaces that stream responses from your agent. - [Build a fact finder agent with code (/tutorials/agents/fact-finder)](build-a-fact-finder-agent-with-code-tutorialsagentsfact-finder.md): In this tutorial, you'll build a fact finder agent using code and the Inkeep SDK. When you ask "What is Inkeep?", the... - [Build a meeting prep agent without code (/tutorials/agents/meeting-prep-assistant)](build-a-meeting-prep-agent-without-code-tutorialsagentsmeeting-prep-assistant.md): In this tutorial, you'll build a meeting prep assistant agent using the Inkeep Visual Builder. When you ask "Can you ... - [CLI Tutorials (/tutorials/cli/overview)](cli-tutorials-tutorialsclioverview.md): Learn how to use the Inkeep CLI for common workflows - [Push to Inkeep Cloud (/tutorials/cli/push-to-cloud)](push-to-inkeep-cloud-tutorialsclipush-to-cloud.md): Set up a profile, authenticate, and push your agents to Inkeep Cloud - [Leverage Composio MCP Server Library (/tutorials/mcp-servers/composio-mcp-servers)](leverage-composio-mcp-server-library-tutorialsmcp-serverscomposio-mcp-servers.md): Connect to Composio MCP servers for access to 10,000+ out-of-box integrations - [Build Custom MCP Servers (/tutorials/mcp-servers/custom-mcp-servers)](build-custom-mcp-servers-tutorialsmcp-serverscustom-mcp-servers.md): Build your own custom MCP servers - [Create an OpenAPI-based MCP server (/tutorials/mcp-servers/gram)](create-an-openapi-based-mcp-server-tutorialsmcp-serversgram.md): Gram by Speakeasy turns any OpenAPI specification into a production-ready MCP server. Upload your API spec, and Gram ... - [Connect to Native MCP Servers (/tutorials/mcp-servers/native-mcp-servers)](connect-to-native-mcp-servers-tutorialsmcp-serversnative-mcp-servers.md): Connect to Native MCP servers provided by SaaS vendors - [MCP Server Options (/tutorials/mcp-servers/overview)](mcp-server-options-tutorialsmcp-serversoverview.md): Learn about the recommended ways to use MCP servers with your agents - [CLI Observability with Langfuse (/typescript-sdk/cli-observability)](cli-observability-with-langfuse-typescript-sdkcli-observability.md): Track LLM operations during pull command with Langfuse - [Your Langfuse credentials](your-langfuse-credentials.md): LANGFUSE_SECRET_KEY=sk-lf-your-secret-key-here - [Langfuse API URL (defaults to EU cloud)](langfuse-api-url-defaults-to-eu-cloud.md): LANGFUSE_BASEURL= # or for US - [Your LLM provider API keys (at least one required)](your-llm-provider-api-keys-at-least-one-required.md): ANTHROPIC_API_KEY=your-anthropic-key - [Should output: true](should-output-true.md): echo $LANGFUSE_ENABLED - [Should show your keys (without exposing them)](should-show-your-keys-without-exposing-them.md): env | grep LANGFUSE - [Run with debug logging](run-with-debug-logging.md): DEBUG=* inkeep pull --project my-project - [Use your self-hosted instance](use-your-self-hosted-instance.md): LANGFUSE_BASEURL= - [Using Langfuse for LLM Observability (/typescript-sdk/langfuse-usage)](using-langfuse-for-llm-observability-typescript-sdklangfuse-usage.md): Complete guide to using Langfuse for LLM observability, tracing, and analytics in the Inkeep Agent Framework - [Langfuse configuration (required for both scripts)](langfuse-configuration-required-for-both-scripts.md): LANGFUSE_PUBLIC_KEY=your_langfuse_public_key - [Chat API configuration (for dataset runner)](chat-api-configuration-for-dataset-runner.md): INKEEP_AGENTS_RUN_API_KEY=your_api_key - [Execution context (for dataset runner)](execution-context-for-dataset-runner.md): INKEEP_TENANT_ID=your_tenant_id - [Using SigNoz for Observability (/typescript-sdk/signoz-usage)](using-signoz-for-observability-typescript-sdksignoz-usage.md): Complete guide to using SigNoz for observability, monitoring, tracing in the Inkeep Agent Framework - [Filter by service](filter-by-service.md): service_name = "inkeep-agents-run-api" - [Filter by operation](filter-by-operation.md): operation = "agent.generate" - [Filter by custom attributes](filter-by-custom-attributes.md): agent.id = "customer-support-agent" - [Environment-aware Credentials (/typescript-sdk/credentials/env-aware-credentials)](environment-aware-credentials-typescript-sdkcredentialsenv-aware-credentials.md): Environment-aware credentials enable automatic loading of environment-specific credentials (development, production, ... - [Set environment name via environment variable](set-environment-name-via-environment-variable.md): export INKEEP_ENV=production - [Override via CLI (takes precedence)](override-via-cli-takes-precedence.md): inkeep push --env development # Uses development instead - [Use Environment Variables as Credentials (/typescript-sdk/credentials/environment-variables)](use-environment-variables-as-credentials-typescript-sdkcredentialsenvironment-va.md): Environment variables are a simple way to store credentials in your environment. They are stored in the environment v... - [Use Keychain for Local Development (/typescript-sdk/credentials/keychain)](use-keychain-for-local-development-typescript-sdkcredentialskeychain.md): Keychain is the default method for storing credentials for every project. It is a locally stored credential store for... - [Use Nango as a Credential Store (/typescript-sdk/credentials/nango)](use-nango-as-a-credential-store-typescript-sdkcredentialsnango.md): Nango is an excellent choice for both development and production environments, particularly when working with OAuth2.... - [Credential Store Options (/typescript-sdk/credentials/overview)](credential-store-options-typescript-sdkcredentialsoverview.md): MCP servers and external agents may require authentication for secure access. The Inkeep agent framework supports sto... - [Artifact Components (/typescript-sdk/structured-outputs/artifact-components)](artifact-components-typescript-sdkstructured-outputsartifact-components.md): Learn how to use artifact components to store and retrieve data from the agent - [Create Rich UI Blocks with Data Components (/typescript-sdk/structured-outputs/data-components)](create-rich-ui-blocks-with-data-components-typescript-sdkstructured-outputsdata-.md): Learn how to create and use data components for rich, interactive Agent messages. - [Status Updates (/typescript-sdk/structured-outputs/status-updates)](status-updates-typescript-sdkstructured-outputsstatus-updates.md): Real-time progress updates powered by AI that keep users informed during long-running agent operations - [Status Updates](status-updates.md): The Inkeep Agent Framework provides intelligent, AI-powered status updates that automatically generate contextual pro... - [Function Tools (/typescript-sdk/tools/function-tools)](function-tools-typescript-sdktoolsfunction-tools.md): Create custom JavaScript functions that your agents can execute in secure sandboxes - [Register MCP Servers as Tools (/typescript-sdk/tools/mcp-tools)](register-mcp-servers-as-tools-typescript-sdktoolsmcp-tools.md): Learn how to add and configure MCP tools for your agents - [Tool approvals (/typescript-sdk/tools/tool-approvals)](tool-approvals-typescript-sdktoolstool-approvals.md): Require explicit user approval before running selected tools. - [Artifact Components (/visual-builder/structured-outputs/artifact-components)](artifact-components-visual-builderstructured-outputsartifact-components.md): Artifact components are used to add artifacts to the Agent. - [Create Rich UI Blocks with Data Components (/visual-builder/structured-outputs/data-components)](create-rich-ui-blocks-with-data-components-visual-builderstructured-outputsdata-.md): Learn how to create and use data components for rich, interactive Agent messages. - [Status Components (/visual-builder/structured-outputs/status-components)](status-components-visual-builderstructured-outputsstatus-components.md): Configure intelligent status updates using structured components in the Visual Builder - [Manage Credentials in Visual Builder (/visual-builder/tools/credentials)](manage-credentials-in-visual-builder-visual-buildertoolscredentials.md): Credentials are used to authenticate MCP servers. - [Function Tools (/visual-builder/tools/function-tools)](function-tools-visual-buildertoolsfunction-tools.md): Create custom JavaScript functions that your agents can execute directly in the Visual Builder - [Register MCP Servers in Visual Builder (/visual-builder/tools/mcp-servers)](register-mcp-servers-in-visual-builder-visual-buildertoolsmcp-servers.md): Create MCP servers that agents can use to access external services. - [Tool approvals in Visual Builder (/visual-builder/tools/tool-approvals)](tool-approvals-in-visual-builder-visual-buildertoolstool-approvals.md): Require explicit user approval before running selected tools. - [Style Components (/talk-to-your-agents/customization/styling)](style-components-talk-to-your-agentscustomizationstyling.md): Customize the appearance of Inkeep's components. - [Chat Button (/talk-to-your-agents/react/chat-button)](chat-button-talk-to-your-agentsreactchat-button.md): Learn how to use the chat button component in React - [Custom Trigger (/talk-to-your-agents/react/custom-trigger)](custom-trigger-talk-to-your-agentsreactcustom-trigger.md): Create custom UI elements to trigger Inkeep modals with complete control over appearance and behavior. - [Embedded Chat (/talk-to-your-agents/react/embedded-chat)](embedded-chat-talk-to-your-agentsreactembedded-chat.md): Integrate Inkeep's embedded chat component directly into your React application for inline agent conversations. - [Add Sidebar Chat to React (/talk-to-your-agents/react/side-bar-chat)](add-sidebar-chat-to-react-talk-to-your-agentsreactside-bar-chat.md): Integrate Inkeep's sidebar chat component into your React application for seamless agent conversations. - [Chat Button (/talk-to-your-agents/javascript/chat-button)](chat-button-talk-to-your-agentsjavascriptchat-button.md): Learn how to use the chat button component in JavaScript - [Custom Trigger (/talk-to-your-agents/javascript/custom-trigger)](custom-trigger-talk-to-your-agentsjavascriptcustom-trigger.md): Create custom UI elements to trigger Inkeep modals with complete control over appearance and behavior in JavaScript. - [Embedded Chat (/talk-to-your-agents/javascript/embedded-chat)](embedded-chat-talk-to-your-agentsjavascriptembedded-chat.md): Integrate Inkeep's embedded chat component directly into your React application for inline agent conversations. - [Add Sidebar Chat to React (/talk-to-your-agents/javascript/side-bar-chat)](add-sidebar-chat-to-react-talk-to-your-agentsjavascriptside-bar-chat.md): Integrate Inkeep's sidebar chat component into your React application for seamless agent conversations.