Instagram

Learn how to use Instagram with Composio

Overview

SLUG: INSTAGRAM

Description

Instagram is a social media platform for sharing photos, videos, and stories.

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to instagram_business_basic,instagram_business_manage_messages,instagram_business_manage_comments,instagram_business_content_publish,instagram_business_manage_insights
bearer_token
string
token
stringRequired

Connecting to Instagram

Create an auth config

Use the dashboard to create an auth config for the Instagram toolkit. This allows you to connect multiple Instagram accounts to Composio for agents to use.

1

Select App

Navigate to Instagram.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Instagram Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4instagram_auth_config_id = "ac_YOUR_INSTAGRAM_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Instagram: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, instagram_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Using Bearer Token

1from composio import Composio
2
3# Auth config ID created above
4instagram_auth_config_id = "ac_YOUR_INSTAGRAM_CONFIG_ID"
5
6# UUID from database/application
7user_id = "0000-0000-0000"
8
9composio = Composio()
10
11
12def authenticate_toolkit(user_id: str, auth_config_id: str):
13 # Replace this with a method to retrieve the Bearer Token from the user.
14 bearer_token = input("[!] Enter bearer token")
15 connection_request = composio.connected_accounts.initiate(
16 user_id=user_id,
17 auth_config_id=auth_config_id,
18 config={"auth_scheme": "BEARER_TOKEN", "val": bearer_token}
19 )
20 print(f"Successfully connected Instagram for user {user_id}")
21 print(f"Connection status: {connection_request.status}")
22
23 return connection_request.id
24
25
26connection_id = authenticate_toolkit(user_id, instagram_auth_config_id)
27
28# You can verify the connection using:
29connected_account = composio.connected_accounts.get(connection_id)
30print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Instagram toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["INSTAGRAM"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Create Media Container

Description

Create a draft media container for photos/videos/reels before publishing.

Action Parameters

caption
string
content_type
string
cover_url
string
graph_api_version
stringDefaults to v21.0
ig_user_id
stringRequired
image_url
string
is_carousel_item
boolean
media_type
string
video_url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Post

Description

Publish a draft media container to instagram (final publishing step).

Action Parameters

creation_id
stringRequired
graph_api_version
stringDefaults to v21.0
ig_user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Conversation

Description

Get details about a specific instagram dm conversation (participants, etc).

Action Parameters

conversation_id
stringRequired
graph_api_version
stringDefaults to v21.0

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Post Comments

Description

Get comments on an instagram post.

Action Parameters

after
string
graph_api_version
stringDefaults to v21.0
ig_post_id
stringRequired
limit
integerDefaults to 25

Action Response

data
array
error
string
paging
object
successful
booleanRequired
summary
object

Tool Name: Get Post Insights

Description

Get instagram post insights/analytics (impressions, reach, engagement, etc.).

Action Parameters

graph_api_version
stringDefaults to v21.0
ig_post_id
stringRequired
metric
array

Action Response

data
array
error
string
paging
object
successful
booleanRequired

Tool Name: Get Post Status

Description

Check the processing status of a draft post container.

Action Parameters

creation_id
stringRequired
graph_api_version
stringDefaults to v21.0

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get User Info

Description

Get instagram user info including profile details and statistics.

Action Parameters

graph_api_version
stringDefaults to v21.0
ig_user_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get User Insights

Description

Get instagram account-level insights/analytics (profile views, reach, impressions, etc.).

Action Parameters

graph_api_version
stringDefaults to v21.0
ig_user_id
string
metric
array
period
stringDefaults to day
since
string
until
string

Action Response

data
array
error
string
paging
object
successful
booleanRequired

Tool Name: Get User Media

Description

Get instagram user's media (posts, photos, videos).

Action Parameters

after
string
graph_api_version
stringDefaults to v21.0
ig_user_id
string
limit
integerDefaults to 25

Action Response

data
array
error
string
paging
object
successful
booleanRequired

Tool Name: List All Conversations

Description

List all instagram dm conversations for the authenticated user.

Action Parameters

after
string
graph_api_version
stringDefaults to v21.0
ig_user_id
string
limit
integerDefaults to 25

Action Response

data
array
error
string
paging
object
successful
booleanRequired

Tool Name: List All Messages

Description

List all messages from a specific instagram dm conversation.

Action Parameters

after
string
conversation_id
stringRequired
graph_api_version
stringDefaults to v21.0
limit
integerDefaults to 25

Action Response

data
array
error
string
paging
object
successful
booleanRequired

Tool Name: Mark Seen

Description

Mark instagram dm messages as read/seen for a specific user.

Action Parameters

graph_api_version
stringDefaults to v21.0
recipient_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Reply To Comment

Description

Reply to a comment on instagram media.

Action Parameters

graph_api_version
stringDefaults to v21.0
ig_comment_id
stringRequired
message
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Send Image

Description

Send an image via instagram dm to a specific user.

Action Parameters

caption
string
graph_api_version
stringDefaults to v21.0
image_url
stringRequired
recipient_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Send Text Message

Description

Send a text message to an instagram user via dm.

Action Parameters

graph_api_version
stringDefaults to v21.0
ig_user_id
string
recipient_id
stringRequired
reply_to_message_id
string
text
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired