---
title: "openvibe-sdk/credentials · OpenVibe.Services"
canonical: "https://openvibe.services/docs/sdk/credentials"
updated: null
---

# openvibe-sdk/credentials · OpenVibe.Services

HTML: [openvibe-sdk/credentials · OpenVibe.Services](https://openvibe.services/docs/sdk/credentials)

# `openvibe-sdk/credentials`

Generated at 2026-11-13 06:25:48 UTC from [`openvibe-contracts v0.419.0`](https://github.com/OpenVibers/OpenVibe.Contracts/tree/v0.419.0) and [`openvibe-sdk v0.161.0`](https://github.com/OpenVibers/OpenVibe.SDK/tree/v0.161.0).

From `types/credentials.d.ts` (browser build available). Declarations are shown verbatim.

## interface CredentialMetadata

~~~~
export interface CredentialMetadata {
    id: string;
    kind: 'api_key' | 'admin_key' | 'session_cookie';
    provider: string;
    label?: string;
    created?: string;
    last_used?: string | null;
    expires?: string | null;
    expired?: boolean;
}
~~~~

## interface SessionCookieInput

~~~~
export interface SessionCookieInput {
    kind?: 'session_cookie';
    provider: 'anthropic' | 'openai';
    cookie: string;
    label?: string;
    expires_at?: string;
    /** Anthropic organization identifier; not a secret. */
    org_id?: string;
}
~~~~

## interface ApiKeyInput

~~~~
export interface ApiKeyInput { kind?: 'api_key'; provider: string; key: string; label?: string; base_url?: string; }
~~~~

## interface CredentialsClient

~~~~
export interface CredentialsClient {
    list(options?: { signal?: AbortSignal }): Promise<{ credentials: CredentialMetadata[] }>;
    add(credential: SessionCookieInput | ApiKeyInput, options?: { signal?: AbortSignal }): Promise<{ credential: CredentialMetadata }>;
    remove(id: string, options?: { signal?: AbortSignal }): Promise<void>;
    balance(id: string, options?: { signal?: AbortSignal }): Promise<{ balance: { credential: CredentialMetadata; source: string; at: string; values: Record<string, unknown> } }>;
}
~~~~

## export export function createCredentialsClient(client: unknown, def

~~~~
export function createCredentialsClient(client: unknown, defaults?: { baseUrl?: string }): CredentialsClient;
~~~~