Relevance AI · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Relevance AI Endpoints Agent Runtime Events API

5 actions 5 updates phrasing extends openapi/relevance-ai-agent-runtime-events-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['/agent-runtime-events/collections/{collection_id}/items/{document_id}/get'].get
$.paths['/agent-runtime-events/collections/{collection_id}/items/{document_id}'].delete
$.paths['/agent-runtime-events/collections/{collection_id}/list'].post
$.paths['/agent-runtime-events/collections/{collection_id}/items/{document_id}/upsert'].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 Agent Runtime Events API
  version: 1.0.0
extends: openapi/relevance-ai-agent-runtime-events-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['/agent-runtime-events/collections/{collection_id}/items/{document_id}/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one agent runtime event
      effect: read
      questions:
      - Can I look up a single agent runtime event by its document id?
      - Which fields of an agent runtime event can I choose to return?
      instructions:
      - text: Get runtime event {document_id} from collection {collection_id}.
        slots:
          document_id: path.document_id
          collection_id: path.collection_id
      - text: Fetch only {select_fields} of runtime event {document_id} in {collection_id}.
        slots:
          select_fields: query.select_fields
          document_id: path.document_id
          collection_id: path.collection_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-runtime-events/collections/{collection_id}/items/{document_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an agent runtime event
      effect: destructive
      questions:
      - How do I delete a recorded agent runtime event?
      - Can a deleted agent runtime event be recovered?
      instructions:
      - text: Delete runtime event {document_id} from collection {collection_id}.
        slots:
          document_id: path.document_id
          collection_id: path.collection_id
      - text: Remove agent runtime event {document_id} in {collection_id}.
        slots:
          document_id: path.document_id
          collection_id: path.collection_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-runtime-events/collections/{collection_id}/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List agent runtime events in a collection
      effect: read
      questions:
      - What runtime events have my agents recorded in a collection?
      - Can I query and sort agent runtime events instead of paging through all of them?
      instructions:
      - text: List the agent runtime events in collection {collection_id}.
        slots:
          collection_id: path.collection_id
      - text: Show runtime events in {collection_id} sorted by {sort}.
        slots:
          collection_id: path.collection_id
          sort: requestBody.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-runtime-events/collections/{collection_id}/items/{document_id}/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update an agent runtime event
      effect: write
      questions:
      - Can I write an agent runtime event record that is created if missing?
      - How do I replace specific fields on an existing agent runtime event?
      instructions:
      - text: Upsert runtime event {document_id} in collection {collection_id} with {data}.
        slots:
          document_id: path.document_id
          collection_id: path.collection_id
          data: requestBody.data
      - text: Replace fields {fields_to_replace} on runtime event {document_id} in {collection_id}.
        slots:
          fields_to_replace: requestBody.fields_to_replace
          document_id: path.document_id
          collection_id: path.collection_id
      method: generated
      generated: '2026-09-26'