Agorapulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agorapulse Items API

2 actions 2 updates phrasing extends openapi/agorapulse-items-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Agorapulse's API. It is a proposal applied on top of the contract, not a document Agorapulse publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/v1.0/inbox/organizations/{organizationId}/workspaces/{workspaceId}/items'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Agorapulse Items API
  version: 1.0.0
extends: openapi/agorapulse-items-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/v1.0/inbox/organizations/{organizationId}/workspaces/{workspaceId}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: Find inbox items like comments and messages
      effect: read
      questions:
      - How can I find social comments in my inbox that still need a manager's review?
      - Can I filter inbox items by sentiment or label?
      - Which inbox items came in on specific accounts this week?
      - What is the page size limit when listing inbox items?
      instructions:
      - text: Find inbox items in workspace {workspace} of org {org}.
        slots:
          workspace: path.workspaceId
          org: path.organizationId
      - text: Show inbox items awaiting review on accounts {accounts} in workspace {workspace}, org {org}.
        slots:
          accounts: query.accountUids
          workspace: path.workspaceId
          org: path.organizationId
      - text: List inbox items with sentiment {sentiments} received from {since} to {until} in workspace {workspace}, org {org}.
        slots:
          sentiments: query.sentiments
          since: query.since
          until: query.until
          workspace: path.workspaceId
          org: path.organizationId
      - text: Get inbox items of type {types} labeled {labels} in workspace {workspace}, org {org}.
        slots:
          types: query.types
          labels: query.labels
          workspace: path.workspaceId
          org: path.organizationId
      method: generated
      generated: '2026-10-01'