Google Cloud Platform Message API

openapi: 3.2.0
info:
  title: Cloud Billing Message API
  version: v1
  description: Generated from Google's published Discovery document for Cloud Billing API (cloudbilling v1, revision 20261106). 2 operation(s).
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
servers:
- url: https://cloudbilling.googleapis.com
tags:
- name: Message
paths:
  /v1/message:send:
    post:
      operationId: cloudbilling.message.send
      summary: Send message
      description: Send a message to the agent. This is a blocking call that will return the task once it is completed, or a LRO if requested.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendMessageRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendMessageResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-billing
        - https://www.googleapis.com/auth/cloud-billing.readonly
        - https://www.googleapis.com/auth/cloud-platform
      - apiKey: []
      tags:
      - Message
  /v1/message:stream:
    post:
      operationId: cloudbilling.message.stream
      summary: Stream message
      description: SendStreamingMessage is a streaming call that will return a stream of task update events until the Task is in an interrupted or terminal state.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendMessageRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-billing
        - https://www.googleapis.com/auth/cloud-billing.readonly
        - https://www.googleapis.com/auth/cloud-platform
      - apiKey: []
      tags:
      - Message
components:
  schemas:
    Message:
      type: object
      properties:
        content:
          items:
            $ref: '#/components/schemas/Part'
          description: protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
          type: array
        extensions:
          items:
            type: string
          type: array
          description: The URIs of extensions that are present or contributed to this Message.
        role:
          enum:
          - ROLE_UNSPECIFIED
          - ROLE_USER
          - ROLE_AGENT
          description: A role for the message.
          type: string
        taskId:
          description: The task id of the message. This is optional and if set, the message will be associated with the given task.
          type: string
        messageId:
          description: The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
          type: string
        contextId:
          description: The context id of the message. This is optional and if set, the message will be associated with the given context.
          type: string
        metadata:
          description: protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
          type: object
          additionalProperties:
            description: Properties of the object.
      description: Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id.
    Artifact:
      description: Artifacts are the container for task completed results. These are similar to Messages but are intended to be the product of a task, as opposed to point-to-point communication.
      properties:
        artifactId:
          description: Unique identifier (e.g. UUID) for the artifact. It must be at least unique within a task.
          type: string
        metadata:
          description: Optional metadata included with the artifact.
          type: object
          additionalProperties:
            description: Properties of the object.
        parts:
          type: array
          items:
            $ref: '#/components/schemas/Part'
          description: The content of the artifact.
        name:
          type: string
          description: A human readable name for the artifact.
        extensions:
          items:
            type: string
          type: array
          description: The URIs of extensions that are present or contributed to this Artifact.
        description:
          type: string
          description: A human readable description of the artifact, optional.
      type: object
    DataPart:
      properties:
        data:
          additionalProperties:
            description: Properties of the object.
          type: object
      description: DataPart represents a structured blob. This is most commonly a JSON payload.
      type: object
    SendMessageConfiguration:
      type: object
      properties:
        historyLength:
          type: integer
          format: int32
          description: The maximum number of messages to include in the history. if 0, the history will be unlimited.
        acceptedOutputModes:
          type: array
          description: The output modes that the agent is expected to respond with.
          items:
            type: string
        blocking:
          type: boolean
          description: If true, the message will be blocking until the task is completed. If false, the message will be non-blocking and the task will be returned immediately. It is the caller's responsibility to check for any task updates.
        pushNotification:
          $ref: '#/components/schemas/PushNotificationConfig'
          description: A configuration of a webhook that can be used to receive updates
      description: Configuration of a send message request.
    StreamResponse:
      properties:
        task:
          $ref: '#/components/schemas/Task'
        message:
          $ref: '#/components/schemas/Message'
        statusUpdate:
          $ref: '#/components/schemas/TaskStatusUpdateEvent'
        artifactUpdate:
          $ref: '#/components/schemas/TaskArtifactUpdateEvent'
      type: object
      description: 'The stream response for a message. The stream should be one of the following sequences: If the response is a message, the stream should contain one, and only one, message and then close If the response is a task lifecycle, the first response should be a Task object followed by zero or more TaskStatusUpdateEvents and TaskArtifactUpdateEvents. The stream should complete when the Task if in an interrupted or terminal state. A stream that ends before these conditions are met are'
    Task:
      type: object
      properties:
        id:
          description: Unique identifier (e.g. UUID) for the task, generated by the server for a new task.
          type: string
        status:
          $ref: '#/components/schemas/TaskStatus'
          description: The current status of a Task, including state and a message.
        metadata:
          additionalProperties:
            description: Properties of the object.
          type: object
          description: protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.
        contextId:
          description: Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages). Created by the A2A server.
          type: string
        artifacts:
          description: A set of output artifacts for a Task.
          type: array
          items:
            $ref: '#/components/schemas/Artifact'
        history:
          items:
            $ref: '#/components/schemas/Message'
          description: protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a task.
          type: array
      description: Task is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history.
    SendMessageResponse:
      type: object
      description: ////// Response Messages ///////////
      properties:
        message:
          $ref: '#/components/schemas/Message'
        task:
          $ref: '#/components/schemas/Task'
    Part:
      description: Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
      type: object
      properties:
        text:
          type: string
        metadata:
          description: Optional metadata associated with this part.
          type: object
          additionalProperties:
            description: Properties of the object.
        file:
          $ref: '#/components/schemas/FilePart'
        data:
          $ref: '#/components/schemas/DataPart'
    AuthenticationInfo:
      description: Defines authentication details, used for push notifications.
      properties:
        schemes:
          description: Supported authentication schemes - e.g. Basic, Bearer, etc
          type: array
          items:
            type: string
        credentials:
          description: Optional credentials
          type: string
      type: object
    SendMessageRequest:
      description: /////////// Request Messages ///////////
      properties:
        metadata:
          type: object
          description: Optional metadata for the request.
          additionalProperties:
            description: Properties of the object.
        configuration:
          $ref: '#/components/schemas/SendMessageConfiguration'
          description: Configuration for the send request.
        tenant:
          type: string
          description: Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
        message:
          $ref: '#/components/schemas/Message'
          description: Required. The message to send to the agent.
      type: object
    TaskStatusUpdateEvent:
      properties:
        metadata:
          description: Optional metadata to associate with the task update.
          additionalProperties:
            description: Properties of the object.
          type: object
        status:
          $ref: '#/components/schemas/TaskStatus'
          description: The new status of the task.
        taskId:
          description: The id of the task that is changed
          type: string
        final:
          description: Whether this is the last status update expected for this task.
          type: boolean
        contextId:
          description: The id of the context that the task belongs to
          type: string
      type: object
      description: TaskStatusUpdateEvent is a delta even on a task indicating that a task has changed.
    TaskArtifactUpdateEvent:
      type: object
      properties:
        append:
          description: Whether this should be appended to a prior one produced
          type: boolean
        taskId:
          description: The id of the task for this artifact
          type: string
        artifact:
          $ref: '#/components/schemas/Artifact'
          description: The artifact itself
        contextId:
          type: string
          description: The id of the context that this task belongs too
        lastChunk:
          description: Whether this represents the last part of an artifact
          type: boolean
        metadata:
          type: object
          description: Optional metadata associated with the artifact update.
          additionalProperties:
            description: Properties of the object.
      description: TaskArtifactUpdateEvent represents a task delta where an artifact has been generated.
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
    TaskStatus:
      description: A container for the status of a task
      type: object
      properties:
        timestamp:
          type: string
          format: google-datetime
          description: 'Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z"'
        state:
          enum:
          - TASK_STATE_UNSPECIFIED
          - TASK_STATE_SUBMITTED
          - TASK_STATE_WORKING
          - TASK_STATE_COMPLETED
          - TASK_STATE_FAILED
          - TASK_STATE_CANCELLED
          - TASK_STATE_INPUT_REQUIRED
          - TASK_STATE_REJECTED
          - TASK_STATE_AUTH_REQUIRED
          type: string
          description: The current state of this task
        message:
          $ref: '#/components/schemas/Message'
          description: A message associated with the status.
    FilePart:
      properties:
        name:
          type: string
        fileWithBytes:
          type: string
          format: byte
        mimeType:
          type: string
        fileWithUri:
          type: string
      description: FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
      type: object
    PushNotificationConfig:
      properties:
        token:
          description: Token unique for this task/session
          type: string
        authentication:
          $ref: '#/components/schemas/AuthenticationInfo'
          description: Information about the authentication to sent with the notification
        id:
          description: A unique identifier (e.g. UUID) for this push notification.
          type: string
        url:
          description: Url to send the notification too
          type: string
      type: object
      description: Configuration for setting up push notifications for task updates.
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/cloud-platform: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
            https://www.googleapis.com/auth/cloud-billing: View and manage your Google Cloud Platform billing accounts
            https://www.googleapis.com/auth/cloud-billing.readonly: View your Google Cloud Platform billing accounts
externalDocs:
  url: https://cloud.google.com/billing/docs/apis
x-provenance:
  method: harvested
  publisher: Google
  source: https://cloudbilling.googleapis.com/$discovery/rest?version=v1
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261106)