Skip to main content
POST

Authorizations

Authorization
string
header
required

OAuth2 access token issued by Ory Hydra. Required for most operations.

Scopes:

  • agent:read — Read-only operations (tasks/get, tasks/list, contexts/list)
  • agent:write — Write operations (message/send, tasks/cancel, contexts/clear)
  • agent:execute — (legacy) Both read and write access

How to obtain:

  1. Register your client with Hydra
  2. Complete OAuth2 client credentials or authorization code flow
  3. Include token in Authorization: Bearer <token> header

Body

application/json

JSON-RPC 2.0 request envelope. One of the per-method params shapes must be supplied via the method field.

jsonrpc
string
required
Allowed value: "2.0"
method
enum<string>
required
Available options:
message/send,
message/stream,
tasks/get,
tasks/list,
tasks/cancel,
tasks/feedback,
tasks/pushNotificationConfig/set,
tasks/pushNotificationConfig/get,
tasks/pushNotificationConfig/list,
tasks/pushNotificationConfig/delete,
contexts/list,
contexts/clear
id
required

Caller-chosen request id. The response echoes it back.

params
object

Method-specific params (see per-method schemas below)

Response

Successful JSON-RPC response. result contains the typed output per method — see components/schemas/*Result.

JSON-RPC 2.0 response envelope. Exactly one of result or error is present.

jsonrpc
string
required
Allowed value: "2.0"
id
required
result
object

Method-specific result (see per-method result schemas)

error
object