Quickstart

This guide will help you make your first Web API request to DeepFellow.

To use DeepFellow, you need DeepFellow CLI, DeepFellow Server, and DeepFellow Infra - follow Installation guide.

Introduction

To make any requests to DeepFellow, you need an API Key. There are two kinds of API Keys:

organization API Key
project API Key

Both organization and project API Keys are accepted by DeepFellow.

Organizations and projects provide a way to organize, manage, and monitor your work. You can have multiple organizations. Projects are smaller units that have to be assigned to an organization.

Each project is a separate space where you can add files, create vector stores, and allow certain models or endpoints to be called. Resources from one project cannot be accessed with different project's API Key.

In the same way, resources of one organization cannot be accessed with another organization's API Key.

Read the guide to Organizations and Projects to learn more.

Create Organization and Project

First, create an organization by typing in your terminal:

deepfellow server organization create

Follow the instructions to create your first organization.

Then, create a project:

deepfellow server project create

Again, follow the instructions.

To confirm successful operations type:

deepfellow server organization list
deepfellow server project list

Create project API key:

deepfellow server project api-key create

Copy and save the API Key – you can't access it again.

You can create organizations and projects using Web Panel as well. See DeepFellow Server Web Panel guide for details.

Make First Request

curl -X 'POST' \
  'https://deepfellow-server-host/v1/completions' \
  -H 'Authorization: Bearer YOUR_PROJECT_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "model": "gemma3:1b",
  "prompt": "Hello World",
}'

import requests

response = requests.post(
    'https://deepfellow-server-host/v1/completions',
    json={
      "model": "gemma3:1b",
      "prompt": "Hello World",
    },
    headers={
        "Content-Type": "application/json",
        "Authorization": "Bearer DEEPFELLOW-PROJECT-API-KEY"
    }
)

data = response.json()
print(data)

const response = await fetch('https://deepfellow-server-host/v1/completions', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        Authorization: 'Bearer DEEPFELLOW-PROJECT-API-KEY'
    },
    body: JSON.stringify({
        model: 'gemma3:1b',
        prompt: 'Hello World'
    })
});

const data = await response.json();
console.log(data);

You will get a response similar to this:

{
  "id": "cmpl-695",
  "object": "text_completion",
  "created": 1759940689,
  "model": "gemma3:1b",
  "system_fingerprint": "fp_ollama",
  "choices": [
    {
      "text": "Hello there! How can I help you today? 😊",
      "index": 0,
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 11,
    "completion_tokens": 12,
    "total_tokens": 23
  }

Introduction

Create Organization and Project

Make First Request

Further Reading

On this page