WorkOS PHP SDK

AgentInstance
in package
implements JsonSerializable uses JsonSerializableTrait

Read onlyYes

Table of Contents

Interfaces

JsonSerializable

Properties

$agentBlueprintId  : string
The blueprint this instance was minted from.
$createdAt  : DateTimeImmutable
Timestamp when the agent instance was created.
$id  : string
Unique identifier of the agent instance.
$object  : string
Distinguishes the agent instance object.
$organizationId  : string
The organization the instance acts within.
$organizationMembershipId  : string|null
The organization membership of the delegating user; `null` for autonomous instances.
$type  : AgentInstanceType
Whether the instance acts on behalf of a specific user (`delegated`) or as itself (`autonomous`).
$updatedAt  : DateTimeImmutable
Timestamp when the agent instance was last updated.

Methods

__construct()  : mixed
fromArray()  : self
jsonSerialize()  : array<string|int, mixed>
toArray()  : array<string|int, mixed>

Properties

$agentBlueprintId

The blueprint this instance was minted from.

public string $agentBlueprintId

$createdAt

Timestamp when the agent instance was created.

public DateTimeImmutable $createdAt

$id

Unique identifier of the agent instance.

public string $id

$object

Distinguishes the agent instance object.

public string $object

$organizationId

The organization the instance acts within.

public string $organizationId

$organizationMembershipId

The organization membership of the delegating user; `null` for autonomous instances.

public string|null $organizationMembershipId

$updatedAt

Timestamp when the agent instance was last updated.

public DateTimeImmutable $updatedAt

Methods

__construct()

public __construct(string $object, string $id, string $agentBlueprintId, string $organizationId, string|null $organizationMembershipId, AgentInstanceType $type, DateTimeImmutable $createdAt, DateTimeImmutable $updatedAt) : mixed
Parameters
$object : string
$id : string
$agentBlueprintId : string
$organizationId : string
$organizationMembershipId : string|null
$type : AgentInstanceType
$createdAt : DateTimeImmutable
$updatedAt : DateTimeImmutable

fromArray()

public static fromArray(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>
Return values
self

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>

toArray()

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>
On this page

Search results