Prismic | Composio Docs

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

API Key

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.

Select App

Navigate to Prismic.

Configure Auth Config Settings

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

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

1 from composio import Composio
2 
3 # Replace these with your actual values
4 prismic_auth_config_id = "ac_YOUR_PRISMIC_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def 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 
27 connection_id = authenticate_toolkit(user_id, prismic_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(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

For code examples, see the Tool calling guide and Provider examples.

Tool List

PRISMIC_CONTENT_API_GET_DOCUMENTS_WITH_FULLTEXT_SEARCH

Tool Name: Get Prismic Documents with Fulltext Search

Description

Tool to fetch Prismic documents using a full-text search predicate. Use after obtaining the repository's master ref when you want to search for specific terms within documents.

Action Parameters

fetch

fetchLinks

lang

orderings

page

integerDefaults to 1

pageSize

integerDefaults to 20

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

PRISMIC_CONTENT_API_GET_DOCUMENTS_WITH_INTEGRATION_FIELDS

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

fetch

fetchLinks

integrationFieldsRef

lang

orderings

page

pageSize

ref

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

PRISMIC_CONTENT_API_GET_DOCUMENTS_WITH_PREDICATES

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

fetch

fetchLinks

graphQuery

lang

orderings

page

integerDefaults to 1

pageSize

integerDefaults to 20

predicates

arrayRequired

Action Response

data

objectRequired

error

successful

booleanRequired

PRISMIC_CONTENT_API_QUERY_DOCUMENTS

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

after

fetch

fetchLinks

graphQuery

integrationFieldsRef

lang

orderings

page

pageSize

ref

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

PRISMIC_GET_DOCUMENT_BY_ID

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

orderings

page

Defaults to 1

page_size

Defaults to 1

ref

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

PRISMIC_GET_DOCUMENTS_BY_CUSTOM_FIELD

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

orderings

page

pageSize

ref

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

PRISMIC_GET_DOCUMENTS_BY_TAG

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

lang

orderings

page

integerDefaults to 1

pageSize

integerDefaults to 20

tag

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

PRISMIC_GET_DOCUMENTS_BY_TYPE

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

lang

orderings

page

integerDefaults to 1

pageSize

integerDefaults to 20

type

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

PRISMIC_GET_DOCUMENTS_ORDERED

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

after

fetch

fetchLinks

graphQuery

lang

orderings

stringRequired

page

integerDefaults to 1

pageSize

integerDefaults to 20

ref

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

PRISMIC_REPOSITORY_API_GET_INFO

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

successful

booleanRequired

PRISMIC_REPOSITORY_API_GET_REFS

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

successful

booleanRequired

PRISMIC_TAGS_API_GET_ALL_TAGS

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

successful

booleanRequired

PRISMIC_TYPES_API_GET_TYPES

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

page

ref

sort

Action Response

data

objectRequired

error

successful

booleanRequired