Contentful graphql

Learn how to use Contentful graphql with Composio

Overview

SLUG: CONTENTFUL_GRAPHQL

Description

The Contentful GraphQL Content API allows developers to query and deliver content using GraphQL, providing a flexible and efficient way to access content stored in Contentful.

Authentication Details

subdomain
stringRequired
bearer_token
stringRequired
version
string

Connecting to Contentful graphql

Create an auth config

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

1

Select App

Navigate to [Contentful graphql](https://platform.composio.dev?next_page=/marketplace/Contentful graphql).

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 Contentful graphql 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 API Key

1from composio import Composio
2
3# Replace these with your actual values
4contentful_graphql_auth_config_id = "ac_YOUR_CONTENTFUL_GRAPHQL_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": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Contentful graphql 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_graphql_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 graphql toolkit’s playground](https://app.composio.dev/app/Contentful graphql)

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_GRAPHQL"])
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 CMA Token

Description

Tool to retrieve a Contentful Management API (CMA) access token. Use when making CMA calls to ensure valid authorization.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: GraphQL Content API Persisted Query

Description

Tool to execute a persisted GraphQL query via its SHA256 hash. Use after registering a query hash to run cached queries by hash. On first call include full query text; thereafter invoke with only hash and variables.

Action Parameters

access_token
string
environment_id
stringRequired
query
string
sha256_hash
stringRequired
space_id
stringRequired
variables
object
version
integerDefaults to 1

Action Response

X-Contentful-Graphql-Query-Cost
integer
X-Contentful-RateLimit-Reset
integer
data
object
error
string
errors
array
successful
booleanRequired

Tool Name: GraphQL Content API Query

Description

Tool to execute a GraphQL query against a specified space and environment. Use when fetching Contentful content via GraphQL after obtaining or providing a valid token.

Action Parameters

access_token
string
environment_id
stringRequired
persisted_query_hash
string
persisted_query_version
integer
query
stringRequired
resource_resolution
string
space_id
stringRequired
variables
object

Action Response

X-Contentful-Graphql-Query-Cost
integer
X-Contentful-RateLimit-Reset
integer
data
object
error
string
errors
array
successful
booleanRequired