Prompt Agent Session

Changed on

Continue an explicitly selected session or request that its agent stop.

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

Request

  • Base URL: https://api.app.shortcut.com
  • URL: https://api.app.shortcut.com/api/v4/{workspace-slug}/agent-sessions/{agent-session-id}/prompts
  • 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

bodystring required

The message to the agent. Markdown is supported.

idempotency_keystring required

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

turninteger required

The current session turn.

in_reply_tostring uuid

The ID of the elicitation activity this prompt answers.

signal'stop'

Ask the agent to stop and publish a final response or error.

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