Instagram · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Instagram Graph Comments API

8 actions 8 updates phrasing extends openapi/instagram-comments-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Instagram's API. It is a proposal applied on top of the contract, not a document Instagram publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/{media_id}/comments'].get
$.paths['/{media_id}/comments'].post
$.paths['/{comment_id}'].get
$.paths['/{comment_id}'].post
$.paths['/{comment_id}'].delete
$.paths['/{comment_id}/replies'].get
$.paths['/{comment_id}/replies'].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 Instagram Graph Comments API
  version: 1.0.0
extends: openapi/instagram-comments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/{media_id}/comments'].get
  update:
    x-apievangelist-phrasing:
      intent: List the comments on a post
      effect: read
      questions:
      - How do I pull all the comments people left on one of my Instagram posts?
      - Can I choose which comment fields come back when listing a post's comments?
      - What are followers saying under a specific photo or reel I published?
      instructions:
      - text: List the comments on media {media_id}.
        slots:
          media_id: path.media_id
      - text: Get the comments under post {media_id} with only the fields {fields}.
        slots:
          media_id: path.media_id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{media_id}/comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Post a new comment on a media item
      effect: write
      questions:
      - Can I leave a top-level comment on an Instagram post through the API?
      - Is it possible to comment on my own photo programmatically rather than in the app?
      instructions:
      - text: Comment "{message}" on media {media_id}.
        slots:
          message: requestBody.message
          media_id: path.media_id
      - text: Add a new top-level comment to post {media_id} saying {message}.
        slots:
          media_id: path.media_id
          message: requestBody.message
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{comment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a single comment
      effect: read
      questions:
      - How do I fetch the details of one specific comment by its ID?
      - Which fields can I read on an individual Instagram comment, like its text or timestamp?
      instructions:
      - text: Show me comment {comment_id}.
        slots:
          comment_id: path.comment_id
      - text: Fetch the fields {fields} for comment {comment_id}.
        slots:
          fields: query.fields
          comment_id: path.comment_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{comment_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Hide or unhide a comment on my media
      effect: write
      questions:
      - Can I hide an abusive comment on my post without deleting it?
      - Is there a way to bring back a comment I previously hid from view?
      instructions:
      - text: Hide comment {comment_id} on my media.
        slots:
          comment_id: path.comment_id
      - text: Set the hidden state of comment {comment_id} to {hide}.
        slots:
          comment_id: path.comment_id
          hide: requestBody.hide
      - text: Unhide comment {comment_id} so it is visible again.
        slots:
          comment_id: path.comment_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{comment_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment from my media
      effect: destructive
      questions:
      - How do I permanently remove a spam comment from one of my posts?
      - Can I delete someone else's comment if it's on my own media?
      instructions:
      - text: Delete comment {comment_id}.
        slots:
          comment_id: path.comment_id
      - text: Permanently remove comment {comment_id} from my post.
        slots:
          comment_id: path.comment_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{comment_id}/replies'].get
  update:
    x-apievangelist-phrasing:
      intent: List the replies to a comment
      effect: read
      questions:
      - How can I see the threaded replies under a particular comment?
      - What responses has a comment on my post received?
      instructions:
      - text: List the replies to comment {comment_id}.
        slots:
          comment_id: path.comment_id
      - text: Get the reply thread under comment {comment_id} with fields {fields}.
        slots:
          comment_id: path.comment_id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{comment_id}/replies'].post
  update:
    x-apievangelist-phrasing:
      intent: Reply to a comment
      effect: write
      questions:
      - Can I respond directly to a follower's comment instead of posting a new top-level one?
      - How do I answer a customer question left as a comment on my Instagram post?
      instructions:
      - text: Reply "{message}" to comment {comment_id}.
        slots:
          message: requestBody.message
          comment_id: path.comment_id
      - text: Answer comment {comment_id} in its thread with {message}.
        slots:
          comment_id: path.comment_id
          message: requestBody.message
      method: generated
      generated: '2026-10-01'