Prismic

Learn how to use Prismic with Composio

Overview

SLUG: PRISMIC

Description

Prismic is a headless CMS that enables developers and content teams to manage and deliver content seamlessly across various platforms.

Authentication Details

subdomain
stringRequired
generic_api_key
stringRequired

Connecting to Prismic

Create an auth config

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

1

Select App

Navigate to Prismic.

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 Prismic 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
4prismic_auth_config_id = "ac_YOUR_PRISMIC_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 Prismic 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, prismic_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 Prismic 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=["PRISMIC"])
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: Content API: Get Documents with Integration Fields

Description

Tool to fetch prismic documents including integration fields data. use when you need both core content and integration fields in one query. call after obtaining a valid ref token.

Action Parameters

after
string
fetch
string
fetchLinks
string
integrationFieldsRef
string
lang
string
orderings
string
page
integer
pageSize
integer
q
string
ref
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Prismic Documents with Predicates

Description

Tool to fetch prismic documents using specified predicates. use when filtering documents based on multiple conditions after obtaining the repository's master ref.

Action Parameters

access_token
string
fetch
string
fetchLinks
string
graphQuery
string
lang
string
orderings
string
page
integerDefaults to 1
pageSize
integerDefaults to 20
predicates
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Prismic: Query Documents

Description

Tool to query prismic documents using predicates and pagination. use when you need to fetch multiple documents from a repository after obtaining a ref.

Action Parameters

access_token
string
after
string
fetch
string
fetchLinks
string
graphQuery
string
integrationFieldsRef
string
lang
string
orderings
string
page
integer
pageSize
integer
q
string
ref
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Prismic Document by ID

Description

Tool to retrieve a specific prismic document by its id. use after obtaining a content ref.

Action Parameters

document_id
stringRequired
lang
string
orderings
string
page
integerDefaults to 1
page_size
integerDefaults to 1
ref
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Prismic: Get Documents by Custom Field

Description

Tool to fetch prismic documents by custom field predicate. use after obtaining a repository ref when filtering content by field constraints.

Action Parameters

lang
string
orderings
string
page
integer
pageSize
integer
q
string
ref
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Prismic Documents by Tag

Description

Tool to fetch prismic documents by tag. use when retrieving all documents associated with a specific tag.

Action Parameters

after
string
lang
string
orderings
string
page
integerDefaults to 1
pageSize
integerDefaults to 20
tag
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Prismic Documents by Type

Description

Tool to fetch prismic documents by type. use when you need to retrieve documents with a specific custom type after obtaining the repository's master ref.

Action Parameters

after
string
lang
string
orderings
string
page
integerDefaults to 1
pageSize
integerDefaults to 20
type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Ordered Documents

Description

Tool to fetch prismic documents ordered by a specified field. use after obtaining a valid api ref when you need sorted document results, e.g., orderings='[my.article.date desc]'.

Action Parameters

access_token
string
after
string
fetch
string
fetchLinks
string
graphQuery
string
lang
string
orderings
stringRequired
page
integerDefaults to 1
pageSize
integerDefaults to 20
q
array
ref
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Prismic Repository Info

Description

Tool to retrieve prismic repository metadata. use after authentication to load refs, types, languages, and other repository settings.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Prismic Repository Refs

Description

Tool to retrieve a list of repository refs (master and releases). use when you need the current repository references before executing any content queries.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Prismic Tags

Description

Tool to retrieve all tags from prismic repository. use when you need the full list of tags for filtering or categorization.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Prismic: Get Custom Types

Description

Tool to retrieve all custom types and slices from the prismic repository. use when you need to list custom types definitions after authentication.

Action Parameters

limit
integer
page
integer
ref
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired