API Keys

Flock uses DuckDB’s Secrets Manager to securely store and manage sensitive information like API keys and credentials. Secrets are typed by service provider and can be temporary ( in-memory) or persistent (on-disk).

1. Types of Secrets

Supported secret types for Flock:

OpenAI
Ollama
Azure
Anthropic

2. Creating a Secret

Secrets can be created with the CREATE SECRET SQL command. Temporary secrets are stored in memory, while persistent secrets are stored on disk. If no secret name is provided, DuckDB automatically assigns a default provider name.

2.1 OpenAI API Key

CREATE SECRET (
    TYPE OPENAI,
    API_KEY 'your-api-key'
);

This creates a secret named __default_openai.

2.2 Ollama API URL

CREATE SECRET (
    TYPE OLLAMA,
    API_URL '127.0.0.1:11434'
);

This creates a secret named __default_ollama.

2.3 Azure API Configuration

CREATE SECRET (
    TYPE AZURE_LLM,
    API_KEY 'your-key-here',
    RESOURCE_NAME 'resource-name',
    API_VERSION 'api-version'
);

This creates a secret named __default_azure.

2.4 Anthropic API Key

-- API key only (uses default API version 2023-06-01)
CREATE SECRET (
    TYPE ANTHROPIC,
    API_KEY 'your-api-key'
);

-- With optional custom API version
CREATE SECRET (
    TYPE ANTHROPIC,
    API_KEY 'your-api-key',
    API_VERSION '2024-01-01'
);

This creates a secret named __default_anthropic. The API_VERSION parameter is optional.

3. Persistent Secrets

To persist secrets across DuckDB sessions, use CREATE PERSISTENT SECRET:

3.1 Example for OpenAI (Persistent):

CREATE PERSISTENT SECRET (
    TYPE OPENAI,
    API_KEY 'your-api-key'
);

3.2 Example for Ollama (Persistent):

CREATE PERSISTENT SECRET (
    TYPE OLLAMA,
    API_URL '127.0.0.1:11434'
);

3.3 Example for Azure (Persistent):

CREATE PERSISTENT SECRET (
    TYPE AZURE_LLM,
    API_KEY 'your-key-here',
    RESOURCE_NAME 'resource-name',
    API_VERSION 'api-version'
);

3.4 Example for Anthropic (Persistent):

CREATE PERSISTENT SECRET (
    TYPE ANTHROPIC,
    API_KEY 'your-api-key'
);

Optionally add API_VERSION '2024-01-01' to use a custom API version.

4. Deleting Secrets

To delete a secret, use the DROP SECRET command. For default provider secrets, the name will follow the pattern __default_<provider_name>.

4.1 Deleting Temporary Secrets

To delete a temporary secret, use:

DROP TEMPORARY SECRET your_secret_name;

For default provider secrets, the name will be in the format __default_<provider_name>, e.g., __default_openai, __default_ollama, __default_azure, or __default_anthropic. Example for deleting a default temporary OpenAI secret:

DROP TEMPORARY SECRET __default_openai;

4.2 Deleting Persistent Secrets

To delete a persistent secret, use:

DROP PERSISTENT SECRET your_secret_name;

DROP PERSISTENT SECRET __default_openai;

5. Listing Secrets

To list all secrets:

FROM duckdb_secrets();

Home

Getting Started

Resource Management

Scalar Functions

Aggregate Functions

Hybrid Search

Operations

Contributing

1. Types of Secrets

2. Creating a Secret

2.1 OpenAI API Key

2.2 Ollama API URL

2.3 Azure API Configuration

2.4 Anthropic API Key

3. Persistent Secrets

3.1 Example for OpenAI (Persistent):

3.2 Example for Ollama (Persistent):

3.3 Example for Azure (Persistent):

3.4 Example for Anthropic (Persistent):

4. Deleting Secrets

4.1 Deleting Temporary Secrets

4.2 Deleting Persistent Secrets

5. Listing Secrets

​1. Types of Secrets

​2. Creating a Secret

​2.1 OpenAI API Key

​2.2 Ollama API URL

​2.3 Azure API Configuration

​2.4 Anthropic API Key

​3. Persistent Secrets

​3.1 Example for OpenAI (Persistent):

​3.2 Example for Ollama (Persistent):

​3.3 Example for Azure (Persistent):

​3.4 Example for Anthropic (Persistent):

​4. Deleting Secrets

​4.1 Deleting Temporary Secrets

​4.2 Deleting Persistent Secrets

​5. Listing Secrets

1. Types of Secrets

2. Creating a Secret

2.1 OpenAI API Key

2.2 Ollama API URL

2.3 Azure API Configuration

2.4 Anthropic API Key

3. Persistent Secrets

3.1 Example for OpenAI (Persistent):

3.2 Example for Ollama (Persistent):

3.3 Example for Azure (Persistent):

3.4 Example for Anthropic (Persistent):

4. Deleting Secrets

4.1 Deleting Temporary Secrets

4.2 Deleting Persistent Secrets

5. Listing Secrets