find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/chirpwireless-io:chirpwireless-io-widget-grpc-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Chirpwireless Io Widget (gRPC) API
  version: 1.0.0
  description: 'Operations tagged Widget (gRPC) across 2 of this provider''s published API definitions: chirpwireless-io-openapi.yaml, chirpwireless-io-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.chirpwireless.io
  description: Chirp API
security:
- ApiKeyAuth: []
  OrgId: []
tags:
- name: Widget (gRPC)
  description: gRPC service `widget.v2.WidgetService` — use a gRPC client to call these methods.
paths:
  /widget.v2.WidgetService/GetWidgetsByIds:
    post:
      operationId: grpc_risGetWidgetsByIds
      summary: Get widgets
      description: 'Retrieve widget definitions by their IDs.


        **Protocol:** gRPC


        **Service:** `widget.v2.WidgetService`


        **Method:** `GetWidgetsByIds`


        **Required scope:** `dashboards:read`'
      tags:
      - Widget (gRPC)
      requestBody:
        required: true
        content:
          application/grpc:
            schema:
              type: object
              description: Protobuf-encoded `GetWidgetsByIdsRequest` message. Refer to the service proto definition for field details.
      responses:
        '200':
          description: Successful gRPC response
          content:
            application/grpc:
              schema:
                type: object
                description: Protobuf-encoded `GetWidgetsByIdsResponse` message.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    servers:
    - url: https://api.chirpwireless.io
      description: Chirp API
  /widget.v2.WidgetService/CreateWidget:
    post:
      operationId: grpc_risCreateWidget
      summary: Create widget
      description: 'Add a widget to a dashboard.


        **Protocol:** gRPC


        **Service:** `widget.v2.WidgetService`


        **Method:** `CreateWidget`


        **Required scope:** `dashboards:write`'
      tags:
      - Widget (gRPC)
      requestBody:
        required: true
        content:
          application/grpc:
            schema:
              type: object
              description: Protobuf-encoded `CreateWidgetRequest` message. Refer to the service proto definition for field details.
      responses:
        '200':
          description: Successful gRPC response
          content:
            application/grpc:
              schema:
                type: object
                description: Protobuf-encoded `CreateWidgetResponse` message.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    servers:
    - url: https://api.chirpwireless.io
      description: Chirp API
  /widget.v2.WidgetService/UpdateWidget:
    post:
      operationId: grpc_risUpdateWidget
      summary: Update widget
      description: 'Update widget type or configuration.


        **Protocol:** gRPC


        **Service:** `widget.v2.WidgetService`


        **Method:** `UpdateWidget`


        **Required scope:** `dashboards:write`'
      tags:
      - Widget (gRPC)
      requestBody:
        required: true
        content:
          application/grpc:
            schema:
              type: object
              description: Protobuf-encoded `UpdateWidgetRequest` message. Refer to the service proto definition for field details.
      responses:
        '200':
          description: Successful gRPC response
          content:
            application/grpc:
              schema:
                type: object
                description: Protobuf-encoded `UpdateWidgetResponse` message.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    servers:
    - url: https://api.chirpwireless.io
      description: Chirp API
components:
  schemas:
    Error:
      type: object
      required:
      - error
      - message
      properties:
        error:
          type: string
        message:
          type: string
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthenticated
            message: missing X-API-Key header
    Forbidden:
      description: Insufficient permissions (missing required scope)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: permission_denied
            message: 'API key lacks required scope: devices:write'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'API key for authentication (format: `chirp_<key>`)'
    OrgId:
      type: apiKey
      in: header
      name: X-Organization-Id
      description: Organization UUID that the API key belongs to
x-refined-from:
- chirpwireless-io-openapi.yaml
- chirpwireless-io-openapi.yml
x-tagGroups:
- name: REST API
  tags:
  - Users
  - Devices
  - Sensors
  - Commands
  - Telemetry
  - Connections
  - Connectors
  - Dashboards
  - Orgs
  - Subscriptions
  - Api-Keys
  - Rules
- name: On-Prem / Advanced (gRPC)
  tags:
  - User Profile (gRPC)
  - Digital Device (gRPC)
  - Sensor Template (gRPC)
  - Connector (gRPC)
  - Connection (gRPC)
  - Dashboard (gRPC)
  - Widget (gRPC)
  - Actuator Command (gRPC)
  - Sensor Query (gRPC)
  - Organizations (gRPC)
  - Access Control (gRPC)