Create Agent Activity

Changed on

Publish a typed activity as the agent owning the session.

post/api/v4/{workspace-slug}/agent-sessions/{agent-session-id}/activities

Request

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

Path parameters

workspace-slugstring required

The slug for the Workspace.

agent-session-idstring uuid required

The ID of the Agent Session.

Request body

idempotency_keystring required

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

turninteger required

The session turn this activity belongs to. Must match the current turn.

ephemeralboolean

Replace this thought or action when the next agent activity arrives.

signal'auth' | 'select'

Optional signal on an elicitation.

Response

Resource

author_idstring uuid required
created_atstring date-time required
ephemeralboolean required
idstring uuid required
in_reply_tostring uuid nullable required
sequenceinteger required
session_idstring uuid required
signalstring nullable required
supersededboolean required
turninteger required
workspace_idstring uuid required

Changes