Rust SDK overview

Package facts

Add it with:

cargo add brain-db-sdk

Everything in this section imports from the brain_db_sdk crate root or its http / wire submodules:

use brain_db_sdk::{Auth, BrainClient, BrainHttpClient};

Two clients

Brain has no single canonical transport for the SDK — it depends on what you need.

Which one to use

• Use BrainHttpClient when you are calling the hosted edge or gateway and only need the memory verbs (encode / recall / forget and the graph reasoning helpers). It is a thin reqwest client with built-in retry.
• Use BrainClient when you self-host and need the typed graph, transactions, subscriptions, or the streaming list/traverse verbs — or when you want a single connection multiplexing many in-flight requests.

Quickstart

Connect to the hosted edge, write a memory, and recall it:

use brain_db_sdk::BrainHttpClient;
use brain_db_sdk::http::{EncodeInput, RecallInput};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // base_url first, then the API key.
    let client = BrainHttpClient::new("https://api.arc-labs.ai", "my-api-key");

    let stored = client
        .encode(&EncodeInput {
            text: "Ada prefers dark mode and lives in Berlin.".to_string(),
            ..Default::default()
        })
        .await?;
    println!("stored memory {} (deduped: {})", stored.memory_id, stored.was_deduplicated);

    let answer = client
        .recall(&RecallInput {
            query: "where does Ada live?".to_string(),
            max_results: Some(5),
            ..Default::default()
        })
        .await?;
    println!("{}: {} memories", answer.answer_kind, answer.memories.len());
    Ok(())
}

Recall is not top-k

recall answers the way a memory does, not the way a search index does. The result carries an answer_kind reporting the shape of the answer:

• None — nothing matched. Brain returns an explicit empty answer rather than fabricating one.
• Single — one memory answers the cue.
• Many — several memories are relevant.

Over HTTP answer_kind is a string; over the wire it is the AnswerKindWire enum. See Recall for how to branch on it.

Section map