API Reference
Agents Adapters

Agents Adapters API Reference

Full API for @veridex/agents-adapters — import, export, and bridge agents across frameworks.


Framework Adapters

All adapters implement the FrameworkAdapter interface:

interface FrameworkAdapter<TImport, TExport> {
  importAgent(config: TImport): { definition: AgentDefinition; warnings: string[] };
  exportAgent(definition: AgentDefinition): { config: TExport; warnings: string[] };
}

OpenAIAgentsAdapter

import { OpenAIAgentsAdapter } from '@veridex/agents-adapters';
 
const adapter = new OpenAIAgentsAdapter();
const { definition, warnings } = adapter.importAgent(openAIConfig);
const { config } = adapter.exportAgent(definition);

LangGraphAdapter

import { LangGraphAdapter } from '@veridex/agents-adapters';
 
const adapter = new LangGraphAdapter();
const { definition, warnings } = adapter.importAgent(langGraphConfig);
const { config } = adapter.exportAgent(definition);

PydanticAIAdapter

import { PydanticAIAdapter } from '@veridex/agents-adapters';
 
const adapter = new PydanticAIAdapter();
const { definition, warnings } = adapter.importAgent(pydanticAIConfig);
const { config } = adapter.exportAgent(definition);

OpenAPIImporter

Convert OpenAPI 3.x specifications into Veridex ToolContract objects.

import { OpenAPIImporter } from '@veridex/agents-adapters';
 
const importer = new OpenAPIImporter();

importer.importTools(spec, options)

const tools: ToolContract[] = importer.importTools(spec, {
  baseUrl: string,
  auth?: { type: 'bearer' | 'api-key'; value: string; header?: string },
  safetyClassOverrides?: Record<string, ToolSafetyClass>,
});

Each path + method combination becomes a ToolContract with:

  • Name derived from operationId or path
  • Zod input schema generated from request body / query parameters
  • Safety class inferred from HTTP method (GETread, POSTwrite, DELETEdestructive)

Runtime Bridges

Live bridges invoke external runtimes as Veridex tools or handoff targets.

OpenAIRuntimeBridge

import { OpenAIRuntimeBridge } from '@veridex/agents-adapters';
 
const bridge = new OpenAIRuntimeBridge({
  name: string,
  endpoint: string,
  apiKey: string,
  timeoutMs?: number,
});
 
const tool = bridge.asTool({ name: string, description?: string });
const handler = bridge.asHandoffHandler();

LangGraphRuntimeBridge

import { LangGraphRuntimeBridge } from '@veridex/agents-adapters';
 
const bridge = new LangGraphRuntimeBridge({
  name: string,
  endpoint: string,
  apiKey?: string,
});

PydanticAIRuntimeBridge

import { PydanticAIRuntimeBridge } from '@veridex/agents-adapters';
 
const bridge = new PydanticAIRuntimeBridge({
  name: string,
  endpoint: string,
  apiKey?: string,
});

Capability Binding

AgentCapabilityBinder

import { AgentCapabilityBinder } from '@veridex/agents-adapters';
 
const binder = new AgentCapabilityBinder();
const boundTools: ToolContract[] = binder.bind(importedTools);

inferSafetyClass

import { inferSafetyClass } from '@veridex/agents-adapters';
 
const safetyClass: ToolSafetyClass = inferSafetyClass(toolDefinition);

Heuristic inference based on tool name, description, and schema analysis.


Utilities

jsonSchemaToZod

import { jsonSchemaToZod } from '@veridex/agents-adapters';
 
const zodSchema = jsonSchemaToZod(jsonSchemaObject);

Converts a JSON Schema object to a Zod schema for ToolContract input validation.

createStubExecutor

import { createStubExecutor } from '@veridex/agents-adapters';
 
const executor = createStubExecutor(toolName);

Creates a stub executor that returns a placeholder result, useful for testing imported tools.