Rivier/ Reference/ agents

Tell the assistant what you want done

post/agents/assistant/threads/{id}/messages

Tell the assistant what you want done; it answers as a stream of events (words, plan, previews, approval requests, results).

Before you call

Credential
Authorization: Bearer $KEY
Scope
agents:write
Sdk
agents.assistant.message
Cli
agents assistant message

Parameters

  • idstringrequired
    In the path

Request bodyapplication/json, required

  • messagestringrequired
    At most 8000 characters.
  • modestring
    One of: ask, plan, do_with_approval, do_within_rules. Default: do_with_approval.
  • mentionslist of object
    Default: [].
    • attachmentslist of object
      Default: [].

      Responses

      • 200text/event-stream
        Success

        string

      • 400application/json
        The request was malformed
        • errorstringrequired
        • messagestring
      • 401application/json
        No valid credential
        • errorstringrequired
        • messagestring
      • 403application/json
        The credential lacks the scope, origin or address
        • errorstringrequired
        • messagestring
      • 429application/json
        Over the key's rate limit; see Retry-After
        • errorstringrequired
        • messagestring

      This page as Markdown