Ada · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Knowledge Audit Log API

2 actions 2 updates phrasing extends openapi/ada-audit-log-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Ada's API. It is a proposal applied on top of the contract, not a document Ada publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/v2/analytics/audit-log/events/'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Knowledge Audit Log API
  version: 1.0.0
extends: openapi/ada-audit-log-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['/v2/analytics/audit-log/events/'].get
  update:
    x-apievangelist-phrasing:
      intent: Pull the account's audit log events
      effect: read
      questions:
      - How can I pull my Ada account's audit log into our SIEM?
      - What is the longest time window I can request audit log events for at once?
      - Who changed settings on my AI Agent account last week, according to the audit log?
      instructions:
      - text: Fetch audit log events starting from {start_date}.
        slots:
          start_date: query.start_date
      - text: Export audit log events between {start_date} and {end_date}, {limit} per page.
        slots:
          start_date: query.start_date
          end_date: query.end_date
          limit: query.limit
      - text: Continue reading the audit log from {start_date} using cursor {cursor}.
        slots:
          start_date: query.start_date
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'