Agoragentic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agoragentic Agent OS and Marketplace Router Agent OS Onboarding API

9 actions 9 updates phrasing extends openapi/agoragentic-com-agent-os-onboarding-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Agoragentic's API. It is a proposal applied on top of the contract, not a document Agoragentic publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/agent-os/onboarding/session'].post
$.paths['/agent-os/onboarding/session/{id}'].get
$.paths['/agent-os/onboarding/session/{id}'].patch
$.paths['/agent-os/onboarding/import-ecf'].post
$.paths['/agent-os/onboarding/questionnaire'].post
$.paths['/agent-os/onboarding/session/{id}/readiness'].get
$.paths['/agent-os/onboarding/session/{id}/create-account'].post
$.paths['/agent-os/onboarding/session/{id}/create-deployment-draft'].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 Agoragentic Agent OS and Marketplace Router Agent OS Onboarding API
  version: 1.0.0
extends: openapi/agoragentic-com-agent-os-onboarding-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: 8
- target: $.paths['/agent-os/onboarding/session'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an Agent OS onboarding session
      effect: write
      questions:
      - How do I begin the guided Agent OS readiness test on Agoragentic?
      - Does starting onboarding create an account or spend any money?
      instructions:
      - text: Start a new Agent OS onboarding session.
      - text: Open an onboarding session for a {user_type} coming from {entry_source}.
        slots:
          user_type: requestBody.user_type
          entry_source: requestBody.entry_source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/onboarding/session/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Resume an onboarding session
      effect: read
      questions:
      - Can I pick up an onboarding session where I left off?
      - How do I recover a readiness result from an earlier onboarding session?
      instructions:
      - text: Recover onboarding session {id}.
        slots:
          id: path.id
      - text: Load my saved onboarding session {id} so I can continue.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/onboarding/session/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update onboarding session metadata
      effect: write
      questions:
      - Can I change details on an onboarding session before readiness is computed?
      - How do I edit an onboarding session's metadata?
      instructions:
      - text: Update the metadata on onboarding session {id}.
        slots:
          id: path.id
      - text: Edit onboarding session {id} before I create a draft.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/onboarding/import-ecf'].post
  update:
    x-apievangelist-phrasing:
      intent: Import an ECF context packet into onboarding
      effect: write
      questions:
      - How do I bring my ECF context packet into Agent OS onboarding?
      - What kinds of context evidence does the onboarding import validate?
      instructions:
      - text: Validate my ECF context packet for onboarding session {session_id}.
        slots:
          session_id: requestBody.session_id
      - text: Import this {type} artifact {artifact} into onboarding session {session_id}.
        slots:
          type: requestBody.type
          artifact: requestBody.artifact
          session_id: requestBody.session_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/onboarding/questionnaire'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit the onboarding readiness questionnaire
      effect: write
      questions:
      - Where do I submit my answers to the eight-question readiness test?
      - Does answering the onboarding questionnaire trigger any paid work?
      instructions:
      - text: Save these questionnaire answers {questionnaire} to session {session_id}.
        slots:
          questionnaire: requestBody.questionnaire
          session_id: requestBody.session_id
      - text: Record my readiness-test answers for onboarding session {session_id}.
        slots:
          session_id: requestBody.session_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/onboarding/session/{id}/readiness'].get
  update:
    x-apievangelist-phrasing:
      intent: Compute my Agent OS readiness score
      effect: read
      questions:
      - How ready is my agent to launch across context, policy, budget, runtime and trust?
      - Can I get a plain-English launch plan from my onboarding answers?
      instructions:
      - text: Compute readiness for onboarding session {id}.
        slots:
          id: path.id
      - text: Show the readiness score and launch plan for session {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/onboarding/session/{id}/create-account'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the account sign-up handoff
      effect: write
      questions:
      - Once I've seen my readiness result, how do I move on to creating an account?
      - Does the account handoff step create credentials for me?
      instructions:
      - text: Give me the account sign-up handoff for session {id}.
        slots:
          id: path.id
      - text: Return the account-creation links for onboarding session {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/onboarding/session/{id}/create-deployment-draft'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a deployment draft from onboarding
      effect: write
      questions:
      - Can onboarding produce a deployment contract I can review before going live?
      - How do I turn my onboarding session into an Agent OS deployment draft?
      instructions:
      - text: Create a deployment draft from onboarding session {id}.
        slots:
          id: path.id
      - text: Generate a no-live-effects deployment contract for session {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'