Agorapulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agorapulse Conversations API

2 actions 2 updates phrasing extends openapi/agorapulse-conversations-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}/accounts/{accountUid}/conversations/{conversationId}/messages'].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 Conversations API
  version: 1.0.0
extends: openapi/agorapulse-conversations-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}/accounts/{accountUid}/conversations/{conversationId}/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the messages in an inbox conversation
      effect: read
      questions:
      - How do I pull the full message history of a private conversation in my social inbox?
      - Can I page through conversation messages oldest first?
      - What is the maximum number of conversation messages returned per page?
      instructions:
      - text: Get the messages in conversation {conversation} on account {account} in workspace {workspace}, org {org}.
        slots:
          conversation: path.conversationId
          account: path.accountUid
          workspace: path.workspaceId
          org: path.organizationId
      - text: Show messages from conversation {conversation} on account {account} sent between {since} and {until} (workspace {workspace}, org {org}).
        slots:
          conversation: path.conversationId
          account: path.accountUid
          since: query.since
          until: query.until
          workspace: path.workspaceId
          org: path.organizationId
      - text: List the last {limit} messages of conversation {conversation}, newest first, for account {account} in workspace {workspace}, org {org}.
        slots:
          limit: query.limit
          conversation: path.conversationId
          account: path.accountUid
          workspace: path.workspaceId
          org: path.organizationId
      method: generated
      generated: '2026-10-01'