Struct StakpakApiClient 

pub struct StakpakApiClient { /* private fields */ }

Client for Stakpak’s non-inference APIs

Implementations

impl StakpakApiClient

pub fn new(config: &StakpakApiConfig) -> Result<Self, String>

Create a new StakpakApiClient

pub async fn create_session( &self, req: &CreateSessionRequest, ) -> Result<CreateSessionResponse, String>

Create a new session

pub async fn create_checkpoint( &self, session_id: Uuid, req: &CreateCheckpointRequest, ) -> Result<CreateCheckpointResponse, String>

Create a checkpoint for a session

pub async fn list_sessions( &self, query: &ListSessionsQuery, ) -> Result<ListSessionsResponse, String>

List sessions

pub async fn get_session(&self, id: Uuid) -> Result<GetSessionResponse, String>

Get a session by ID

pub async fn update_session( &self, id: Uuid, req: &UpdateSessionRequest, ) -> Result<UpdateSessionResponse, String>

Update a session

pub async fn delete_session(&self, id: Uuid) -> Result<(), String>

Delete a session

pub async fn list_checkpoints( &self, session_id: Uuid, query: &ListCheckpointsQuery, ) -> Result<ListCheckpointsResponse, String>

List checkpoints for a session

pub async fn get_checkpoint( &self, id: Uuid, ) -> Result<GetCheckpointResponse, String>

Get a checkpoint by ID

pub async fn cancel_request(&self, request_id: &str) -> Result<(), String>

Cancel an active inference request

pub async fn get_account(&self) -> Result<GetMyAccountResponse, String>

Get the current user’s account info

pub async fn get_billing( &self, username: &str, ) -> Result<BillingResponse, String>

Get billing info for a user

pub async fn list_rulebooks(&self) -> Result<Vec<ListRuleBook>, String>

List all rulebooks

pub async fn get_rulebook_by_uri(&self, uri: &str) -> Result<RuleBook, String>

Get a rulebook by URI

pub async fn create_rulebook( &self, input: &CreateRuleBookInput, ) -> Result<CreateRuleBookResponse, String>

Create a new rulebook

pub async fn delete_rulebook(&self, uri: &str) -> Result<(), String>

Delete a rulebook

pub async fn search_docs( &self, req: &SearchDocsRequest, ) -> Result<Vec<Content>, String>

Search documentation

pub async fn search_memory( &self, req: &SearchMemoryRequest, ) -> Result<Vec<Content>, String>

Search memory

pub async fn memorize_session(&self, checkpoint_id: Uuid) -> Result<(), String>

Memorize a session checkpoint (extract memory)

pub async fn slack_read_messages( &self, req: &SlackReadMessagesRequest, ) -> Result<Vec<Content>, String>

Read Slack messages from a channel

pub async fn slack_read_replies( &self, req: &SlackReadRepliesRequest, ) -> Result<Vec<Content>, String>

Read Slack thread replies

pub async fn slack_send_message( &self, req: &SlackSendMessageRequest, ) -> Result<Vec<Content>, String>

Send a Slack message

impl StakpakApiClient

pub async fn read_knowledge_file( &self, path: &str, ) -> Result<Vec<u8>, KnowledgeApiError>

Read a knowledge file. Uses the on-disk cache at ~/.stakpak/remote-knowledge/<account>/<path> together with the server’s If-None-Match support to avoid re-downloading unchanged content.

pub async fn peek_knowledge_file( &self, path: &str, max_bytes: usize, ) -> Result<Vec<u8>, KnowledgeApiError>

Read at most the first max_bytes of a knowledge file. The server supports a peek query parameter that returns a compact preview; if the response exceeds max_bytes we truncate client-side.

Peek requests bypass the on-disk cache because they share the path with full reads but return a different body.

pub async fn knowledge_file_exists( &self, path: &str, ) -> Result<bool, KnowledgeApiError>

Cheap existence check using HTTP HEAD. Does not transfer the body.

pub async fn list_knowledge_files( &self, query: &ListKnowledgeFilesQuery, ) -> Result<ListKnowledgeFilesResponse, KnowledgeApiError>

List knowledge files with optional filtering. Bypasses the on-disk cache (no ETag mechanism for list responses).

pub async fn create_knowledge_file( &self, path: &str, content: &[u8], ) -> Result<CreateKnowledgeFileResponse, KnowledgeApiError>

Create a new knowledge file. Returns Conflict if a file already exists at the target path.

The cache is not populated here: the local cache only holds bodies that came from a GET /v1/knowledge/... so we know the cached SHA matches the server’s ETag. The next read will populate it.

pub async fn overwrite_knowledge_file( &self, path: &str, content: &[u8], ) -> Result<UpdateKnowledgeFileResponse, KnowledgeApiError>

Overwrite an existing knowledge file (or create if not exists).

The cache is not populated here. Any stale local copy will be revalidated on the next read: If-None-Match will miss against the new server ETag and the client will refetch + replace the cached body.

pub async fn delete_knowledge_file( &self, path: &str, ) -> Result<(), KnowledgeApiError>

Delete a knowledge file or directory. On success, evicts the matching cache entry (file or directory tree).

Trait Implementations

impl Clone for StakpakApiClient

fn clone(&self) -> StakpakApiClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StakpakApiClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.