Skip to content
Prefactor Docs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Prefactor Platform
Overview
API Reference
Agents
Overview
Agents Page
Instances
Versions
Activity Schemas
Instance Details
Instance Activity
Account
Details
Team
Invites
API Tokens
Environments
OpenAPI Spec
Overview
Account
List accounts (internal)
GET
Fetch account
GET
Update an account
PUT
Implode (delete) the account you are authenticated as
POST
AdminUser
List admin users for an account
GET
Fetch admin user details
GET
AdminUserInvite
List admin user invites for an account
GET
Create a new admin user invite
POST
Fetch admin user invite details
GET
Revoke an admin user invite
POST
Agent
List agents
GET
Create a new agent
POST
Fetch agent
GET
Update an agent
PUT
Delete an agent
DELETE
Reinstate a retired agent
POST
Retire an agent
POST
AgentInstance
List agent instances
GET
Register a new agent instance with agent version
POST
Fetch agent instance
GET
Finish an agent instance
POST
Start an agent instance
POST
AgentSchemaVersion
List agent schema versions
GET
Create a new agent schema version
POST
Fetch agent schema version
GET
AgentSpan
List agent spans
GET
Create a new agent span
POST
Finish an agent span
POST
AgentVersion
List agent versions
GET
Create a new agent version
POST
Fetch agent version
GET
ApiToken
List API tokens
GET
Create a new API token
POST
Fetch API token
GET
Delete an API token
DELETE
Activate a suspended API token
POST
Revoke an API token
POST
Suspend an API token
POST
Bulk
Execute multiple queries/actions in a single request
POST
Environment
List environments for an account
GET
Create a new environment
POST
Fetch environment
GET
Update an environment
PUT
Delete an environment
DELETE
PFID
Generate new PFIDs with a partition matching the account
POST
SDKs
Overview
Schemas and Return Schemas
Configuration and Environment Variables
CLI Tool
TypeScript SDK
Getting started
API overview
API modules
Core
@prefactor/core
classes
Class: AgentInstanceClient
Class: AgentInstanceManager
Class: AgentSpanClient
Class: HttpClient
Class: HttpClientError
Class: HttpTransport
Class: SpanContext
Class: Tracer
enumerations
Enumeration: SpanStatus
functions
Function: configureLogging()
Function: createConfig()
Function: createCore()
Function: createSpanTypePrefixer()
Function: getLogger()
Function: registerShutdownHandler()
Function: serializeValue()
Function: shutdown()
Function: truncateString()
Function: withSpan()
interfaces
Interface: EndSpanOptions
Interface: ErrorInfo
Interface: HttpRequester
Interface: Span
Interface: StartSpanOptions
Interface: TokenUsage
Interface: Transport
type-aliases
Type Alias: AgentInstanceFinishOptions
Type Alias: AgentInstanceOptions
Type Alias: AgentInstanceRegisterPayload
Type Alias: AgentInstanceResponse
Type Alias: AgentInstanceStartOptions
Type Alias: AgentSpanCreatePayload
Type Alias: AgentSpanFinishOptions
Type Alias: AgentSpanResponse
Type Alias: AgentSpanStatus
Type Alias: Config
Type Alias: CoreRuntime
Type Alias: HttpTransportConfig
Type Alias: PartialHttpConfig
Type Alias: SpanType
variables
Variable: ConfigSchema
Variable: HttpTransportConfigSchema
Variable: PartialHttpConfigSchema
Variable: SpanType
Packages
LangChain
@prefactor/packages/langchain
classes
Class: PrefactorMiddleware
functions
Function: extractTokenUsage()
Function: getTracer()
Function: init()
Function: withSpan()
AI
@prefactor/packages/ai
functions
Function: createPrefactorMiddleware()
Function: getTracer()
Function: init()
Function: withSpan()
interfaces
Interface: CallData
Interface: MiddlewareConfig
GitHub
Select theme
Dark
Light
Auto
Prefactor TypeScript SDK
Prefactor TypeScript SDK
Prefactor TypeScript SDK
Section titled “Prefactor TypeScript SDK”
Documents
Section titled “Documents”
concepts-schemas
configuration
cli-tool
Modules
Section titled “Modules”
Core
Section titled “Core”
@prefactor/core
Packages
Section titled “Packages”
@prefactor/packages/langchain
@prefactor/packages/ai
@prefactor/openclaw