# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snyk AI Bom API
  version: 1.0.0
extends: openapi/snyk-aibom-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['/orgs/{org_id}/ai_bom_jobs/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of an AI-BOM job
      effect: read
      questions:
      - Has my AI bill of materials finished generating yet?
      - What status does an AI-BOM background job report?
      instructions:
      - text: Check AI-BOM job {job_id} in org {org_id}.
        slots:
          job_id: path.job_id
          org_id: path.org_id
      - text: Poll the status of AI-BOM generation job {job_id} for organization {org_id}.
        slots:
          job_id: path.job_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/ai_boms'].post
  update:
    x-apievangelist-phrasing:
      intent: Start generating an AI-BOM
      effect: write
      questions:
      - How do I generate an AI bill of materials for my code?
      - Does creating an AI-BOM run as a background job I need to poll?
      instructions:
      - text: Start a new AI-BOM for org {org_id}.
        slots:
          org_id: path.org_id
      - text: Kick off AI bill of materials generation in organization {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/ai_boms/upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an AI-BOM from a file bundle and store it
      effect: write
      questions:
      - Can I upload a file bundle and have Snyk build and save an AI-BOM for a repo?
      - What's needed to persist an AI-BOM for later retrieval and testing?
      instructions:
      - text: Upload this file bundle and store an AI-BOM for my repo in org {org_id}.
        slots:
          org_id: path.org_id
      - text: Create and persist an AI-BOM from uploaded files for organization {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/ai_boms/{ai_bom_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a finished AI-BOM
      effect: read
      questions:
      - Where do I download the AI-BOM once its job is done?
      - Can I retrieve a completed AI bill of materials by ID?
      instructions:
      - text: Get AI-BOM {ai_bom_id} from org {org_id}.
        slots:
          ai_bom_id: path.ai_bom_id
          org_id: path.org_id
      - text: Fetch the completed AI bill of materials {ai_bom_id} for organization {org_id}.
        slots:
          ai_bom_id: path.ai_bom_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'