prefactor_http.models.agent module
prefactor_http.models.agent module
Section titled “prefactor_http.models.agent module”Agent data models.
class prefactor_http.models.agent.Agent(, type: Literal[‘agent’], id: str, name: str, description: str | None = None, external_identifier: str | None = None, status: Literal[‘pending’, ‘active’, ‘dormant’, ‘retired’], owner_person_id: str | None = None, risk_profile_id: str | None = None, team_id: str | None = None, instance_counts: AgentInstanceCounts | None = None, available_actions: AgentAvailableActions | None = None, inserted_at: datetime | None = None, updated_at: datetime | None = None)
Section titled “class prefactor_http.models.agent.Agent(, type: Literal[‘agent’], id: str, name: str, description: str | None = None, external_identifier: str | None = None, status: Literal[‘pending’, ‘active’, ‘dormant’, ‘retired’], owner_person_id: str | None = None, risk_profile_id: str | None = None, team_id: str | None = None, instance_counts: AgentInstanceCounts | None = None, available_actions: AgentAvailableActions | None = None, inserted_at: datetime | None = None, updated_at: datetime | None = None)”Bases: BaseModel
Full agent details.
Resource type (always “agent”).
- Type: Literal[‘agent’]
Agent ID.
- Type: str
Agent name.
- Type: str
description
Section titled “description”Optional agent description.
- Type: str | None
external_identifier
Section titled “external_identifier”Optional external identifier (unique per account).
- Type: str | None
status
Section titled “status”Agent status (pending, active, dormant, retired).
- Type: Literal[‘pending’, ‘active’, ‘dormant’, ‘retired’]
owner_person_id
Section titled “owner_person_id”Optional owner person ID.
- Type: str | None
risk_profile_id
Section titled “risk_profile_id”Optional risk profile ID.
- Type: str | None
team_id
Section titled “team_id”Optional team ID.
- Type: str | None
instance_counts
Section titled “instance_counts”Instance counts for this agent.
- Type: AgentInstanceCounts | None
available_actions
Section titled “available_actions”Available actions based on current status.
- Type: AgentAvailableActions | None
inserted_at
Section titled “inserted_at”When the agent was created.
- Type: datetime | None
updated_at
Section titled “updated_at”When the agent was last updated.
- Type: datetime | None
available_actions : AgentAvailableActions | None
Section titled “available_actions : AgentAvailableActions | None”description : str | None
Section titled “description : str | None”external_identifier : str | None
Section titled “external_identifier : str | None”id : str
Section titled “id : str”inserted_at : datetime | None
Section titled “inserted_at : datetime | None”instance_counts : AgentInstanceCounts | None
Section titled “instance_counts : AgentInstanceCounts | None”model_config = {}
Section titled “model_config = {}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
name : str
Section titled “name : str”owner_person_id : str | None
Section titled “owner_person_id : str | None”risk_profile_id : str | None
Section titled “risk_profile_id : str | None”status : Literal[‘pending’, ‘active’, ‘dormant’, ‘retired’]
Section titled “status : Literal[‘pending’, ‘active’, ‘dormant’, ‘retired’]”team_id : str | None
Section titled “team_id : str | None”type : Literal[‘agent’]
Section titled “type : Literal[‘agent’]”updated_at : datetime | None
Section titled “updated_at : datetime | None”class prefactor_http.models.agent.AgentAvailableActions(, update: bool = False, retire: bool = False, reinstate: bool = False, delete: bool = False)
Section titled “class prefactor_http.models.agent.AgentAvailableActions(, update: bool = False, retire: bool = False, reinstate: bool = False, delete: bool = False)”Bases: BaseModel
Available actions for an agent based on its status.
update
Section titled “update”Whether the agent can be updated.
- Type: bool
retire
Section titled “retire”Whether the agent can be retired.
- Type: bool
reinstate
Section titled “reinstate”Whether the agent can be reinstated from retired.
- Type: bool
delete
Section titled “delete”Whether the agent can be deleted.
- Type: bool
delete : bool
Section titled “delete : bool”model_config = {}
Section titled “model_config = {}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
reinstate : bool
Section titled “reinstate : bool”retire : bool
Section titled “retire : bool”update : bool
Section titled “update : bool”class prefactor_http.models.agent.AgentForCreate(, name: str, description: str | None = None, external_identifier: str | None = None, id: str | None = None, owner_person_id: str | None = None, risk_profile_id: str | None = None, team_id: str | None = None)
Section titled “class prefactor_http.models.agent.AgentForCreate(, name: str, description: str | None = None, external_identifier: str | None = None, id: str | None = None, owner_person_id: str | None = None, risk_profile_id: str | None = None, team_id: str | None = None)”Bases: BaseModel
Parameters for creating a new agent.
Agent name (required).
- Type: str
description
Section titled “description”Optional agent description.
- Type: str | None
external_identifier
Section titled “external_identifier”Optional external identifier (unique per account).
- Type: str | None
Optional custom ID (PFID with matching partition).
- Type: str | None
owner_person_id
Section titled “owner_person_id”Optional owner person ID.
- Type: str | None
risk_profile_id
Section titled “risk_profile_id”Optional risk profile ID.
- Type: str | None
team_id
Section titled “team_id”Optional team ID.
- Type: str | None
description : str | None
Section titled “description : str | None”external_identifier : str | None
Section titled “external_identifier : str | None”id : str | None
Section titled “id : str | None”model_config = {}
Section titled “model_config = {}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
name : str
Section titled “name : str”owner_person_id : str | None
Section titled “owner_person_id : str | None”risk_profile_id : str | None
Section titled “risk_profile_id : str | None”team_id : str | None
Section titled “team_id : str | None”class prefactor_http.models.agent.AgentForUpdate(, name: str | None = None, description: str | None = None, owner_person_id: str | None = None, risk_profile_id: str | None = None, team_id: str | None = None)
Section titled “class prefactor_http.models.agent.AgentForUpdate(, name: str | None = None, description: str | None = None, owner_person_id: str | None = None, risk_profile_id: str | None = None, team_id: str | None = None)”Bases: BaseModel
Parameters for updating an agent.
Note: external_identifier cannot be updated via the API — it is only
settable at create time.
Agent name (omit to keep current).
- Type: str | None
description
Section titled “description”Agent description (omit to keep current).
- Type: str | None
owner_person_id
Section titled “owner_person_id”Owner person ID (omit to keep current; null to clear).
- Type: str | None
risk_profile_id
Section titled “risk_profile_id”Risk profile ID (omit to keep current; null to clear).
- Type: str | None
team_id
Section titled “team_id”Team ID (omit to keep current; null to clear).
- Type: str | None
description : str | None
Section titled “description : str | None”model_config = {}
Section titled “model_config = {}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
name : str | None
Section titled “name : str | None”owner_person_id : str | None
Section titled “owner_person_id : str | None”risk_profile_id : str | None
Section titled “risk_profile_id : str | None”team_id : str | None
Section titled “team_id : str | None”class prefactor_http.models.agent.AgentInstanceCounts(, total: int = 0, pending: int = 0, active: int = 0, complete: int = 0, failed: int = 0, cancelled: int = 0, terminated: int = 0, finished: int = 0)
Section titled “class prefactor_http.models.agent.AgentInstanceCounts(, total: int = 0, pending: int = 0, active: int = 0, complete: int = 0, failed: int = 0, cancelled: int = 0, terminated: int = 0, finished: int = 0)”Bases: BaseModel
Instance counts for an agent.
Total number of agent instances.
- Type: int
pending
Section titled “pending”Number of instances with status pending.
- Type: int
active
Section titled “active”Number of instances with status active (running).
- Type: int
complete
Section titled “complete”Number of instances with status complete.
- Type: int
failed
Section titled “failed”Number of instances with status failed.
- Type: int
cancelled
Section titled “cancelled”Number of instances with status cancelled.
- Type: int
terminated
Section titled “terminated”Number of instances with status terminated.
- Type: int
finished
Section titled “finished”Number of instances in a finished state.
- Type: int
active : int
Section titled “active : int”cancelled : int
Section titled “cancelled : int”complete : int
Section titled “complete : int”failed : int
Section titled “failed : int”finished : int
Section titled “finished : int”model_config = {}
Section titled “model_config = {}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
pending : int
Section titled “pending : int”terminated : int
Section titled “terminated : int”total : int
Section titled “total : int”class prefactor_http.models.agent.AgentSummary(, type: Literal[‘agent’], id: str, name: str, description: str | None = None, external_identifier: str | None = None, status: Literal[‘pending’, ‘active’, ‘dormant’, ‘retired’], owner_person_id: str | None = None, team_id: str | None = None, available_actions: AgentAvailableActions | None = None, inserted_at: datetime | None = None, updated_at: datetime | None = None)
Section titled “class prefactor_http.models.agent.AgentSummary(, type: Literal[‘agent’], id: str, name: str, description: str | None = None, external_identifier: str | None = None, status: Literal[‘pending’, ‘active’, ‘dormant’, ‘retired’], owner_person_id: str | None = None, team_id: str | None = None, available_actions: AgentAvailableActions | None = None, inserted_at: datetime | None = None, updated_at: datetime | None = None)”Bases: BaseModel
Agent summary for list responses.
Resource type (always “agent”).
- Type: Literal[‘agent’]
Agent ID.
- Type: str
Agent name.
- Type: str
description
Section titled “description”Optional agent description.
- Type: str | None
external_identifier
Section titled “external_identifier”Optional external identifier (unique per account).
- Type: str | None
status
Section titled “status”Agent status.
- Type: Literal[‘pending’, ‘active’, ‘dormant’, ‘retired’]
owner_person_id
Section titled “owner_person_id”Optional owner person ID.
- Type: str | None
team_id
Section titled “team_id”Optional team ID.
- Type: str | None
available_actions
Section titled “available_actions”Available actions based on current status.
- Type: AgentAvailableActions | None
inserted_at
Section titled “inserted_at”When the agent was created.
- Type: datetime | None
updated_at
Section titled “updated_at”When the agent was last updated.
- Type: datetime | None
available_actions : AgentAvailableActions | None
Section titled “available_actions : AgentAvailableActions | None”description : str | None
Section titled “description : str | None”external_identifier : str | None
Section titled “external_identifier : str | None”id : str
Section titled “id : str”inserted_at : datetime | None
Section titled “inserted_at : datetime | None”model_config = {}
Section titled “model_config = {}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].