# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Palo Alto Networks Custom Attack API
  version: 1.0.0
extends: openapi/palo-alto-networks-customattack-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: 27
- target: $.paths['/v1/custom-attacks/report/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the full custom attack report for a job
      effect: read
      questions:
      - Where can I see the complete report for an AI red-teaming custom attack job?
      - What does the comprehensive custom attack report include for a finished scan?
      instructions:
      - text: Get the full custom attack report for job {job_id}.
        slots:
          job_id: path.job_id
      - text: Pull the overall custom attack report summary for red-team job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attacks/report/{job_id}/prompt-sets'].get
  update:
    x-apievangelist-phrasing:
      intent: List prompt sets in a custom attack report
      effect: read
      questions:
      - Which prompt sets were run as part of a custom attack job report?
      - Can I show only the prompt sets that produced threats in a custom attack report?
      - Is it possible to page through the prompt sets of a custom attack report?
      instructions:
      - text: List the prompt sets in the custom attack report for job {job_id}.
        slots:
          job_id: path.job_id
      - text: Show only the threat-flagged prompt sets from report {job_id}, first {limit}.
        slots:
          job_id: path.job_id
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attacks/report/{job_id}/prompt-set/{prompt_set_id}/prompts'].get
  update:
    x-apievangelist-phrasing:
      intent: List report prompts for one prompt set
      effect: read
      questions:
      - What prompts from a single prompt set were used in a custom attack report?
      - Can I filter a prompt set's report prompts down to only the ones flagged as threats?
      instructions:
      - text: List the prompts from prompt set {prompt_set_id} in custom attack report {job_id}.
        slots:
          prompt_set_id: path.prompt_set_id
          job_id: path.job_id
      - text: Show threat prompts only for set {prompt_set_id} in report {job_id}.
        slots:
          prompt_set_id: path.prompt_set_id
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attacks/report/{job_id}/prompt/{prompt_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one prompt in an attack report
      effect: read
      questions:
      - How do I see the full detail for one prompt in a custom attack report?
      - What information does the report keep about an individual attack prompt?
      instructions:
      - text: Get the detail for prompt {prompt_id} in custom attack report {job_id}.
        slots:
          prompt_id: path.prompt_id
          job_id: path.job_id
      - text: Open report prompt {prompt_id} from job {job_id} and show what happened.
        slots:
          prompt_id: path.prompt_id
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attacks/job/{job_id}/list-custom-attacks'].get
  update:
    x-apievangelist-phrasing:
      intent: List the custom attacks run in a job
      effect: read
      questions:
      - Which individual custom attacks were executed in a red-teaming job?
      - Can I filter a job's custom attacks by status, threat, or prompt set?
      - Is there a way to narrow the attacks in a job to one property value?
      instructions:
      - text: List the custom attacks run in job {job_id}.
        slots:
          job_id: path.job_id
      - text: List attacks in job {job_id} with status {status}.
        slots:
          job_id: path.job_id
          status: query.status
      - text: Show attacks in job {job_id} that came from prompt set {prompt_set_id}.
        slots:
          job_id: path.job_id
          prompt_set_id: query.prompt_set_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attacks/job/{job_id}/attack/{attack_id}/list-outputs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the outputs produced by one custom attack
      effect: read
      questions:
      - How do I see what the target model responded with for a specific custom attack?
      - Where are the outputs of an individual attack in a red-teaming job?
      instructions:
      - text: Get the outputs for attack {attack_id} in job {job_id}.
        slots:
          attack_id: path.attack_id
          job_id: path.job_id
      - text: Show me the model responses recorded for attack {attack_id} of job {job_id}.
        slots:
          attack_id: path.attack_id
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attacks/job/{job_id}/property-stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get property-based stats for a custom attack job
      effect: read
      questions:
      - Can I break down a custom attack job's results by prompt property?
      - What statistics per property are available for a red-teaming job?
      instructions:
      - text: Get the property statistics for custom attack job {job_id}.
        slots:
          job_id: path.job_id
      - text: Break down job {job_id} attack results by property.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/custom-prompt-set'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom prompt set
      effect: write
      questions:
      - How do I create my own custom prompt set for AI red teaming?
      - Can I set the language and properties when making a new custom prompt set?
      instructions:
      - text: Create a custom prompt set named {name}.
        slots:
          name: requestBody.name
      - text: Create a prompt set {name} in {language} described as {description}.
        slots:
          name: requestBody.name
          language: requestBody.language
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/list-custom-prompt-sets'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom prompt sets
      effect: read
      questions:
      - What custom prompt sets have I created so far?
      - Can I search my custom prompt sets by name or filter out archived ones?
      - Is it possible to list only prompt sets written in a given language?
      instructions:
      - text: List all my custom prompt sets.
      - text: Search my custom prompt sets for {search}.
        slots:
          search: query.search
      - text: List custom prompt sets in language {language}, {limit} at a time.
        slots:
          language: query.language
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/custom-prompt-set/{prompt_set_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom prompt set
      effect: read
      questions:
      - How can I view one custom prompt set with all its properties?
      - What details are stored on a single custom prompt set?
      instructions:
      - text: Get custom prompt set {prompt_set_uuid}.
        slots:
          prompt_set_uuid: path.prompt_set_uuid
      - text: Show the full details and properties of prompt set {prompt_set_uuid}.
        slots:
          prompt_set_uuid: path.prompt_set_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/custom-prompt-set/{prompt_set_uuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom prompt set
      effect: write
      questions:
      - Can I rename a custom prompt set or change its description?
      - Which properties of an existing prompt set can I edit?
      instructions:
      - text: Rename custom prompt set {prompt_set_uuid} to {name}.
        slots:
          prompt_set_uuid: path.prompt_set_uuid
          name: requestBody.name
      - text: Change the description of prompt set {prompt_set_uuid} to {description}.
        slots:
          prompt_set_uuid: path.prompt_set_uuid
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/custom-prompt-set/{prompt_set_uuid}/archive'].put
  update:
    x-apievangelist-phrasing:
      intent: Archive or unarchive a prompt set
      effect: write
      questions:
      - How do I archive a custom prompt set I no longer use?
      - Can an archived prompt set be restored later?
      instructions:
      - text: Archive custom prompt set {prompt_set_uuid}.
        slots:
          prompt_set_uuid: path.prompt_set_uuid
      - text: Set the archive flag on prompt set {prompt_set_uuid} to {archive}.
        slots:
          prompt_set_uuid: path.prompt_set_uuid
          archive: requestBody.archive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/custom-prompt-set/custom-prompt'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a prompt to a custom prompt set
      effect: write
      questions:
      - Can I add a single attack prompt with a goal to one of my prompt sets?
      - What do I need to supply to create a new prompt inside a prompt set?
      instructions:
      - text: Add the prompt {prompt} to prompt set {prompt_set_id}.
        slots:
          prompt: requestBody.prompt
          prompt_set_id: requestBody.prompt_set_id
      - text: Create a prompt {prompt} in set {prompt_set_id} with the goal {goal}.
        slots:
          prompt: requestBody.prompt
          prompt_set_id: requestBody.prompt_set_id
          goal: requestBody.goal
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/custom-prompt-set/{prompt_set_uuid}/list-custom-prompts'].get
  update:
    x-apievangelist-phrasing:
      intent: List the prompts inside a custom prompt set
      effect: read
      questions:
      - What prompts have I written inside a particular custom prompt set?
      - Can I search the prompts in my prompt set by text?
      instructions:
      - text: List the prompts I've added to custom prompt set {prompt_set_uuid}.
        slots:
          prompt_set_uuid: path.prompt_set_uuid
      - text: Search prompts in my set {prompt_set_uuid} for {search}.
        slots:
          prompt_set_uuid: path.prompt_set_uuid
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/custom-prompt-set/{prompt_set_uuid}/custom-prompt/{prompt_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom prompt from a prompt set
      effect: read
      questions:
      - How can I read back one custom prompt I saved in a prompt set?
      - What fields does a stored custom prompt have?
      instructions:
      - text: Get custom prompt {prompt_uuid} from prompt set {prompt_set_uuid}.
        slots:
          prompt_uuid: path.prompt_uuid
          prompt_set_uuid: path.prompt_set_uuid
      - text: Show the text and goal of my prompt {prompt_uuid} in set {prompt_set_uuid}.
        slots:
          prompt_uuid: path.prompt_uuid
          prompt_set_uuid: path.prompt_set_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/custom-prompt-set/{prompt_set_uuid}/custom-prompt/{prompt_uuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom prompt
      effect: write
      questions:
      - Can I edit the wording or goal of a prompt already in my prompt set?
      - Is it possible to change the properties on an existing custom prompt?
      instructions:
      - text: Change the text of prompt {prompt_uuid} in set {prompt_set_uuid} to {prompt}.
        slots:
          prompt_uuid: path.prompt_uuid
          prompt_set_uuid: path.prompt_set_uuid
          prompt: requestBody.prompt
      - text: Update the goal of custom prompt {prompt_uuid} in set {prompt_set_uuid} to {goal}.
        slots:
          prompt_uuid: path.prompt_uuid
          prompt_set_uuid: path.prompt_set_uuid
          goal: requestBody.goal
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/custom-prompt-set/{prompt_set_uuid}/custom-prompt/{prompt_uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom prompt
      effect: destructive
      questions:
      - How do I remove a prompt from one of my custom prompt sets?
      - Can I delete a single custom prompt without touching the rest of the set?
      instructions:
      - text: Delete prompt {prompt_uuid} from prompt set {prompt_set_uuid}.
        slots:
          prompt_uuid: path.prompt_uuid
          prompt_set_uuid: path.prompt_set_uuid
      - text: Remove custom prompt {prompt_uuid} in set {prompt_set_uuid}.
        slots:
          prompt_uuid: path.prompt_uuid
          prompt_set_uuid: path.prompt_set_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/property-names'].get
  update:
    x-apievangelist-phrasing:
      intent: List available prompt property names
      effect: read
      questions:
      - What property names can I tag my prompt sets with?
      - Which prompt properties already exist in my tenant?
      instructions:
      - text: List all available prompt property names.
      - text: Show me every property name I can use in prompt sets.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/property-names'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new prompt property name
      effect: write
      questions:
      - Can I define a new property name to categorize prompts?
      - What is needed to add a custom property name for prompt sets?
      instructions:
      - text: Create a prompt property name called {name}.
        slots:
          name: requestBody.name
      - text: Add {name} as a new property name for my prompt sets.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/property-values/{property_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: List values for one prompt property
      effect: read
      questions:
      - What values are allowed for a single prompt property?
      - Which values have been defined under one property name?
      instructions:
      - text: List the values defined for property {property_name}.
        slots:
          property_name: path.property_name
      - text: Show all allowed values of the {property_name} property.
        slots:
          property_name: path.property_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/property-values'].get
  update:
    x-apievangelist-phrasing:
      intent: Get values for several prompt properties at once
      effect: read
      questions:
      - Can I fetch the values for several property names in a single request?
      - Is there a bulk way to see values across multiple prompt properties?
      instructions:
      - text: Get the values for property names {property_names} in one call.
        slots:
          property_names: query.property_names
      - text: 'Fetch values for multiple properties together: {property_names}.'
        slots:
          property_names: query.property_names
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/property-values'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a value to a prompt property
      effect: write
      questions:
      - How do I add a new allowed value to an existing prompt property?
      - Can I extend a property name with additional values?
      instructions:
      - text: Add value {property_value} to property {property_name}.
        slots:
          property_value: requestBody.property_value
          property_name: requestBody.property_name
      - text: Create the value {property_value} under the {property_name} property.
        slots:
          property_value: requestBody.property_value
          property_name: requestBody.property_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/upload-custom-prompts-csv'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk upload prompts to a prompt set from CSV
      effect: write
      questions:
      - Can I bulk load custom prompts from a CSV file instead of adding them one by one?
      - What format does the prompt CSV upload expect?
      instructions:
      - text: Upload the CSV {file} of prompts into prompt set {prompt_set_uuid}.
        slots:
          file: requestBody.file
          prompt_set_uuid: query.prompt_set_uuid
      - text: Bulk import prompts from {file} to set {prompt_set_uuid}.
        slots:
          file: requestBody.file
          prompt_set_uuid: query.prompt_set_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/download-template/{prompt_set_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the CSV template for a prompt set
      effect: read
      questions:
      - Where do I get a CSV template matching my prompt set's properties?
      - Is there a starter file I can fill in before uploading prompts?
      instructions:
      - text: Download the CSV template for prompt set {prompt_set_uuid}.
        slots:
          prompt_set_uuid: path.prompt_set_uuid
      - text: Get me the blank prompt upload template for set {prompt_set_uuid}.
        slots:
          prompt_set_uuid: path.prompt_set_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/active-custom-prompt-sets'].get
  update:
    x-apievangelist-phrasing:
      intent: List active prompt sets ready for scans
      effect: read
      questions:
      - Which custom prompt sets are active and ready to be used in scans?
      - Can I see only prompt sets that have a snapshot available to the data plane?
      instructions:
      - text: List the active custom prompt sets available for scanning.
      - text: Show prompt sets that have snapshots and can be used now.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/custom-prompt-set/{prompt_set_uuid}/reference'].get
  update:
    x-apievangelist-phrasing:
      intent: Resolve a prompt set to its latest version
      effect: read
      questions:
      - What is the latest version of a given prompt set?
      - Can I resolve a prompt set to its current reference before starting a scan?
      instructions:
      - text: Resolve the current reference for prompt set {prompt_set_uuid}.
        slots:
          prompt_set_uuid: path.prompt_set_uuid
      - text: Find the latest version of prompt set {prompt_set_uuid}.
        slots:
          prompt_set_uuid: path.prompt_set_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/custom-attack/custom-prompt-set/{prompt_set_uuid}/version-info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get version details for a prompt set
      effect: read
      questions:
      - Can I look up the details of a specific earlier version of a prompt set?
      - What version history information is kept for a prompt set?
      instructions:
      - text: Get version {version} info for prompt set {prompt_set_uuid}.
        slots:
          version: query.version
          prompt_set_uuid: path.prompt_set_uuid
      - text: Show version information for prompt set {prompt_set_uuid}.
        slots:
          prompt_set_uuid: path.prompt_set_uuid
      method: generated
      generated: '2026-09-26'