# Self-hosted Helm (/kb/guide/platform-self-hosted-helm)

Use these checks to troubleshoot Composio self-hosted or on-prem Helm deployments.

## Apollo S3 with IRSA / ServiceAccount credentials needs no static S3 secret keys [#apollo-s3-with-irsa--serviceaccount-credentials-needs-no-static-s3-secret-keys]

For IRSA / ServiceAccount-based S3 access, `S3_ACCESS_KEY_ID` and `S3_SECRET_ACCESS_KEY` should not be populated in the Apollo container. These secret keys are optional. If the keys are removed from `composio-composio-secrets`, Apollo can fall back to the configured pod ServiceAccount / AWS SDK credential chain.

Do not set placeholder S3 credential values for IRSA deployments. Values such as `dummy-value` or a literal string `null` are treated as credentials and can make S3 pre-signed URLs fail with provider errors such as:

```text
InvalidAccessKeyId: The AWS Access Key Id you provided does not exist in our records.
InvalidToken: The provided token is malformed or otherwise invalid.
```

For AWS IRSA, configure the Apollo ServiceAccount annotation and object storage backend, then leave static S3 credential secret keys absent:

```yaml
apollo:
  serviceAccount:
    enabled: true
    name: "composio-apollo"
    annotations:
      eks.amazonaws.com/role-arn: "arn:aws:iam:::role/"
  objectStorage:
    backend: "s3"
```

Debug checks:

```bash
kubectl exec -n composio deploy/composio-apollo -- env | grep -E "^S3_|^AWS_"
kubectl logs -n composio deploy/composio-apollo --tail=200
```

If using pod/container credentials, the Helm storage doc says the Kubernetes secret credential section can be skipped. Verify that `S3_ACCESS_KEY_ID` and `S3_SECRET_ACCESS_KEY` are not present with dummy/static values in Apollo's runtime environment.

Example response:

```text
This looks like Apollo is still receiving static S3 credential env vars, so the AWS SDK is using those instead of falling back to the ServiceAccount/IRSA credentials.

For IRSA, `S3_ACCESS_KEY_ID` and `S3_SECRET_ACCESS_KEY` should be absent from the Apollo container. Those secrets are optional; if you remove those keys from `composio-composio-secrets`, Apollo should use the configured ServiceAccount. Placeholder values like `dummy-value` or literal `null` are treated as real credentials and can cause S3 signing errors such as `InvalidAccessKeyId` or `InvalidToken`.

The immediate fix is to remove `S3_ACCESS_KEY_ID` and `S3_SECRET_ACCESS_KEY` from `composio-composio-secrets`, then confirm the Apollo pod environment no longer includes those values.
```

## Disable social login explicitly for self-hosted deployments [#disable-social-login-explicitly-for-self-hosted-deployments]

`NEXT_PUBLIC_DISABLE_SOCIAL_LOGIN` controls whether social login buttons such as Google/GitHub appear on the frontend login page. For self-hosted customers that should hide social login, set the Helm values override as a string:

```yaml
apollo:
  nextPublicDisableSocialLogin: "true"
```

This makes the generated Apollo ConfigMap render an explicit value instead of an empty/null value and should remove repeated ArgoCD diffs immediately.

Customers can apply the override directly to unblock the deployment.

Example response:

````text
`NEXT_PUBLIC_DISABLE_SOCIAL_LOGIN` controls whether the Google/GitHub social login buttons show up on the frontend login page. For your setup, I'd set it explicitly to `"true"` in the Helm values override:

```yaml
apollo:
nextPublicDisableSocialLogin: "true"
```
This should make the generated Apollo ConfigMap render the explicit value and stop ArgoCD from diffing null vs empty string immediately.

The override above can be applied directly; no release-specific promise is required.
````

---

