Skip to content

Rippling: Create an agent session — request body — body

Create an agent session: request body, field body. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Create an agent session — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
agent_idstringRequired within parentThe ID of the agent to run
promptstringRequired within parentThe prompt to send to the agent
session_resume_stateobjectOptionalOptional opaque state used to restore the new session
session_resume_state.artifactstringRequired within parentAn opaque base64-encoded agent session resume state

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.