Skip to main content
POST
Create a Session

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

checkfu-version
enum<string>
required
Available options:
2026-08-27
checkfu-beta
string
required
idempotency-key
string
Maximum string length: 255

Body

application/json
agent
required
Pattern: ^agent_[0-9a-f]{32}$
environment_id
string
required
Pattern: ^env_[0-9a-f]{32}$
budget
object
initial_events
object[]
Maximum array length: 50
metadata
object

at most 16 correlation pairs with keys of 1 to 64 characters

resources
object[]
title
string | null
vault_ids
string[]
Pattern: ^vlt_[0-9a-f]{32}$

Response

BetaManagedAgentsSession

id
string
required
Pattern: ^sess_[0-9a-f]{32}$
agent
object
required
archived_at
string | null
required

A canonical UTC ISO-8601 timestamp with millisecond precision.

Maximum string length: 24
Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
budget
object | null
required
created_at
string
required

A canonical UTC ISO-8601 timestamp with millisecond precision.

Maximum string length: 24
Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
environment_id
string
required
Pattern: ^env_[0-9a-f]{32}$
metadata
object
required

at most 16 correlation pairs with keys of 1 to 64 characters

outcome_evaluations
object[]
required
resources
object[]
required
stats
object
required
status
enum<string>
required
Available options:
rescheduling,
running,
idle,
terminated
title
string | null
required
type
enum<string>
required
Available options:
session
updated_at
string
required

A canonical UTC ISO-8601 timestamp with millisecond precision.

Maximum string length: 24
Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
usage
object
required
vault_ids
string[]
required
Pattern: ^vlt_[0-9a-f]{32}$
automation_id
string | null
Pattern: ^auto_[0-9a-f]{32}$