wehub-resource-sync
147 lines
9.7 KiB
Plaintext
147 lines
9.7 KiB
Plaintext
---
|
|
title: Glossary
|
|
description: Definitions of key Composio terms and concepts.
|
|
llmGuardrails: "none"
|
|
keywords: [glossary, definitions, terminology]
|
|
---
|
|
|
|
<Glossary>
|
|
|
|
<GlossaryTerm name="Auth Config">
|
|
A blueprint that defines how authentication works for a toolkit: the auth method (`OAUTH2`, `API_KEY`, `BEARER_TOKEN`, or `BASIC`), scopes, and credentials. A [session](/docs/how-composio-works) creates one automatically when it needs one. To use your own OAuth credentials or non-default scopes, [create a custom one](/docs/auth-configuration/custom-auth-configs).
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Auth Scheme">
|
|
The authentication method an auth config uses, such as `OAUTH2`, `API_KEY`, `BEARER_TOKEN`, or `BASIC`.
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Callback URL">
|
|
The URL a user returns to after completing an OAuth flow through a Connect Link. You pass it as `callbackUrl` when you initiate authentication.
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Composio API Key">
|
|
A project-scoped secret that authenticates your SDK and API requests. Every resource you create with it is scoped to that project.
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Composio Managed Auth">
|
|
The default mode in which Composio supplies its own OAuth app credentials for each toolkit. It requires no setup.
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Connect Link">
|
|
A hosted page where a user authorizes access to a toolkit. It is returned as a `redirect_url` from `session.authorize()` or `connectedAccounts.link()`, and Composio manages the full OAuth flow. See [Authentication](/docs/authentication).
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Connected Account">
|
|
A stored set of credentials (OAuth tokens or API keys) linked to a userID, created when a user authenticates with a toolkit. Composio refreshes OAuth tokens automatically, and a user can have [multiple connected accounts](/docs/managing-multiple-connected-accounts) for the same toolkit. IDs are prefixed `ca_`.
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Connection Request">
|
|
The object returned when you initiate authentication. It contains the Connect Link URL and a `waitForConnection()` method that resolves once the user completes the flow.
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Custom Tool">
|
|
A tool you define yourself and use alongside Composio's built-in tools. Add local experimental custom tools and custom toolkits through [Custom tools and toolkits](/docs/extending-sessions/custom-tools-and-toolkits).
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="In-Chat Authentication">
|
|
A flow in which the agent handles authentication itself by calling `COMPOSIO_MANAGE_CONNECTIONS` to generate a Connect Link and send it to the user in the conversation. See [In-chat authentication](/docs/authentication#in-chat-authentication).
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="MCP (Model Context Protocol)">
|
|
An open protocol for connecting AI models to external tools. Create a session with `mcp: true` to expose `session.mcp.url` and `session.mcp.headers`, an MCP-compatible endpoint any MCP client can connect to. See [Using sessions via MCP](/docs/sessions-via-mcp).
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Manual Authentication">
|
|
Authenticating users from your own code with `session.authorize()` or `connectedAccounts.link()`, rather than letting the agent handle it through in-chat authentication. See [Manual authentication](/docs/manually-authenticating).
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Meta Tools">
|
|
A set of tools included in every session: `COMPOSIO_SEARCH_TOOLS`, `COMPOSIO_GET_TOOL_SCHEMAS`, `COMPOSIO_MANAGE_CONNECTIONS`, `COMPOSIO_MULTI_EXECUTE_TOOL`, `COMPOSIO_REMOTE_WORKBENCH`, and `COMPOSIO_REMOTE_BASH_TOOL`. They let the agent discover tools, manage auth, execute in parallel, and run code without loading hundreds of tool definitions upfront. See [Meta Tools Reference](/toolkits/meta-tools).
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Modifiers">
|
|
Middleware that transforms tool behavior. [Schema modifiers](/docs/tools-direct/modify-tool-behavior/schema-modifiers) change a tool's schema before the agent sees it, [before-execution modifiers](/docs/tools-direct/modify-tool-behavior/before-execution-modifiers) change arguments before a tool runs, and [after-execution modifiers](/docs/tools-direct/modify-tool-behavior/after-execution-modifiers) transform the result. In Python, [`@before_file_upload`](/docs/tools-direct/modify-tool-behavior/before-execution-modifiers#before-file-upload-python) intercepts local paths for `file_uploadable` parameters before read and upload.
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Native Tools">
|
|
Tools you access through provider packages with `session.tools()` and call directly, rather than over MCP. Both paths give the agent the same capabilities, but tools called directly integrate with your AI framework and support modifiers and custom tools.
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Organization">
|
|
The top-level Composio account entity. It contains team members and projects.
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Organization API Key">
|
|
A key (`x-org-api-key`) for organization-level operations such as creating and managing projects. It is distinct from the project-scoped Composio API Key.
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Project">
|
|
An isolated environment within an organization that scopes API keys, connected accounts, auth configs, and webhooks. Resources in one project are inaccessible from another. IDs are prefixed `proj_`. See [Projects](/reference/api-reference/projects).
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Proxy Execute">
|
|
Making authenticated HTTP requests through a toolkit's connected account without a predefined tool. Use it for API endpoints Composio has no built-in tool for.
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Provider">
|
|
An adapter package that transforms Composio tools into the format an AI framework expects (OpenAI, Anthropic, LangChain, Vercel AI SDK, and others). See [Providers](/docs/providers).
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Session">
|
|
An ephemeral, immutable configuration object returned by `composio.create(userId)`. It ties together a userID, the available toolkits, an auth config, and connected accounts, and it exposes `tools()`, `authorize()`, and `toolkits()` (plus `mcp.url` when created with `mcp: true`). See [What is a session?](/docs/how-composio-works).
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Session ID">
|
|
The unique identifier for a session. Meta tools use it internally to share context across calls within the same session.
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Tool">
|
|
An individual action an agent can execute. It has an input schema and an output schema, and is named `{TOOLKIT}_{ACTION}` (for example, `GITHUB_CREATE_ISSUE`).
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Tool Slug">
|
|
A tool's unique identifier, in the `{TOOLKIT}_{ACTION}` pattern (for example, `GITHUB_CREATE_ISSUE`).
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Toolkit">
|
|
A collection of related tools for a single external service. Users connect to a toolkit through authentication, and all of its tools execute with the user's credentials.
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Toolkit Slug">
|
|
The lowercase identifier for a toolkit (for example, `github`, `gmail`, or `slack`). Use it when configuring sessions, fetching tools, or creating triggers.
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Toolkit Versioning">
|
|
Pinning a toolkit to a specific version so your integration keeps a consistent set of tools even as Composio updates its definitions. See [Toolkit versioning](/docs/tools-direct/toolkit-versioning).
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Trigger">
|
|
A source that sends structured payloads to your application when something happens in a connected app. Triggers come in two kinds: realtime (the provider pushes events the moment they happen, for example Slack, GitHub, or Asana) and polling (Composio checks the provider on a schedule, for example Gmail). Either way, events arrive at your subscription or webhook URL. See [Triggers](/docs/triggers).
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Trigger Instance">
|
|
A specific, active trigger scoped to a user's connected account.
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Webhook Endpoint">
|
|
The ingress URL Composio issues per OAuth app for webhook triggers, plus the signing secret used to verify each inbound request. Composio configures it for you in most cases. When a trigger type's `requires_webhook_endpoint_setup` flag is `true`, you configure it yourself once per OAuth app through the [Webhook Endpoints API](/reference/api-reference/webhook-endpoints). See [Custom OAuth webhooks](/docs/setting-up-triggers/custom-oauth-webhooks).
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Webhook Subscription">
|
|
The URL Composio delivers signed events to in your application. There is one per project, configured through the dashboard or the [Webhook Subscriptions API](/reference/api-reference/webhook-subscriptions). See [Subscribing to events](/docs/setting-up-triggers/subscribing-to-events).
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="userID">
|
|
An identifier from your application that Composio uses to scope connected accounts, tool executions, and authorizations. Connections are fully isolated between userIDs. See [What is a session?](/docs/how-composio-works).
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="White-Labeling">
|
|
Customizing the auth experience so users see your brand during the OAuth flow. You provide your own OAuth credentials, redirect URIs, and branding. See [White-labeling authentication](/docs/white-labeling-authentication).
|
|
</GlossaryTerm>
|
|
|
|
<GlossaryTerm name="Sandbox">
|
|
A persistent Python environment (previously called the workbench) exposed through the `COMPOSIO_REMOTE_WORKBENCH` meta tool. Its state persists across calls within a session, which makes it useful for bulk operations, data transformations, and processing large tool responses. Configure it with the `sandbox` session key; `workbench` still works as an alias. See [Sandbox](/docs/sandbox/remote).
|
|
</GlossaryTerm>
|
|
|
|
</Glossary>
|