Create Agent Session

Changed on

Create work owned by the authenticated agent on a Story or Epic. Repeated identical idempotency keys return the same session.

post/api/v4/{workspace-slug}/agent-sessions

Request

  • Base URL: https://api.app.shortcut.com
  • URL: https://api.app.shortcut.com/api/v4/{workspace-slug}/agent-sessions
  • Auth: HTTP bearer

Path parameters

workspace-slugstring required

The slug for the Workspace.

Request body

entity_idinteger required

The public ID of the Story or Epic.

entity_type'story' | 'epic' required

The type of entity the session belongs to.

idempotency_keystring required

Client key that makes repeated identical requests return the same session.

Response

Resource

acknowledged_atstring date-time nullable required
agent_member_idstring uuid required
closed_reasonstring nullable required
created_atstring date-time required
created_bystring uuid required
entity_idinteger required
entity_type'story' | 'epic' required
first_delivery_atstring date-time nullable required
idstring uuid required
installation_idstring uuid required
last_agent_activity_atstring date-time nullable required
last_delivery_errorstring nullable required
last_delivery_failed_atstring date-time nullable required
status'awaiting_input' | 'complete' | 'error' | 'stale' | 'active' | 'pending' required
stop_requested_atstring date-time nullable required
thread_comment_idinteger nullable required
turninteger required
updated_atstring date-time required
versioninteger required
workspace_idstring uuid required

Changes