Functor Logo
GitHub

Quick Start

Get started with Functor in 5 minutes. This guide will walk you through installation, authentication, and your first query.

Prerequisites

Before you begin, make sure you have:
1

Get API Key

Access your API key from the Functor platform. If you don't have one yet, see the Authentication Guide.

API Keys Management

Create and manage your API keys

Functor Platform

Access the Functor webapp

2

Choose SDK

Select the SDK that best fits your project needs and tech stack.

Functor SDK

Official Python SDK for REST API access with sync/async support

MCP SDK

Model Context Protocol client for agent integration

3

Install SDK

# Install via pip
pip install functor-sdk


# Or via uv (faster)
uv pip install functor-sdk
4

Set Up Authentication

Configure your API key using one of these methods:

# Set environment variables
export FUNCTOR_API_KEY=your-api-key-here
export FUNCTOR_BASE_URL=http://localhost:8000
5

Make Your First API Call

After preparing your API key and installing the SDK, you can start making API calls:

from functor_sdk import FunctorClient


# Initialize client (uses environment variables)
client = FunctorClient()


# Execute a query
result = client.queries.execute("What is machine learning?")


# Display results
print(f"Answer: {result.answer}")
print(f"Citations: {len(result.citations)}")

Next Steps

Functor SDK Documentation

Comprehensive Python SDK for REST API access with sync/async support

MCP SDK Documentation

Model Context Protocol client for agent integration with LangChain and CAMEL-AI

API Reference

Complete REST API documentation for all endpoints and parameters

Basic Concepts

Deep dive into knowledge graphs, memory systems, and agents