Endorsal | Composio Docs

Overview

SLUG: ENDORSAL

Description

Endorsal automates the collection and display of customer testimonials and reviews, enhancing social proof for businesses.

Authentication Details

API Key

generic_api_key

stringRequired

Connecting to Endorsal

Create an auth config

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

Select App

Navigate to Endorsal.

Configure Auth Config Settings

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

Create and Get auth config ID

Click “Create Endorsal 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 endorsal_auth_config_id = "ac_YOUR_ENDORSAL_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 Endorsal 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, endorsal_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 Endorsal toolkit’s playground

OpenAI (Python)

Anthropic (TypeScript)

Google (Python)

Vercel (TypeScript)

Python

1 from composio import Composio
2 from openai import OpenAI
3 import json
4 
5 openai = OpenAI()
6 composio = Composio()
7 
8 # User ID must be a valid UUID format
9 user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10 
11 tools = composio.tools.get(user_id=user_id, toolkits=["ENDORSAL"])
12 
13 print("[!] Tools:")
14 print(json.dumps(tools))
15 
16 def 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 
33 invoke_llm()

Tool List

ENDORSAL_CREATE_TESTIMONIAL

Tool Name: Create Testimonial

Description

Tool to submit a new testimonial. use when adding customer feedback to your endorsal account after gathering input.

Action Parameters

company

string

stringRequired

featured

boolean

job

string

location

string

name

stringRequired

profile

string

rating

integer

testimonial

stringRequired

website

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENDORSAL_GET_TESTIMONIAL

Tool Name: Get Testimonial

Description

Tool to retrieve details of a specific testimonial by its unique identifier. use after obtaining the testimonial id to fetch its full details.

Action Parameters

item_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENDORSAL_GET_AUTO_REQUEST_CAMPAIGN

Tool Name: Get AutoRequest Campaign

Description

Tool to retrieve a specific autorequest campaign by its unique identifier. use when you need to fetch details of an existing autorequest campaign.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENDORSAL_GET_CONTACT

Tool Name: Get Contact

Description

Tool to retrieve details of a specific contact by its unique identifier. use when you have the contact id and need to fetch complete contact details.

Action Parameters

contact_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENDORSAL_GET_TAG

Tool Name: Get Tag

Description

Tool to retrieve details of a specific tag by its unique identifier. use when you have a tag id and need full tag metadata.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENDORSAL_GET_WIDGET

Tool Name: Get Widget

Description

Tool to retrieve details of a specific widget by its unique identifier. use when you need full widget details before editing or analysis.

Action Parameters

widget_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENDORSAL_LIST_AUTOREQUEST_CAMPAIGNS

Tool Name: List AutoRequest Campaigns

Description

Tool to retrieve a list of all autorequest campaigns. use when you need to view both active and inactive campaigns.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENDORSAL_LIST_CONTACTS

Tool Name: List Contacts

Description

Tool to retrieve all contacts associated with your account. use when you need to browse or manage your contact list after authentication.

Action Parameters

page

integer

per_page

integer

property_id

stringRequired

Action Response

data

arrayRequired

error

string

ENDORSAL_LIST_CONTACT_TESTIMONIALS

Tool Name: List Contact Testimonials

Description

Tool to retrieve all testimonials submitted by a specific contact. use when you have a contact id and need to paginate through their testimonials.

Action Parameters

contact_id

stringRequired

page

integer

per_page

integer

Action Response

data

arrayRequired

error

string

ENDORSAL_LIST_PROPERTIES

Tool Name: List Properties

Description

Tool to retrieve all properties for the authenticated account. use after obtaining a valid api key and login.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENDORSAL_LIST_TAGS

Tool Name: List Tags

Description

Tool to retrieve all tags for a specific property. use when you need to browse available tags before assigning them. use after confirming the property id.

Action Parameters

propertyId

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENDORSAL_LIST_TAG_TESTIMONIALS

Tool Name: List Tag Testimonials

Description

Tool to retrieve all testimonials for a given tag. use when you need to list testimonials filtered by tag id for pagination and display.

Action Parameters

limit

integer

page

integer

tag_id

stringRequired

Action Response

data

arrayRequired

error

string

ENDORSAL_LIST_WIDGETS

Tool Name: List Widgets

Description

Tool to retrieve all widgets associated with your account. use when you need to enumerate available widgets for management.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired