Instagram · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Instagram Graph Media API

7 actions 7 updates phrasing extends openapi/instagram-media-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 7

$.info
$.paths['/{user_id}/media'].get
$.paths['/{user_id}/stories'].get
$.paths['/{media_id}'].get
$.paths['/{media_id}'].post
$.paths['/{media_id}'].delete
$.paths['/{media_id}/children'].get

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 Media API
  version: 1.0.0
extends: openapi/instagram-media-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: 6
- target: $.paths['/{user_id}/media'].get
  update:
    x-apievangelist-phrasing:
      intent: List the posts published on an account
      effect: read
      questions:
      - How do I list everything an Instagram account has posted?
      - Can I page through an account's posts a set number at a time?
      - Which feed posts has my business account published so far?
      instructions:
      - text: List the media published by account {user_id}.
        slots:
          user_id: path.user_id
      - text: Get {limit} posts from account {user_id} starting after cursor {after}.
        slots:
          limit: query.limit
          user_id: path.user_id
          after: query.after
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{user_id}/stories'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's stories
      effect: read
      questions:
      - How can I fetch the stories currently on my Instagram account?
      - Can I retrieve story media separately from regular feed posts?
      instructions:
      - text: List the stories on account {user_id}.
        slots:
          user_id: path.user_id
      - text: Get the stories for account {user_id} with fields {fields}.
        slots:
          user_id: path.user_id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{media_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a photo, video, reel or album
      effect: read
      questions:
      - How do I look up the caption, type and permalink of a single post by its media ID?
      - What fields can I read on one Instagram reel or album?
      instructions:
      - text: Show me media {media_id}.
        slots:
          media_id: path.media_id
      - text: Fetch fields {fields} for post {media_id}.
        slots:
          fields: query.fields
          media_id: path.media_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{media_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn comments on or off for a post
      effect: write
      questions:
      - Can I disable commenting on a post that's attracting trolls?
      - Is there a way to re-enable comments on a post where I switched them off?
      instructions:
      - text: Turn off comments on post {media_id}.
        slots:
          media_id: path.media_id
      - text: Set comment_enabled to {comment_enabled} on media {media_id}.
        slots:
          comment_enabled: requestBody.comment_enabled
          media_id: path.media_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{media_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a post, story, reel or carousel
      effect: destructive
      questions:
      - How do I take down a post I published by mistake?
      - Can I delete a reel or carousel through the API?
      instructions:
      - text: Delete media {media_id}.
        slots:
          media_id: path.media_id
      - text: Permanently remove post {media_id} from the account.
        slots:
          media_id: path.media_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{media_id}/children'].get
  update:
    x-apievangelist-phrasing:
      intent: List the items inside a carousel album
      effect: read
      questions:
      - How do I get the individual photos and videos inside a carousel post?
      - What media items make up a particular album on Instagram?
      instructions:
      - text: List the children of carousel {media_id}.
        slots:
          media_id: path.media_id
      - text: Get each item in album {media_id} with fields {fields}.
        slots:
          media_id: path.media_id
          fields: query.fields
      method: generated
      generated: '2026-10-01'