composio.api_keys.generatecomposio.api_keys.listcomposio.api_keys.removecomposio.actions.executecomposio.actions.execute_action_proxycomposio.actions.get_action_by_idcomposio.actions.get_action_inputscomposio.actions.get_all_actions_based_on_querycomposio.actions.listcomposio.admin.clear_cachecomposio.admin.get_sentry_dnscomposio.analytics.getcomposio.analytics.get_top_entitiescomposio.apps.delete_open_api_spec_toolcomposio.apps.get_detailscomposio.apps.get_open_api_spec_statuscomposio.apps.listcomposio.apps.list_open_api_specscomposio.apps.send_email_to_clientcomposio.auth.get_user_infocomposio.auth.identify_client_operationcomposio.cli.exchange_codecomposio.cli.get_codecomposio.cli.verify_codecomposio.connections.deletecomposio.connections.disablecomposio.connections.enablecomposio.connections.getcomposio.connections.get_infocomposio.connections.initiatecomposio.connections.listcomposio.connections.update_connection_datacomposio.event_logs.update_webhookcomposio.integrations.create_integrationcomposio.integrations.delete_connectorcomposio.integrations.get_connector_infocomposio.integrations.list_global_connectorscomposio.integrations.update_integrationcomposio.logs.add_new_logscomposio.logs.listcomposio.triggers.delete_trigger_instancecomposio.triggers.disable_trigger_instancecomposio.triggers.enablecomposio.triggers.get_active_triggerscomposio.triggers.get_callback_urlcomposio.triggers.get_logs_based_on_connection_and_integration_detailscomposio.triggers.get_trigger_infocomposio.triggers.listcomposio.triggers.set_callback_urlcomposio.triggers.switch_instance_statusAdd to Gemfile:
gem 'composio', '~> 0.1.18'
require 'composio'
configuration = Composio::Configuration.new
configuration.api_key = 'YOUR API KEY'
composio = composio::Client.new(configuration)
result = composio.api_keys.generate(
name: "string_example",
)
p result
To access the raw HTTP response, suffix any method with _with_http_info.
result = composio.api_keys.generate_with_http_info(
name: "string_example",
)
p result.data # [APIKeyResDTO] Deserialized data
p.result.status_code # [Integer] HTTP status code
p.result.headers # [Hash] HTTP headers
p.result.response # [Faraday::Response] Raw HTTP response
composio.api_keys.generateGenerate api key
result = composio.api_keys.generate(
name: "string_example",
)
p result
StringThe name of the API key to be generated
/api/v1/api_keys POST
composio.api_keys.listList api keys
result = composio.api_keys.list
p result
/api/v1/api_keys GET
composio.api_keys.removeDelete api key
result = composio.api_keys.remove(
id: "'+j>6",
)
p result
String/api/v1/api_keys/{id} DELETE
composio.actions.executeExecute an action. Support both connected account and no auth auth.
result = composio.actions.execute(
action_id: "'+j>6",
connected_account_id: "string_example",
app_name: "string_example",
entity_id: "string_example",
endpoint: "string_example",
input: {},
session_info: {
},
auth_config: {
"parameters" => [
{
"name" => "name_example",
"_in" => "query",
"value" => "value_example",
}
],
},
text: "string_example",
custom_description: "string_example",
system_prompt: "string_example",
)
p result
StringStringStringStringStringObjectSessionInfoDTOCustomAuthDTOStringStringString/api/v2/actions/{actionId}/execute POST
composio.actions.execute_action_proxyExecute an action with direct auth.
result = composio.actions.execute_action_proxy(
parameters: [
{
"name" => "name_example",
"_in" => "query",
"value" => "value_example",
}
],
connected_account_id: "string_example",
endpoint: "string_example",
method: "GET",
body: {},
)
p result
Parameter>StringThe connected account uuid to use for the action.
StringThe endpoint to call for the action. If the given url is relative, it will be resolved relative to the base_url set in the connected account info.
MethodThe HTTP method to use for the action.
ObjectThe body to be sent to the endpoint. This can either be a JSON field or a string.
/api/v2/actions/proxy POST
composio.actions.get_action_by_idGet action details
result = composio.actions.get_action_by_id(
action_id: "'+j>6",
)
p result
String/api/v2/actions/{actionId} GET
composio.actions.get_action_inputsGet the inputs for an action with NLA
result = composio.actions.get_action_inputs(
text: "string_example",
action_id: "'+j>6",
custom_description: "string_example",
system_prompt: "string_example",
)
p result
StringStringStringString/api/v2/actions/{actionId}/execute/get.inputs POST
composio.actions.get_all_actions_based_on_queryRetrieve a list of all actions based on query parameters.
result = composio.actions.get_all_actions_based_on_query(
app_names: "string_example",
use_case: "string_example",
show_enabled_only: true,
limit: 3.14,
apps: "string_example",
actions: "string_example",
tags: "string_example",
usecase_limit: 3.14,
filter_important_actions: true,
show_all: true,
page: 3.14,
offset: 3.14,
)
p result
StringStringBooleanFloatStringStringStringFloatBooleanBooleanFloatFloat/api/v2/actions/list/all GET
composio.actions.listRetrieve a list of all actions based on query parameters.
result = composio.actions.list(
app_names: "string_example",
use_case: "string_example",
show_enabled_only: true,
limit: 3.14,
apps: "string_example",
actions: "string_example",
tags: "string_example",
usecase_limit: 3.14,
filter_important_actions: true,
show_all: true,
page: 3.14,
offset: 3.14,
)
p result
StringStringBooleanFloatStringStringStringFloatBooleanBooleanFloatFloat/api/v2/actions GET
composio.admin.clear_cacheClear cache
result = composio.admin.clear_cache(
x_admin_token: "string_example",
)
p result
String/api/v1/clear-cache POST
composio.admin.get_sentry_dnsJssentry dns
result = composio.admin.get_sentry_dns
p result
/api/v1/cli/js-sentry-dns GET
composio.analytics.getGet analytics
result = composio.analytics.get(
last_time_period: "DAY",
)
p result
String/api/v1/analytics GET
composio.analytics.get_top_entitiesGet top entities
result = composio.analytics.get_top_entities(
query: "string_example",
)
p result
String/api/v1/analytics/entities GET
composio.apps.delete_open_api_spec_toolDelete an openapi spec tool
result = composio.apps.delete_open_api_spec_tool(
id: "'+j>6",
)
p result
String/api/v1/apps/openapi/spec/delete/{id} DELETE
composio.apps.get_detailsGet app details
result = composio.apps.get_details(
app_name: "'+j>6",
)
p result
String/api/v1/apps/{appName} GET
composio.apps.get_open_api_spec_statusGet the status of an openapi spec tool
result = composio.apps.get_open_api_spec_status(
id: "'+j>6",
)
p result
String/api/v1/apps/openapi/spec/status/{id} GET
composio.apps.listRetrieve a list of all applications based on query parameters.
result = composio.apps.list(
category: "string_example",
additional_fields: "string_example",
include_local: "string_example",
)
p result
StringStringString/api/v1/apps GET
composio.apps.list_open_api_specsList all openapi spec tools
result = composio.apps.list_open_api_specs
p result
/api/v1/apps/openapi/spec/list GET
composio.apps.send_email_to_clientSend email to client
result = composio.apps.send_email_to_client(
admin_token: "string_example",
body: None,
)
p result
String/api/v1/apps/openapi/send_email_to_client POST
composio.auth.get_user_infoGet client info
result = composio.auth.get_user_info
p result
/api/v1/client/auth/client_info GET
composio.auth.identify_client_operationIdentify client
result = composio.auth.identify_client_operation(
hash: "string_example",
framework: "string_example",
)
p result
StringThe hash of the client
StringThe framework used by the client
/api/v1/client/auth/identify POST
composio.cli.exchange_codeHandle cli code exchange
result = composio.cli.exchange_code
p result
/api/v1/cli/generate-cli-session GET
composio.cli.get_codeGet cli code
result = composio.cli.get_code(
key: "key_example",
code: "string_example",
)
p result
StringString/api/v1/cli/get-cli-code GET
composio.cli.verify_codeHandle cli code verification
result = composio.cli.verify_code(
key: "key_example",
code: "string_example",
)
p result
StringString/api/v1/cli/verify-cli-code GET
composio.connections.deleteDelete a connection
result = composio.connections.delete(
connected_account_id: "'+j>6",
)
p result
String/api/v1/connectedAccounts/{connectedAccountId} DELETE
composio.connections.disableDisable a connection
result = composio.connections.disable(
connected_account_id: "'+j>6",
)
p result
StringToggleConnectedAccountResponseDTO
/api/v1/connectedAccounts/{connectedAccountId}/disable POST
composio.connections.enableEnable a connection
result = composio.connections.enable(
connected_account_id: "'+j>6",
)
p result
StringToggleConnectedAccountResponseDTO
/api/v1/connectedAccounts/{connectedAccountId}/enable POST
composio.connections.getGet connection
result = composio.connections.get(
connected_account_id: "'+j>6",
)
p result
String/api/v1/connectedAccounts/{connectedAccountId} GET
composio.connections.get_infoGet connection info
result = composio.connections.get_info(
connected_account_id: "'+j>6",
)
p result
String/api/v1/connectedAccounts/{connectedAccountId}/info GET
composio.connections.initiateInitiate connection
result = composio.connections.initiate(
data: {},
integration_id: "a",
redirect_uri: "string_example",
user_uuid: "string_example",
entity_id: "string_example",
labels: [
"string_example"
],
)
p result
ObjectStringStringStringStringString>/api/v1/connectedAccounts POST
composio.connections.listGet connections
result = composio.connections.list(
page: 3.14,
page_size: 3.14,
app_names: "string_example",
integration_id: "string_example",
connection_id: "string_example",
user_uuid: "string_example",
show_active_only: true,
status: "string_example",
show_disabled: true,
labels: [
"string_example"
],
)
p result
FloatFloatStringStringStringStringBooleanStringBooleanString>/api/v1/connectedAccounts GET
composio.connections.update_connection_dataUpdate connection data
result = composio.connections.update_connection_data(
labels: [
"string_example"
],
connected_account_id: "'+j>6",
)
p result
String>String/api/v1/connectedAccounts/{connectedAccountId}/data PATCH
composio.event_logs.update_webhookUpdate webhook
result = composio.event_logs.update_webhook(
event_webhook_url: "string_example",
)
p result
StringEvent Webhook URL
/api/v1/event_logs/set/webhook POST
composio.integrations.create_integrationCreate a new connector
result = composio.integrations.create_integration(
name: "string_example",
auth_scheme: "string_example",
auth_config: {
},
use_composio_auth: true,
app_id: "string_example",
app_name: "string_example",
force_new_integration: true,
)
p result
StringName of the connector
StringAuthentication scheme
AuthConfigDTOCreateConnectorPayloadDTOUseComposioAuthStringComposio App UUID to be used for authentication. Either specify this or appName
StringName of the app to be used for authentication. Either specify this or appId
BooleanFlag to force new integration
/api/v1/integrations POST
composio.integrations.delete_connectorDelete a connector
result = composio.integrations.delete_connector(
integration_id: "'+j>6",
)
p result
String/api/v1/integrations/{integrationId} DELETE
composio.integrations.get_connector_infoGet connector info
result = composio.integrations.get_connector_info(
integration_id: "'+j>6",
)
p result
String/api/v1/integrations/{integrationId} GET
composio.integrations.list_global_connectorsList all connectors
result = composio.integrations.list_global_connectors
p result
/api/v1/integrations GET
composio.integrations.update_integrationModify a connector
result = composio.integrations.update_integration(
integration_id: "'+j>6",
auth_config: {},
enabled: true,
)
p result
StringObjectAuthentication configuration for the connector
BooleanFlag to indicate if the connector is enabled
/api/v1/integrations/{integrationId} PATCH
composio.logs.add_new_logsAdd new logs
result = composio.logs.add_new_logs(
provider_name: "string_example",
action_name: "string_example",
request: {},
response: {},
is_error: true,
connection_id: "string_example",
session_id: "string_example",
logs_type: "string_example",
entity_id: "string_example",
)
p result
StringProvider name of the log
StringAction name of the log
ObjectObjectBooleanStringConnection ID of the log
StringSession ID of the log
StringType of the log
StringEntity ID of the log
/api/v1/logs POST
composio.logs.listList logs
result = composio.logs.list(
type: "error",
time: "5m",
status: "all",
search: "string_example",
integration_id: "string_example",
entity_id: "string_example",
limit: 10,
cursor: "string_example",
logs_type: "string_example",
session_id: "string_example",
)
p result
StringStringStringStringStringStringFloatStringStringString/api/v1/logs GET
composio.triggers.delete_trigger_instanceDeletes a specified trigger instance.
result = composio.triggers.delete_trigger_instance(
trigger_instance_id: "'+j>6",
)
p result
String/api/v1/triggers/instance/{triggerInstanceId} DELETE
composio.triggers.disable_trigger_instanceDisables a specified trigger instance.
result = composio.triggers.disable_trigger_instance(
trigger_instance_id: "'+j>6",
)
p result
String/api/v1/triggers/disable/{triggerInstanceId} POST
composio.triggers.enableEnables a trigger for a connected account and specific trigger name.
result = composio.triggers.enable(
trigger_config: {},
connected_account_id: "'+j>6",
trigger_name: "'+j>6",
verify_host: "string_example",
)
p result
ObjectThe trigger configuration
StringStringStringThe verify host
/api/v1/triggers/enable/{connectedAccountId}/{triggerName} POST
composio.triggers.get_active_triggersLists active triggers based on query parameters.
result = composio.triggers.get_active_triggers(
connected_account_ids: "string_example",
integration_ids: "string_example",
trigger_ids: "string_example",
trigger_names: "string_example",
page: 3.14,
limit: 3.14,
show_disabled: true,
)
p result
StringStringStringStringFloatFloatBoolean/api/v1/triggers/active_triggers GET
composio.triggers.get_callback_urlRetrieves the universal callback URL set for the client.
result = composio.triggers.get_callback_url
p result
/api/v1/triggers/callback_url GET
composio.triggers.get_logs_based_on_connection_and_integration_detailsFetches logs based on connection and integration details.
result = composio.triggers.get_logs_based_on_connection_and_integration_details(
connection_id: "string_example",
integration_id: "string_example",
page: 3.14,
limit: 3.14,
)
p result
StringStringFloatFloat/api/v1/triggers/logs GET
composio.triggers.get_trigger_infoGet Trigger Info
result = composio.triggers.get_trigger_info(
trigger_name: "'+j>6",
)
p result
String/api/v2/triggers/{triggerName} GET
composio.triggers.listList triggers
result = composio.triggers.list(
app_names: "string_example",
connected_account_ids: "string_example",
trigger_ids: "string_example",
integration_ids: "string_example",
show_enabled_only: true,
)
p result
StringStringStringStringBoolean/api/v1/triggers GET
composio.triggers.set_callback_urlSets a universal callback URL for the client.
result = composio.triggers.set_callback_url(
callback_url: "string_example",
)
p result
StringThe callback URL
/api/v1/triggers/set_callback_url POST
composio.triggers.switch_instance_statusSwitches the status of a trigger instance.
result = composio.triggers.switch_instance_status(
enabled: true,
trigger_id: "'+j>6",
)
p result
BooleanThe new enabled status of the trigger
String/api/v1/triggers/instance/{triggerId}/status PATCH
This TypeScript package is automatically generated by Konfig
FAQs
Unknown package
We found that composio demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.