Type Alias: AgentInstanceRegisterPayload
Prefactor TypeScript SDK / @prefactor/core / AgentInstanceRegisterPayload
Type Alias: AgentInstanceRegisterPayload
Section titled “Type Alias: AgentInstanceRegisterPayload”AgentInstanceRegisterPayload =
object
Defined in: packages/core/src/transport/http/agent-instance-client.ts:5
Properties
Section titled “Properties”agent_id?
Section titled “agent_id?”
optionalagent_id:string
Defined in: packages/core/src/transport/http/agent-instance-client.ts:6
environment_id?
Section titled “environment_id?”
optionalenvironment_id:string
Defined in: packages/core/src/transport/http/agent-instance-client.ts:7
purpose?
Section titled “purpose?”
optionalpurpose:"live"|"smoke_test"|"eval"
Defined in: packages/core/src/transport/http/agent-instance-client.ts:9
Why this instance ran: ‘live’ for an actual agent run, ‘smoke_test’ for a pipeline check, or ‘eval’ for an evaluation run. Omit to let the API default to ‘live’.
agent_version?
Section titled “agent_version?”
optionalagent_version:object
Defined in: packages/core/src/transport/http/agent-instance-client.ts:10
external_identifier
Section titled “external_identifier”external_identifier:
string
name:
string
description
Section titled “description”description:
string
agent_schema_version?
Section titled “agent_schema_version?”
optionalagent_schema_version:AgentSchemaVersion
Defined in: packages/core/src/transport/http/agent-instance-client.ts:15
idempotency_key?
Section titled “idempotency_key?”
optionalidempotency_key:string
Defined in: packages/core/src/transport/http/agent-instance-client.ts:16