Relevance AI · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Relevance AI Endpoints Inventor API

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

$.info

$.paths['/inventor/bootstrap'].get

$.paths['/inventor/user-settings'].get

$.paths['/inventor/user-settings'].post

$.paths['/inventor/tasks/{task_id}/usage'].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 Relevance AI Endpoints Inventor API
  version: 1.0.0
extends: openapi/relevance-ai-inventor-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: 4
- target: $.paths['/inventor/bootstrap'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Inventor startup payload
      effect: read
      questions:
      - Which Inventor tools exist and how is each one classified?
      - Can I see which Inventor tools are write or destructive?
      instructions:
      - text: Get the Inventor bootstrap payload.
      - text: List every Inventor tool with its classification.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inventor/user-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my Inventor settings
      effect: read
      questions:
      - What are my current Inventor settings?
      - Can I check how Inventor is configured for my user?
      instructions:
      - text: Show my Inventor user settings.
      - text: Get the Inventor preferences for the current user.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inventor/user-settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Update my Inventor settings
      effect: write
      questions:
      - How do I change my Inventor preferences?
      - Can I save new Inventor settings for just my user?
      instructions:
      - text: Update my Inventor settings to {settings}.
        slots:
          settings: requestBody.settings
      - text: 'Save these Inventor preferences for me: {settings}.'
        slots:
          settings: requestBody.settings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inventor/tasks/{task_id}/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get credit usage for an Inventor task
      effect: read
      questions:
      - How many credits did an Inventor task use?
      - Does Inventor task usage include its direct subagents?
      instructions:
      - text: Get credit usage for Inventor task {task_id}.
        slots:
          task_id: path.task_id
      - text: Show credits spent by task {task_id} and its subagents.
        slots:
          task_id: path.task_id
      method: generated
      generated: '2026-09-26'