Dapr Bindings API

openapi: 3.1.0
info:
  title: Dapr Actors Bindings API
  description: The Dapr Actors API provides virtual actor capabilities for distributed applications, including actor method invocation, state management, timers, and reminders. Actors provide a single-threaded programming model with guaranteed message ordering.
  version: 1.0.0
  contact:
    name: Dapr
    url: https://dapr.io
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:3500
  description: Dapr Sidecar
tags:
- name: Bindings
  description: Input and output binding operations.
paths:
  /v1.0/bindings/{name}:
    post:
      summary: Dapr Invoke Output Binding
      description: Invokes an output binding with the specified operation, data, and metadata. The operation field tells the binding what action to take.
      operationId: invokeOutputBinding
      tags:
      - Bindings
      parameters:
      - name: name
        in: path
        required: true
        description: The name of the output binding to invoke.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BindingRequest'
      responses:
        '200':
          description: Binding invoked successfully with response data.
          content:
            application/json:
              schema: {}
        '204':
          description: Binding invoked successfully with no response.
        '400':
          description: Binding not found or misconfigured.
        '500':
          description: Failed to invoke binding.
components:
  schemas:
    BindingRequest:
      type: object
      required:
      - operation
      properties:
        data:
          description: The data to send to the output binding.
        metadata:
          type: object
          additionalProperties:
            type: string
          description: Additional metadata for the binding invocation.
        operation:
          type: string
          description: The operation to perform on the binding (e.g., create, get, delete, list).
externalDocs:
  description: Dapr Actors API Reference
  url: https://docs.dapr.io/reference/api/actors_api/