# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Checkly Public Checks API
  version: 1.0.0
extends: openapi/checkly-checks-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: 18
- target: $.paths['/v1/checks'].get
  update:
    x-apievangelist-phrasing:
      intent: List checks with legacy project fields
      effect: read
      questions:
      - Which checks are in my Checkly account, with the older flat project and logicalId fields?
      - Can I list only my browser checks carrying a particular tag in the v1 check listing?
      - Is there a way to page through all checks whose API URL matches a pattern using the original v1 list?
      instructions:
      - text: List all checks in my account using the v1 endpoint.
      - text: Using the v1 check list, show checks tagged {tag} of type {checkType}.
        slots:
          tag: query.tag
          checkType: query.checkType
      - text: Return page {page} of v1 checks, {limit} per page, whose API URL matches {pattern}.
        slots:
          page: query.page
          limit: query.limit
          pattern: query.apiCheckUrlFilterPattern
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API or browser check (deprecated)
      effect: write
      questions:
      - Is the generic create-a-check endpoint that takes either an API or browser type still usable?
      - What happens on the deprecated combined check create if I'm over my plan's check limit?
      instructions:
      - text: Create a check named {name} of type {checkType} with the deprecated generic create endpoint.
        slots:
          name: requestBody.name
          checkType: requestBody.checkType
      - text: Using the old combined endpoint, add a {checkType} check called {name} that runs every {frequency} minutes.
        slots:
          checkType: requestBody.checkType
          name: requestBody.name
          frequency: requestBody.frequency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/api'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API check
      effect: write
      questions:
      - How do I set up a new API check that monitors an HTTP endpoint?
      - Can a new API check alert me when responses get slower than a set threshold?
      - Does creating an API check fail when I've hit my plan's check limit?
      instructions:
      - text: Create an API check named {name} that requests {request}.
        slots:
          name: requestBody.name
          request: requestBody.request
      - text: Add an API check {name} hitting {request} from {locations} every {frequency} minutes.
        slots:
          name: requestBody.name
          request: requestBody.request
          locations: requestBody.locations
          frequency: requestBody.frequency
      - text: Set up API check {name} on {request} that is degraded after {degradedResponseTime} ms and fails after {maxResponseTime} ms.
        slots:
          name: requestBody.name
          request: requestBody.request
          degradedResponseTime: requestBody.degradedResponseTime
          maxResponseTime: requestBody.maxResponseTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/api/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an API check
      effect: write
      questions:
      - Can I change the request or response time limits on an existing API check?
      - Is it possible to mute or deactivate an API check I already created?
      instructions:
      - text: Update API check {id} to request {request}.
        slots:
          id: path.id
          request: requestBody.request
      - text: Mute API check {id}.
        slots:
          id: path.id
      - text: Change API check {id} to run every {frequency} minutes from {locations}.
        slots:
          id: path.id
          frequency: requestBody.frequency
          locations: requestBody.locations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/browser'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a browser check
      effect: write
      questions:
      - How can I monitor a web page with a Playwright script in Checkly?
      - What script does a new browser check need to run?
      instructions:
      - text: 'Create a browser check named {name} that runs this script: {script}.'
        slots:
          name: requestBody.name
          script: requestBody.script
      - text: Add browser check {name} running {script} every {frequency} minutes from {locations}.
        slots:
          name: requestBody.name
          script: requestBody.script
          frequency: requestBody.frequency
          locations: requestBody.locations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/browser/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a browser check
      effect: write
      questions:
      - Can I replace the script of an existing browser check?
      - Which settings of a browser check can be edited after it is created?
      instructions:
      - text: Update browser check {id} to run the script {script}.
        slots:
          id: path.id
          script: requestBody.script
      - text: Deactivate browser check {id}.
        slots:
          id: path.id
      - text: Tag browser check {id} with {tags}.
        slots:
          id: path.id
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/dns'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a DNS monitor
      effect: write
      questions:
      - How do I monitor that a domain's DNS records resolve correctly?
      - Can a DNS monitor alert me when lookups take too long?
      instructions:
      - text: Create a DNS monitor named {name} for the lookup {request}.
        slots:
          name: requestBody.name
          request: requestBody.request
      - text: Add DNS monitor {name} checking {request} every {frequency} minutes.
        slots:
          name: requestBody.name
          request: requestBody.request
          frequency: requestBody.frequency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/multistep'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a multi-step check
      effect: write
      questions:
      - Can I chain several API calls into a single scripted check?
      - What does a multi-step check need to be created?
      instructions:
      - text: Create a multi-step check named {name} with the script {script}.
        slots:
          name: requestBody.name
          script: requestBody.script
      - text: Add multi-step check {name} running {script} from {locations}.
        slots:
          name: requestBody.name
          script: requestBody.script
          locations: requestBody.locations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/multistep/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a multi-step check
      effect: write
      questions:
      - Can I edit the script of a multi-step check I already have?
      - Is it possible to move an existing multi-step check into a check group?
      instructions:
      - text: Update multi-step check {id} to use the script {script}.
        slots:
          id: path.id
          script: requestBody.script
      - text: Move multi-step check {id} into group {groupId}.
        slots:
          id: path.id
          groupId: requestBody.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/tcp'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a TCP check
      effect: write
      questions:
      - How can I monitor whether a TCP port on my server accepts connections?
      - Can a TCP check flag slow connections as degraded?
      instructions:
      - text: Create a TCP check named {name} for {request}.
        slots:
          name: requestBody.name
          request: requestBody.request
      - text: Add TCP check {name} on {request} that fails after {maxResponseTime} ms.
        slots:
          name: requestBody.name
          request: requestBody.request
          maxResponseTime: requestBody.maxResponseTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/tcp/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a TCP check
      effect: write
      questions:
      - Can I change the host or port an existing TCP check connects to?
      - Is there a way to pause a TCP check without deleting it?
      instructions:
      - text: Update TCP check {id} to connect to {request}.
        slots:
          id: path.id
          request: requestBody.request
      - text: Deactivate TCP check {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a check with legacy project fields
      effect: read
      questions:
      - What are the full settings of one check, including the old flat project and logicalId fields?
      - Can the v1 check detail include the checks it depends on?
      instructions:
      - text: Show v1 details for check {id}.
        slots:
          id: path.id
      - text: Get check {id} from the v1 endpoint with its dependencies included.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an API or browser check (deprecated)
      effect: write
      questions:
      - Does the deprecated generic update endpoint still modify API and browser checks?
      - Is there an older single endpoint that updates any check type by its ID?
      instructions:
      - text: Update check {id} through the deprecated generic update endpoint, renaming it to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Use the old combined update to set check {id} frequency to {frequency} minutes.
        slots:
          id: path.id
          frequency: requestBody.frequency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a check and its results
      effect: destructive
      questions:
      - How do I permanently remove a check from my account?
      - Does deleting a check also erase its status and results history?
      instructions:
      - text: Delete check {id}.
        slots:
          id: path.id
      - text: Permanently remove check {id} along with all its results.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/checks'].get
  update:
    x-apievangelist-phrasing:
      intent: List checks with project bindings
      effect: read
      questions:
      - Which projects manage each of my checks when one check belongs to several projects?
      - Can I filter the v2 check list by status or a search term?
      instructions:
      - text: List all checks with their project bindings from the v2 endpoint.
      - text: Search v2 checks for {search} with status {status}.
        slots:
          search: query.search
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/checks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a check with its project bindings
      effect: read
      questions:
      - Which projects is a specific check bound to?
      - Can I fetch one check without the legacy flat project field?
      instructions:
      - text: Show check {id} with every project binding using the v2 endpoint.
        slots:
          id: path.id
      - text: Get the v2 details of check {id} with group settings applied.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/checks'].get
  update:
    x-apievangelist-phrasing:
      intent: List checks with intent constraints
      effect: read
      questions:
      - Can I see the required outcomes and must-preserve constraints for all my checks?
      - What does the newest check list return for check intent?
      instructions:
      - text: List all checks with their intent constraints from the v3 endpoint.
      - text: List v3 checks of type {checkType} tagged {tag}, showing constraints.
        slots:
          checkType: query.checkType
          tag: query.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/checks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a check with its intent constraints
      effect: read
      questions:
      - What REQUIRED_OUTCOME and MUST_PRESERVE constraints does a specific check have?
      - Where do I read one check's intent as typed constraints instead of legacy arrays?
      instructions:
      - text: Show the v3 details and constraints for check {id}.
        slots:
          id: path.id
      - text: Get check {id} from v3 including its dependencies.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'