Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote Companies Compliance API

3 actions 3 updates phrasing extends openapi/remote-com-compliance-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['/companies/{company_id}/compliance_profile'].get

$.paths['/companies/{company_id}/employment_onboarding_reserves_status'].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 Remote Companies Compliance API
  version: 1.0.0
extends: openapi/remote-com-compliance-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['/companies/{company_id}/compliance_profile'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a company's compliance profile
      effect: read
      questions:
      - Is my company eligible to hire right now, based on compliance signals?
      - What does Remote's compliance profile say about a company?
      instructions:
      - text: Show the compliance profile of company {company_id}.
        slots:
          company_id: path.company_id
      - text: Check hiring eligibility signals for company {company_id}.
        slots:
          company_id: path.company_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/companies/{company_id}/employment_onboarding_reserves_status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check EOR onboarding reserve status
      effect: read
      questions:
      - Has my reserve payment cleared so I can onboard new EOR hires?
      - Why are new employer-of-record hires blocked for my company?
      instructions:
      - text: Show the onboarding reserves status for company {company_id}.
        slots:
          company_id: path.company_id
      - text: Check whether company {company_id} has paid the reserve needed for new EOR hires.
        slots:
          company_id: path.company_id
      method: generated
      generated: '2026-09-26'