Skip to content
Prefactor Docs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Prefactor platform
Introduction
The audit trail
Risk
Quality and performance
Instrumentation strategy
Data model
Concepts
Account
Activity schema
Agent
Agent deployment
API token
Environment
Instance
Risk profile
Span
Admin UI
Introduction
Agents page
Agent page
About
Overview tab
Instances tab
Versions tab
Deployments tab
Activity schema tab
Agent instance page
About
Activity tab
Details tab
Risk profiles page
Risk profile page
Account page
About
Details tab
Team tab
Invites tab
API Tokens tab
Environments tab
Admin CLI
Introduction
Getting started
Configuration
Agent skills
API
Introduction
OpenAPI Spec
Overview
AgentInstance
Terminate an agent instance
POST
Register a new agent instance with agent version
POST
Start an agent instance
POST
Fetch agent instance
GET
Finish an agent instance
POST
List agent instances
GET
PFID
Generate new PFIDs with a partition matching the account
POST
Agent
List agents
GET
Create a new agent
POST
Retire an agent
POST
Reinstate a retired agent
POST
Fetch agent
GET
Update an agent
PUT
Delete an agent
DELETE
AgentDeployment
List agent deployments
GET
Create an agent deployment
POST
Fetch agent deployment
GET
Update an agent deployment
PUT
Delete an agent deployment
DELETE
AdminUser
Fetch admin user details
GET
Update an admin user (own profile only)
PUT
List admin users for an account
GET
AgentVersion
Fetch agent version
GET
List agent versions
GET
Create a new agent version
POST
Playground
Register a customer support demo agent instance with support-copilot span schemas
POST
Create a customer support demo agent
POST
Record a canned multi-span support conversation on an instance
POST
AdminUserInvite
Revoke an admin user invite
POST
Fetch admin user invite details
GET
List admin user invites for an account
GET
Create a new admin user invite
POST
ApiToken
Revoke an API token
POST
Fetch API token
GET
Delete an API token
DELETE
Suspend an API token
POST
List API tokens
GET
Create a new API token
POST
Activate a suspended API token
POST
Account
Fetch account
GET
Update an account
PUT
List accounts (internal)
GET
Implode (delete) the account you are authenticated as
POST
AgentSchemaVersion
List agent schema versions
GET
Create a new agent schema version
POST
Fetch agent schema version
GET
RiskProfile
Get risk profile details
GET
Update a risk profile
PUT
Delete a risk profile
DELETE
List risk profiles
GET
Create a new risk profile
POST
Get risk profile template ruleset
GET
Bulk
Execute multiple queries/actions in a single request
POST
AgentSpan
Finish an agent span
POST
List agent spans
GET
Create a new agent span
POST
Environment
Fetch environment
GET
Update an environment
PUT
Delete an environment
DELETE
List environments for an account
GET
Create a new environment
POST
SDKs
Introduction
Schemas and Return Schemas
Configuration and Environment Variables
TypeScript SDK
Introduction
Getting started
API modules
Core
@prefactor/core
classes
Class: AgentInstanceClient
Class: AgentInstanceManager
Class: AgentSpanClient
Class: HttpClient
Class: HttpClientError
Class: HttpTransport
Class: PrefactorClient\<TMiddleware\>
Class: PrefactorFatalError
Class: PrefactorShutdownError
Class: SpanContext
Class: Tracer
enumerations
Enumeration: SpanStatus
functions
Function: configureLogging()
Function: createConfig()
Function: createCore()
Function: createSpanTypePrefixer()
Function: getClient()
Function: getLogger()
Function: init()
Function: normalizeAgentToolSchemas()
Function: registerShutdownHandler()
Function: resolveMappedSpanType()
Function: serializeValue()
Function: shutdown()
Function: truncateString()
Function: withSpan()
interfaces
Interface: ActionProfile
Interface: AgentSchemaVersion
Interface: DataCategories
Interface: DataRisk
Interface: EndSpanOptions
Interface: ErrorInfo
Interface: FailureHandlingConfig
Interface: HttpRequester
Interface: ManualSpanOptions
Interface: PrefactorOptions\<TMiddleware\>
Interface: PrefactorProvider\<TMiddleware\>
Interface: Span
Interface: SpanTypeSchema
Interface: StartSpanOptions
Interface: TokenUsage
Interface: ToolSchemaConfig
Interface: Transport
type-aliases
Type Alias: ActionProfileValue
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: CreateCoreOptions
Type Alias: DataCategoryValue
Type Alias: DataClassification
Type Alias: HttpTransportConfig
Type Alias: JsonSchema
Type Alias: MiddlewareLike
Type Alias: PartialHttpConfig
Type Alias: PrefactorFatalErrorKind
Type Alias: PrefactorShutdownDetails
Type Alias: PrefactorShutdownErrorKind
Type Alias: PrefactorTransportHealthState
Type Alias: PrefactorTransportOperation
Type Alias: SpanType
variables
Variable: ConfigSchema
Variable: HttpTransportConfigSchema
Variable: PartialHttpConfigSchema
Variable: SpanType
Packages
LangChain
@prefactor/langchain
classes
Class: PrefactorLangChain
interfaces
Interface: PrefactorLangChainOptions
variables
Variable: DEFAULT\_LANGCHAIN\_AGENT\_SCHEMA
AI
@prefactor/ai
classes
Class: PrefactorAISDK
functions
Function: getTracer()
Function: init()
Function: withSpan()
interfaces
Interface: MiddlewareConfig
Interface: PrefactorAISDKOptions
type-aliases
Type Alias: ManualSpanOptions
variables
Variable: DEFAULT\_AI\_AGENT\_SCHEMA
Claude
@prefactor/claude
classes
Class: PrefactorClaude
interfaces
Interface: ClaudeMiddleware
Interface: PrefactorClaudeOptions
type-aliases
Type Alias: ClaudeQuery
variables
Variable: DEFAULT\_CLAUDE\_AGENT\_SCHEMA
Python SDK
Introduction
Getting started
Core
Prefactor Core
reference
prefactor_core
prefactor_core package
prefactor_core.client module
prefactor_core.config module
prefactor_core.context_stack module
prefactor_core.exceptions module
prefactor_core.managers package
prefactor_core.managers.agent_instance module
prefactor_core.managers.span module
prefactor_core.models module
prefactor_core.operations module
prefactor_core.queue package
prefactor_core.queue.base module
prefactor_core.queue.executor module
prefactor_core.queue.memory module
prefactor_core.schema_registry module
prefactor_core.span_context module
prefactor_core.utils module
HTTP
Prefactor HTTP Client
reference
prefactor_http
prefactor_http package
prefactor_http.client module
prefactor_http.config module
prefactor_http.endpoints package
prefactor_http.endpoints.agent_instance module
prefactor_http.endpoints.agent_span module
prefactor_http.endpoints.bulk module
prefactor_http.exceptions module
prefactor_http.models package
prefactor_http.models.agent_instance module
prefactor_http.models.agent_span module
prefactor_http.models.base module
prefactor_http.models.bulk module
prefactor_http.models.types module
prefactor_http.retry module
LangChain
prefactor-langchain
reference
prefactor_langchain
prefactor_langchain package
prefactor_langchain.metadata_extractor module
prefactor_langchain.middleware module
prefactor_langchain.schemas module
prefactor_langchain.spans module
LiveKit
prefactor-livekit
reference
prefactor_livekit
prefactor_livekit package
prefactor_livekit.schemas module
prefactor_livekit.session module
GitHub
Select theme
Dark
Light
Auto
prefactor_http.models.types module
prefactor_http.models.types module
Section titled “prefactor_http.models.types module”
Shared type definitions for Prefactor API models.