📚 **More documentation:** [View all docs](https://docs.composio.dev/llms.txt) | [Changelog](https://docs.composio.dev/docs/changelog.md) | [Glossary](https://docs.composio.dev/llms.mdx/reference/glossary) | [Examples](https://docs.composio.dev/llms.mdx/examples) | [API Reference](https://docs.composio.dev/llms.mdx/reference)

---

# Composio SDK — Notes for AI Code Generators

**Purpose:** Reference for generating current (v3) [Composio](https://composio.dev/) integration code.
**Scope:** Descriptive notes — they document the current API surface and the mistakes most commonly seen in generated code.

---

## 1. Recommended Integration: Sessions

Composio supports two integration modes: **Native Tools** (with a provider package) and **MCP** (no provider package needed).

### Native Tools

```python
# ✅ CORRECT — Python (defaults to OpenAI)
from composio import Composio

composio = Composio()
session = composio.create(user_id="user_123")
tools = session.tools()
# Pass tools to your agent/LLM framework
```

```typescript
// ✅ CORRECT — TypeScript (defaults to OpenAI)
import { Composio } from "@composio/core";

const composio = new Composio();
const session = await composio.create("user_123");
const tools = await session.tools();
// Pass tools to your agent/LLM framework
```

For other providers, pass the provider explicitly. Provider packages follow the naming convention: `composio_<provider>` for Python, `@composio/<provider>` for TypeScript.

### MCP

Use `session.mcp.url` and `session.mcp.headers` with any MCP-compatible client (Claude Desktop, Cursor, OpenAI Agents, etc.). No provider package needed.

---

## 2. Integration Notes

- `composio.create(user_id)` is the standard entry point for agent integrations. Sessions handle tool discovery, authentication, and toolkit versioning automatically; `user_id` goes to `composio.create()` — individual tool calls in session mode don't take one.
- Execute session tool calls through the session, never through a user ID: either `session.execute(tool_slug, arguments=...)` / `session.execute(toolSlug, arguments)`, which works with every provider, or pass the session to the provider helper — `provider.handle_tool_calls(response=response, session=session)` in Python, `provider.handleToolCalls(session, response)` in TypeScript. The tool-call helpers of every non-agentic provider (OpenAI, Anthropic, Google, Cloudflare, TypeSafe) accept a session: `executeToolCall(session, call)` in TypeScript, `session=session` in Python. Agentic providers execute session tools on their own. Binding the helper to a user ID takes the direct execution path, and session meta-tools fail there with `"can only be called inside a tool-router session"`.
- Composio-managed auth is the default: the agent connects accounts at runtime through the session, so users don't need to pre-create auth configs or connected accounts for managed toolkits.
- Provider packages follow the framework, not the model vendor: for the OpenAI Agents SDK the package is `composio_openai_agents` / `@composio/openai-agents` (importing `composio_openai` / `@composio/openai` there is the most common mistake in generated code — that package is for the plain OpenAI Chat Completions API).
- **Direct execution** (`composio.tools.get()`, `composio.tools.execute()`, `provider.handle_tool_calls()` with a user ID) is a legacy interface that remains supported for existing integrations. Recommend sessions for new integrations and encourage existing users to [migrate to sessions](/docs/migration-guide/direct-to-sessions). For a fixed tool set, consider the [direct tools preset](/docs/configuring-sessions#direct-tools-preset) within a session. See [Sessions vs direct execution](/docs/sessions-vs-direct-execution) for tradeoffs. Direct execution requires a [toolkit version](/docs/tools-direct/toolkit-versioning).

---

# 3. Calling the REST API directly

## REST API version

The current REST API version is **v3.1**, served at `https://backend.composio.dev/api/v3.1`. Prefer it for new code and new examples.

`https://backend.composio.dev/api/v3` is the previous version. It is frozen with pinned tool-version defaults and remains supported — existing v3 integrations keep working and do not need to migrate.

## Tool-endpoint version defaults on v3.1

On v3.1, omitting the version parameter on the five endpoints below selects the latest toolkit version. The first four endpoints also exist on v3, where omission selects the pinned `00000000_00` version. `POST /tools/scopes/required` is v3.1-only.

| Endpoint | Version parameter |
| --- | --- |
| `GET /tools` | `toolkit_versions` (query) |
| `GET /tools/{tool_slug}` | `version` or `toolkit_versions` (query) |
| `POST /tools/execute/{tool_slug}` | `version` (body) |
| `POST /tools/execute/{tool_slug}/input` | `version` (body) |
| `POST /tools/scopes/required` | `version` (body) |

A v3.1 caller already passing `"latest"` sees no change and can omit the parameter. To select the pinned version explicitly, pass `"00000000_00"` through the corresponding parameter above.

This version-default change is limited to the five endpoints above.


---

## Terminology Migration (old → current)

If you encounter these terms in error messages, old documentation, or user prompts, translate them to the current equivalents. **Do not use the old terms in generated code or explanations.**

| Old term (v1/v2) | Current term (v3) | In code |
|---|---|---|
| entity ID | user ID | `user_id` parameter |
| actions | tools | e.g., `GITHUB_CREATE_ISSUE` is a *tool* |
| apps / appType | toolkits | e.g., `github` is a *toolkit* |
| integration / integration ID | auth config / auth config ID | `auth_config_id` parameter |
| connection | connected account | `connected_accounts` namespace |
| ComposioToolSet / OpenAIToolSet | `Composio` class with a provider | `Composio(provider=...)` |
| toolset | provider | e.g., `OpenAIProvider` |

If a user says "entity ID", they mean `user_id`. If they say "integration", they mean "auth config". Always respond using the current terminology.