Skip to main content
Server path: /instagram | Type: Application | PCID required: Yes

Tools

ToolDescription
instagram_add_product_tagsAdd product tags to media
instagram_create_comment_replyCreate comment reply
instagram_create_mediaCreate media
instagram_create_media_commentCreate media comment
instagram_delete_commentDelete comment
instagram_get_commentGet comment by ID
instagram_get_comment_filtersGet comment filters
instagram_get_content_publishing_limitGet content publishing limit
instagram_get_current_userGet current user info
instagram_get_hashtagGet hashtag by ID
instagram_get_mediaGet media by ID
instagram_get_media_insightsGet media insights
instagram_get_product_tagsGet product tags on media
instagram_get_recent_hashtag_mediaGet recent hashtag media
instagram_get_top_hashtag_mediaGet top hashtag media
instagram_get_userGet user by ID
instagram_get_user_insightsGet user insights
instagram_get_webhook_subscriptionsGet webhook subscriptions
instagram_list_available_catalogsGet available catalogs
instagram_list_comment_repliesGet comment replies
instagram_list_live_mediaGet live media
instagram_list_media_commentsGet media comments
instagram_list_product_catalogsGet product catalogs
instagram_list_shopping_tagsGet shopping tags
instagram_list_tagged_mediaGet tagged media
instagram_list_user_mediaGet user media
instagram_list_user_mentionsGet user mentions
instagram_list_user_storiesGet user stories
instagram_publish_mediaPublish media
instagram_search_hashtagsSearch hashtags
instagram_subscribe_to_webhooksSubscribe to webhooks
instagram_update_comment_filtersUpdate comment filters

instagram_add_product_tags

Add product tags to media Parameters:
ParameterTypeRequiredDefaultDescription
mediaIdstringYesInstagram Media ID
updated_tagsobject[]YesUpdated Tags

instagram_create_comment_reply

Create comment reply Parameters:
ParameterTypeRequiredDefaultDescription
commentIdstringYesInstagram Comment ID to reply to
messagestringYesComment text

instagram_create_media

Create media Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesInstagram User ID
captionstringNoMedia caption
childrenstring[]NoArray of media IDs for carousel posts
cover_urlstringNoVideo cover image URL
image_urlstringNoURL of the image to upload
is_reelbooleanNoWhether the video is a reel
location_idstringNoLocation ID
media_typestringNoMedia Type
share_to_feedbooleanNoWhether to share reel to feed
thumb_offsetintegerNoVideo thumbnail offset in milliseconds
user_tagsobject[]NoUser Tags
video_urlstringNoURL of the video to upload

instagram_create_media_comment

Create media comment Parameters:
ParameterTypeRequiredDefaultDescription
mediaIdstringYesInstagram Media ID
messagestringYesComment text

instagram_delete_comment

Delete comment Parameters:
ParameterTypeRequiredDefaultDescription
commentIdstringYesComment Id

instagram_get_comment

Get comment by ID Parameters:
ParameterTypeRequiredDefaultDescription
commentIdstringYesComment Id
fieldsstringNoComma-separated list of comment fields

instagram_get_comment_filters

Get comment filters Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesInstagram User ID

instagram_get_content_publishing_limit

Get content publishing limit Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesInstagram User ID

instagram_get_current_user

Get current user info Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstringNoComma-separated list of user fields

instagram_get_hashtag

Get hashtag by ID Parameters:
ParameterTypeRequiredDefaultDescription
hashtagIdstringYesHashtag Id
fieldsstringNoThe fields value

instagram_get_media

Get media by ID Parameters:
ParameterTypeRequiredDefaultDescription
mediaIdstringYesInstagram Media ID
fieldsstringNoComma-separated list of media fields

instagram_get_media_insights

Get media insights Parameters:
ParameterTypeRequiredDefaultDescription
mediaIdstringYesInstagram Media ID
metricstringYesComma-separated list of metrics

instagram_get_product_tags

Get product tags on media Parameters:
ParameterTypeRequiredDefaultDescription
mediaIdstringYesInstagram Media ID

instagram_get_recent_hashtag_media

Get recent hashtag media Parameters:
ParameterTypeRequiredDefaultDescription
hashtagIdstringYesHashtag Id
user_idstringYesUser Id
fieldsstringNoComma-separated list of media fields
limitintegerNoNumber of items to return

instagram_get_top_hashtag_media

Get top hashtag media Parameters:
ParameterTypeRequiredDefaultDescription
hashtagIdstringYesHashtag Id
user_idstringYesUser Id
fieldsstringNoComma-separated list of media fields
limitintegerNoNumber of items to return

instagram_get_user

Get user by ID Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesInstagram User ID
fieldsstringNoComma-separated list of user fields

instagram_get_user_insights

Get user insights Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesInstagram User ID
metricstringYesComma-separated list of metrics
periodstringNoPeriod for insights
sincestringNoStart date for insights (YYYY-MM-DD)
untilstringNoEnd date for insights (YYYY-MM-DD)

instagram_get_webhook_subscriptions

Get webhook subscriptions Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesInstagram User ID

instagram_list_available_catalogs

Get available catalogs Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesInstagram User ID

instagram_list_comment_replies

Get comment replies Parameters:
ParameterTypeRequiredDefaultDescription
commentIdstringYesComment Id
fieldsstringNoComma-separated list of comment fields
limitintegerNoNumber of items to return

instagram_list_live_media

Get live media Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesInstagram User ID
limitintegerNoNumber of items to return
afterstringNoPagination cursor
beforestringNoPagination cursor

instagram_list_media_comments

Get media comments Parameters:
ParameterTypeRequiredDefaultDescription
mediaIdstringYesInstagram Media ID
fieldsstringNoComma-separated list of comment fields
limitintegerNoNumber of items to return
afterstringNoPagination cursor

instagram_list_product_catalogs

Get product catalogs Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesInstagram User ID

instagram_list_shopping_tags

Get shopping tags Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesInstagram User ID
limitintegerNoNumber of items to return
afterstringNoPagination cursor
beforestringNoPagination cursor

instagram_list_tagged_media

Get tagged media Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesInstagram User ID
fieldsstringNoComma-separated list of media fields
limitintegerNoNumber of items to return

instagram_list_user_media

Get user media Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesInstagram User ID
fieldsstringNoComma-separated list of media fields
limitintegerNoNumber of items to return
afterstringNoPagination cursor
beforestringNoPagination cursor

instagram_list_user_mentions

Get user mentions Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesInstagram User ID
limitintegerNoNumber of items to return
afterstringNoPagination cursor
beforestringNoPagination cursor

instagram_list_user_stories

Get user stories Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesInstagram User ID
fieldsstringNoComma-separated list of media fields
limitintegerNoNumber of items to return

instagram_publish_media

Publish media Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesInstagram User ID
creation_idstringYesMedia container ID to publish

instagram_search_hashtags

Search hashtags Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser Id
querystringYesHashtag to search for

instagram_subscribe_to_webhooks

Subscribe to webhooks Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesInstagram User ID
callback_urlstringYesWebhook callback URL
objectstringNoThe object value
subscribed_fieldsstringYesComma-separated list of fields to subscribe to (e.g. comments,mentions,live_comments,story_insights)
verify_tokenstringYesVerification token

instagram_update_comment_filters

Update comment filters Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesInstagram User ID
filter_keywordsstring[]NoKeywords to filter out
hide_offensive_commentsbooleanNoWhether to hide offensive comments