WorkOS PHP SDK

AgentBlueprint
in package
implements JsonSerializable uses JsonSerializableTrait

Read onlyYes

Table of Contents

Interfaces

JsonSerializable

Properties

$createdAt  : DateTimeImmutable
Timestamp when the agent blueprint was created.
$description  : string|null
Human-readable description of the agent blueprint.
$id  : string
Unique identifier of the agent blueprint.
$invocableBy  : AgentBlueprintInvocableBy
Who may mint sessions from this blueprint.
$name  : string
Human-readable name of the agent blueprint.
$object  : string
Distinguishes the agent blueprint object.
$permissions  : array<string|int, string>
Permission slugs forming the ceiling on what sessions minted from this blueprint may do.
$sessionSettings  : AgentBlueprintSessionSetting
Token and session lifetimes for sessions minted from this blueprint.
$updatedAt  : DateTimeImmutable
Timestamp when the agent blueprint was last updated.

Methods

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

Properties

$createdAt

Timestamp when the agent blueprint was created.

public DateTimeImmutable $createdAt

$description

Human-readable description of the agent blueprint.

public string|null $description

$name

Human-readable name of the agent blueprint.

public string $name

$object

Distinguishes the agent blueprint object.

public string $object

$permissions

Permission slugs forming the ceiling on what sessions minted from this blueprint may do.

public array<string|int, string> $permissions

$updatedAt

Timestamp when the agent blueprint was last updated.

public DateTimeImmutable $updatedAt

Methods

__construct()

public __construct(string $object, string $id, string $name, string|null $description, array<string|int, mixed> $permissions, AgentBlueprintInvocableBy $invocableBy, AgentBlueprintSessionSetting $sessionSettings, DateTimeImmutable $createdAt, DateTimeImmutable $updatedAt) : mixed
Parameters
$object : string
$id : string
$name : string
$description : string|null
$permissions : array<string|int, mixed>
$invocableBy : AgentBlueprintInvocableBy
$sessionSettings : AgentBlueprintSessionSetting
$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