Relevance AI · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Relevance AI Endpoints Syncs API

6 actions 6 updates phrasing extends openapi/relevance-ai-syncs-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 6

$.info

$.paths['/syncs/items/{document_id}/get'].get

$.paths['/syncs/items/{document_id}'].delete

$.paths['/syncs/list'].post

$.paths['/syncs/items/{document_id}/upsert'].post

$.paths['/syncs/items/{document_id}/trigger'].post

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 Relevance AI Endpoints Syncs API
  version: 1.0.0
extends: openapi/relevance-ai-syncs-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: 5
- target: $.paths['/syncs/items/{document_id}/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sync configuration
      effect: read
      questions:
      - How do I look up one sync by its id?
      - Can I return only selected fields of a sync configuration?
      instructions:
      - text: Get sync {document_id}.
        slots:
          document_id: path.document_id
      - text: Show fields {select_fields} of sync {document_id}.
        slots:
          select_fields: query.select_fields
          document_id: path.document_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/syncs/items/{document_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sync
      effect: destructive
      questions:
      - How do I delete a sync I set up?
      - Does removing a sync configuration stop it for good?
      instructions:
      - text: Delete sync {document_id}.
        slots:
          document_id: path.document_id
      - text: Remove the sync configuration {document_id}.
        slots:
          document_id: path.document_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/syncs/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List syncs
      effect: read
      questions:
      - What syncs are configured in my Relevance AI project?
      - Can I filter and page through my sync configurations?
      instructions:
      - text: List all my syncs.
      - text: List syncs matching {query}, {page_size} per page.
        slots:
          query: requestBody.query
          page_size: requestBody.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/syncs/items/{document_id}/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a sync
      effect: write
      questions:
      - How do I change the settings of an existing sync?
      - Can I create a new sync configuration with an id I choose?
      instructions:
      - text: Update sync {document_id} with {data}.
        slots:
          document_id: path.document_id
          data: requestBody.data
      - text: Upsert sync {document_id} using {data}.
        slots:
          document_id: path.document_id
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/syncs/items/{document_id}/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a sync now
      effect: write
      questions:
      - How do I kick off a whole sync manually instead of waiting for its schedule?
      - Can I override a sync's config for a single run?
      instructions:
      - text: Trigger sync {document_id} now.
        slots:
          document_id: path.document_id
      - text: Run sync {document_id} with config override {config_override}.
        slots:
          document_id: path.document_id
          config_override: requestBody.config_override
      method: generated
      generated: '2026-09-26'