Contentful

Learn how to use Contentful with Composio

Overview

SLUG: CONTENTFUL

Description

Contentful is a headless CMS allowing developers to create, manage, and distribute content across multiple channels and devices with an API-first approach

Authentication Details

client_id
stringRequired
client_secret
stringRequired
full
stringDefaults to https://api.contentful.comRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to content_management_manage,content_management_read
bearer_token
string
full
stringDefaults to https://cdn.contentful.comRequired
bearer_token
stringRequired

Connecting to Contentful

Create an auth config

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

1

Select App

Navigate to the Contentful toolkit page and click “Setup Integration”.

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 Integration”. 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
4contentful_auth_config_id = "ac_YOUR_CONTENTFUL_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 Contentful: {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, contentful_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 API Key

1from composio import Composio
2
3# Replace these with your actual values
4contentful_auth_config_id = "ac_YOUR_CONTENTFUL_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": user_api_key}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Contentful for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, contentful_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Contentful 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=["CONTENTFUL"])
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: Get space

Description

Retrieves details of a specific space by its id. this action is used to get information about a single space in contentful.

Action Parameters

space_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List spaces

Description

Lists all spaces that the authenticated user has access to in contentful. this is a fundamental operation needed before performing any other content management actions since most operations require a space id.

Action Parameters

limit
integer
order
string
skip
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update space

Description

Updates the name of a specific space. notes: - the version number is required to ensure you're updating the latest version of the space. - you can get the current version from the sys.version field when fetching space details. - only the name of the space can be updated.

Action Parameters

name
stringRequired
space_id
stringRequired
version
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired