Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote And Custom Fields Files API

3 actions 3 updates phrasing extends openapi/remote-com-files-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Remote's API. It is a proposal applied on top of the contract, not a document Remote publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/files'].post
$.paths['/files/{file_id}'].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 Remote And Custom Fields Files API
  version: 1.0.0
extends: openapi/remote-com-files-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: 2
- target: $.paths['/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file to a record
      effect: write
      questions:
      - How do I attach a document to an employment or other record?
      - Can I categorize a file when I upload it?
      instructions:
      - text: Upload {file} and attach it to {attachable_type} {attachable_id}.
        slots:
          file: requestBody.file
          attachable_type: requestBody.attachable_type
          attachable_id: requestBody.attachable_id
      - text: Attach {file} to {attachable_type} {attachable_id} in category {category}.
        slots:
          file: requestBody.file
          attachable_type: requestBody.attachable_type
          attachable_id: requestBody.attachable_id
          category: requestBody.category
      method: generated
      generated: '2026-09-26'
- target: $.paths['/files/{file_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a file
      effect: read
      questions:
      - How do I download a document that was uploaded to Remote?
      - Can I retrieve a stored file by its id?
      instructions:
      - text: Download file {file_id}.
        slots:
          file_id: path.file_id
      - text: Fetch the contents of file {file_id}.
        slots:
          file_id: path.file_id
      method: generated
      generated: '2026-09-26'