Auth

Bill an Agent against a subscription seat instead of an API key.

auth tells an Agent to bill a run against a subscription seat rather than an API key.

Quick Start

1. Pick a provider

   import { Agent } from 'praisonai';
   
   const agent = new Agent({
     instructions: 'You are helpful',
     auth: 'claude-code',
   });
   const reply = await agent.chat('Hello');

2. Let auth choose the model

   Omit llm and auth picks the provider’s default model, so a subscription token never ships to the wrong endpoint.

Default models

When you pass auth without an llm, the agent uses the provider’s default model.

How it works

The credentials are resolved once on the first turn, then every outgoing request is sent through a fetch wrapper that adds the provider’s headers. Existing headers on a request win, so you can still override one deliberately.

Because a subscription seat belongs to one vendor, auth also pins the default model — falling back to API-key billing would charge the wrong account, so an unregistered provider fails at construction rather than at request time.

When it throws

import { Agent } from 'praisonai';

new Agent({ instructions: 'Hi', auth: 'not-a-provider' });
// Error: Unknown subscription provider 'not-a-provider'. Registered: (none).
//   A subscription store is a host concern: register one with
//   registerAuthProvider('not-a-provider', resolver).

Leaf import for bundle-sensitive callers

resolveAuth, registerAuthProvider, listAuthProviders, resetAuthProviders, and the LLMAuth, LLMAuthResolver, and LLMAuthSource types can be imported from 'praisonai', 'praisonai/llm', or the leaf module 'praisonai/llm/auth'. All three resolve to the same names — PraisonAI PR #4874 moved the implementation into llm/auth.ts and re-exports it, so the public API is unchanged.

// Any of these work — same names, same behaviour
import { registerAuthProvider } from 'praisonai';
import { registerAuthProvider } from 'praisonai/llm';
import { registerAuthProvider } from 'praisonai/llm/auth';

Related