Relevance AI · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Relevance AI Endpoints Sync API

9 actions 9 updates phrasing extends openapi/relevance-ai-sync-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Relevance AI's API. It is a proposal applied on top of the contract, not a document Relevance AI publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/sync/template/{sync_template_id}'].delete
$.paths['/sync/config/list'].get
$.paths['/sync/templates/list'].get
$.paths['/sync/template/{sync_template_id}/invite/create'].post
$.paths['/sync/template/{sync_template_id}/invite/status'].get
$.paths['/sync/invites'].get
$.paths['/sync/invite/{invite_id}/cancel'].post
$.paths['/sync/invite/{invite_id}/reject'].post

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 Relevance AI Endpoints Sync API
  version: 1.0.0
extends: openapi/relevance-ai-sync-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/sync/template/{sync_template_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sync template
      effect: destructive
      questions:
      - How do I delete a sync template I set up?
      - Can I remove a sync template by its display id?
      instructions:
      - text: Delete sync template {sync_template_id}.
        slots:
          sync_template_id: path.sync_template_id
      - text: Remove the sync template with display id {sync_template_id}.
        slots:
          sync_template_id: path.sync_template_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/config/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List sync configs
      effect: read
      questions:
      - What sync configs are set up in my account?
      - Can I list only the sync configs for one provider?
      instructions:
      - text: List all sync configs.
      - text: Show sync configs for provider {provider}.
        slots:
          provider: query.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/templates/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's sync templates
      effect: read
      questions:
      - Which sync templates does this project have?
      - Can I filter the project's sync templates?
      instructions:
      - text: List the sync templates in this project.
      - text: Show sync templates matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/template/{sync_template_id}/invite/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite users to connect accounts to an agent trigger
      effect: write
      questions:
      - How do I ask teammates to connect their own accounts to an agent trigger?
      - Can I invite people by email to link accounts for a sync template?
      instructions:
      - text: Invite {emails} to connect their accounts to agent trigger template {sync_template_id}.
        slots:
          emails: requestBody.emails
          sync_template_id: path.sync_template_id
      - text: Send account-connection invites for sync template {sync_template_id} to {emails}.
        slots:
          sync_template_id: path.sync_template_id
          emails: requestBody.emails
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/template/{sync_template_id}/invite/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check invite status for a sync template
      effect: read
      questions:
      - Have the people I invited to a sync template connected their accounts yet?
      - What is the status of invites sent for an agent trigger template?
      instructions:
      - text: Show the invite status for sync template {sync_template_id}.
        slots:
          sync_template_id: path.sync_template_id
      - text: Check who has accepted invites to template {sync_template_id}.
        slots:
          sync_template_id: path.sync_template_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/invites'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my pending sync invites
      effect: read
      questions:
      - Do I have any pending invites to connect my accounts to an agent trigger?
      - Which sync invites are waiting on me right now?
      instructions:
      - text: List my pending sync invites.
      - text: Show sync invites I still need to respond to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/invite/{invite_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending sync invite
      effect: destructive
      questions:
      - Can I withdraw a sync invite I sent before it's accepted?
      - Who is allowed to cancel a pending sync invite?
      instructions:
      - text: Cancel sync invite {invite_id}.
        slots:
          invite_id: path.invite_id
      - text: Withdraw the pending invite {invite_id} I sent.
        slots:
          invite_id: path.invite_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/invite/{invite_id}/reject'].post
  update:
    x-apievangelist-phrasing:
      intent: Reject a sync invite I received
      effect: destructive
      questions:
      - How do I decline an invite to connect my account to someone's agent trigger?
      - Can I turn down a sync invite sent to me?
      instructions:
      - text: Reject sync invite {invite_id}.
        slots:
          invite_id: path.invite_id
      - text: Decline the invite {invite_id} to connect my account.
        slots:
          invite_id: path.invite_id
      method: generated
      generated: '2026-09-26'