SendMessageConfiguration

Configuration of a send message request.

JSON representation
{
  "acceptedOutputModes": [
    string
  ],
  "taskPushNotificationConfig": {
    object (TaskPushNotificationConfig)
  },
  "returnImmediately": boolean,
  "historyLength": integer
}
Fields
acceptedOutputModes[]

string

A list of media types the client is prepared to accept for response parts. Agents SHOULD use this to tailor their output.

taskPushNotificationConfig

object (TaskPushNotificationConfig)

Configuration for the agent to send push notifications for task updates. Task id should be empty when sending this configuration in a message.send request.

returnImmediately

boolean

If true, the operation returns immediately after creating the task, even if processing is still in progress. If false (default), the operation MUST wait until the task reaches a terminal (COMPLETED, FAILED, CANCELED, REJECTED) or interrupted (INPUT_REQUIRED, AUTH_REQUIRED) state before returning.

historyLength

integer

The maximum number of most recent messages from the task's history to retrieve in the response. An unset value means the client does not impose any limit. A value of zero is a request to not include any messages. The server MUST NOT return more messages than the provided value, but MAY apply a lower limit.

TaskPushNotificationConfig

A container associating a push notification configuration with a specific task.

JSON representation
{
  "tenant": string,
  "id": string,
  "taskId": string,
  "url": string,
  "token": string,
  "authentication": {
    object (AuthenticationInfo)
  }
}
Fields
tenant

string

Optional. Tenant ID.

id

string

The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration.

taskId

string

The ID of the task this configuration is associated with.

url

string

Required. The URL where the notification should be sent.

token

string

A token unique for this task or session.

authentication

object (AuthenticationInfo)

Authentication information required to send the notification.

AuthenticationInfo

Defines authentication details, used for push notifications.

JSON representation
{
  "scheme": string,
  "credentials": string
}
Fields
scheme

string

Required. HTTP Authentication Scheme from the IANA registry. Examples: Bearer, Basic, Digest. Scheme names are case-insensitive per RFC 9110 Section 11.1.

credentials

string

Push Notification credentials. Format depends on the scheme (e.g., token for Bearer).