CONNECT APP
Build with Komos
The Operations Layer for Background Screening
Human Resources
- API key
MCP
Give your agent Komos tools
Every Komos action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Komos account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "komos",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Get Task Run:
const result = await mcp.callTool({
name: "komos-get-task-run",
arguments: {
runId: "Run ID",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "komos",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Get Task Run:
result = await session.call_tool("komos-get-task-run", {
"runId": "Run ID",
})API PROXY
Call the Komos API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Komos API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://api.komos.ai/public/v1/tasks",
})
// Any allowed Komos endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://api.komos.ai/public/v1/tasks
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkua29tb3MuYWkvcHVibGljL3YxL3Rhc2tz?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Komos actions from your backend
Connect a user's Komos account once, then run Get Task Run on their behalf from your own code — TypeScript, Python, or plain HTTP.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "komos-get-task-run",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
komos: { authProvisionId: "apn_xxxxxxx" },
runId: "Run ID",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="komos-get-task-run",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"komos": {"authProvisionId": "apn_xxxxxxx"},
"runId": "Run ID",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "komos-get-task-run",
"configured_props": {
"komos": { "authProvisionId": "apn_xxxxxxx" },
"runId": "Run ID"
}
}'TOOLS
Komos actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Get Task Run
actionFetch the latest status and outputs for a Komos task run. See the documentationRead-onlyv0.0.1 -
List Task Runs
actionReturn the run history for a Komos task (up to 50 runs). See the documentationRead-onlyv0.0.1 -
List Tasks
actionReturn a paginated list of Komos tasks, with optional filtering by name or status. See the documentationRead-onlyv0.0.2 -
Queue Task Run
actionQueue a saved Komos task run with optional inputs. See the documentationWritev0.0.1
No Komos triggers are available yet.
- App slug
- komos
- Authentication
- API key
- Categories
- Human Resources
- Actions
- 4
- Triggers
- 0
- API proxy
- Available