@devries-cameron20 / composio-1 / commits / 88c480270
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

Add API Reference section with OpenAPI integration

- Integrate fumadocs-openapi for auto-generated API docs from OpenAPI spec - Add filtered OpenAPI spec script (scripts/fetch-openapi.mjs) to remove duplicate endpoints and internal APIs (CLI, Admin, Profiling) - Create API Reference landing page with authentication docs and videos - Support both x-api-key and x-org-api-key authentication methods - Add instructional videos for fetching API keys 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Sushmithamallesh committed Jan 1, 2026 at 21:58 UTC 88c4802701cd5885c91396933aaba8d5c23ed80b
17 files changed +48706 -17
fumadocs/.env.example new
+4
@@ -0,0 +1,4 @@
1 +# OpenAPI Spec URL for API Reference
2 +# Production: https://backend.composio.dev/api/v3/openapi.json
3 +# Staging: https://staging-backend.composio.dev/api/v3/openapi.json (update with your staging URL)
4 +OPENAPI_SPEC_URL=https://backend.composio.dev/api/v3/openapi.json
fumadocs/app/(home)/reference/[[...slug]]/page.tsx
+79 -4
@@ -1,6 +1,81 @@
1 +import type { ComponentType } from 'react';
2 import { referenceSource } from '@/lib/source';
2 -import { createDocsPage, createGenerateStaticParams, createGenerateMetadata } from '@/lib/create-docs-page';
3 +import { APIPage } from '@/components/api-page';
4 +import {
5 + DocsBody,
6 + DocsDescription,
7 + DocsPage,
8 + DocsTitle,
9 +} from 'fumadocs-ui/layouts/docs/page';
10 +import { notFound } from 'next/navigation';
11 +import { getMDXComponents } from '@/mdx-components';
12 +import type { Metadata } from 'next';
13 +import { createRelativeLink } from 'fumadocs-ui/mdx';
14 +import type { ApiPageProps } from 'fumadocs-openapi/ui';
15
4 -export default createDocsPage(referenceSource);
5 -export const generateStaticParams = createGenerateStaticParams(referenceSource);
6 -export const generateMetadata = createGenerateMetadata(referenceSource);
16 +interface OpenAPIPageData {
17 + title: string;
18 + description?: string;
19 + getAPIPageProps: () => ApiPageProps;
20 +}
21 +
22 +export default async function Page({
23 + params,
24 +}: {
25 + params: Promise<{ slug?: string[] }>;
26 +}) {
27 + const { slug } = await params;
28 + const page = referenceSource.getPage(slug);
29 + if (!page) notFound();
30 +
31 + // Check if this is an OpenAPI page (has getAPIPageProps method)
32 + if ('getAPIPageProps' in page.data) {
33 + const pageData = page.data as OpenAPIPageData;
34 + return (
35 + <DocsPage full>
36 + <h1 className="text-2xl font-semibold mb-4">{pageData.title}</h1>
37 + <DocsBody>
38 + <APIPage {...pageData.getAPIPageProps()} />
39 + </DocsBody>
40 + </DocsPage>
41 + );
42 + }
43 +
44 + // Regular MDX page - cast to any to avoid complex type issues
45 + // eslint-disable-next-line @typescript-eslint/no-explicit-any
46 + const mdxData = page.data as any;
47 + const MDX = mdxData.body;
48 +
49 + return (
50 + <DocsPage toc={mdxData.toc} full={mdxData.full} footer={{ enabled: false }}>
51 + <DocsTitle>{mdxData.title}</DocsTitle>
52 + <DocsDescription>{mdxData.description}</DocsDescription>
53 + <DocsBody>
54 + <MDX
55 + components={getMDXComponents({
56 + a: createRelativeLink(referenceSource, page),
57 + })}
58 + />
59 + </DocsBody>
60 + </DocsPage>
61 + );
62 +}
63 +
64 +export function generateStaticParams() {
65 + return referenceSource.generateParams();
66 +}
67 +
68 +export async function generateMetadata({
69 + params,
70 +}: {
71 + params: Promise<{ slug?: string[] }>;
72 +}): Promise<Metadata> {
73 + const { slug } = await params;
74 + const page = referenceSource.getPage(slug);
75 + if (!page) notFound();
76 +
77 + return {
78 + title: page.data.title,
79 + description: page.data.description,
80 + };
81 +}
fumadocs/app/global.css
+1
@@ -1,6 +1,7 @@
1 @import 'tailwindcss';
2 @import 'fumadocs-ui/css/neutral.css';
3 @import 'fumadocs-ui/css/preset.css';
4 +@import 'fumadocs-openapi/css/preset.css';
5 @import "tw-animate-css";
6
7 @custom-variant dark (&:is(.dark *));
fumadocs/bun.lock
+62
@@ -9,11 +9,13 @@
9 "clsx": "^2.1.1",
10 "fumadocs-core": "16.3.2",
11 "fumadocs-mdx": "14.2.2",
12 + "fumadocs-openapi": "^10.2.2",
13 "fumadocs-ui": "16.3.2",
14 "lucide-react": "^0.562.0",
15 "next": "16.0.10",
16 "react": "^19.2.3",
17 "react-dom": "^19.2.3",
18 + "shiki": "^3.20.0",
19 "tailwind-merge": "^3.4.0",
20 },
21 "devDependencies": {
@@ -154,6 +156,8 @@
156
157 "@fumadocs/ui": ["@fumadocs/ui@16.3.2", "", { "dependencies": { "fumadocs-core": "16.3.2", "lodash.merge": "^4.6.2", "next-themes": "^0.4.6", "postcss-selector-parser": "^7.1.1", "tailwind-merge": "^3.4.0" }, "peerDependencies": { "@types/react": "*", "next": "16.x.x", "react": "^19.2.0", "react-dom": "^19.2.0", "tailwindcss": "^4.0.0" }, "optionalPeers": ["@types/react", "next", "tailwindcss"] }, "sha512-CY5LAG1YZmU8Z1FQ0IfxMofV05oWbesX1Awx1vGSsIRIGPiMb5U0scvfEbI8OzAGCV4Xn9E6AgVr+k9b+JVKsQ=="],
158
159 + "@fumari/json-schema-to-typescript": ["@fumari/json-schema-to-typescript@2.0.0", "", { "dependencies": { "js-yaml": "^4.1.0" }, "peerDependencies": { "@apidevtools/json-schema-ref-parser": "14.x.x", "prettier": "3.x.x" }, "optionalPeers": ["@apidevtools/json-schema-ref-parser", "prettier"] }, "sha512-X0Wm3QJLj1Rtb1nY2exM6QwMXb9LGyIKLf35+n6xyltDDBLMECOC4R/zPaw3RwgFVmvRLSmLCd+ht4sKabgmNw=="],
160 +
161 "@humanfs/core": ["@humanfs/core@0.19.1", "", {}, "sha512-5DyQ4+1JEUzejeK1JGICcideyfUbGixgS9jNgex5nqkW+cY7WZhxBigmieN5Qnw9ZosSNVC9KQKyb+GUaGyKUA=="],
162
163 "@humanfs/node": ["@humanfs/node@0.16.7", "", { "dependencies": { "@humanfs/core": "^0.19.1", "@humanwhocodes/retry": "^0.4.0" } }, "sha512-/zUx+yOsIrG4Y43Eh2peDeKCxlRt/gET6aHfaKpuq267qXdYDFViVHfMaLyygZOnl0kGWxFIgsBy8QFuTLUXEQ=="],
@@ -300,6 +304,8 @@
304
305 "@radix-ui/react-scroll-area": ["@radix-ui/react-scroll-area@1.2.10", "", { "dependencies": { "@radix-ui/number": "1.1.1", "@radix-ui/primitive": "1.1.3", "@radix-ui/react-compose-refs": "1.1.2", "@radix-ui/react-context": "1.1.2", "@radix-ui/react-direction": "1.1.1", "@radix-ui/react-presence": "1.1.5", "@radix-ui/react-primitive": "2.1.3", "@radix-ui/react-use-callback-ref": "1.1.1", "@radix-ui/react-use-layout-effect": "1.1.1" }, "peerDependencies": { "@types/react": "*", "@types/react-dom": "*", "react": "^16.8 || ^17.0 || ^18.0 || ^19.0 || ^19.0.0-rc", "react-dom": "^16.8 || ^17.0 || ^18.0 || ^19.0 || ^19.0.0-rc" }, "optionalPeers": ["@types/react", "@types/react-dom"] }, "sha512-tAXIa1g3sM5CGpVT0uIbUx/U3Gs5N8T52IICuCtObaos1S8fzsrPXG5WObkQN3S6NVl6wKgPhAIiBGbWnvc97A=="],
306
307 + "@radix-ui/react-select": ["@radix-ui/react-select@2.2.6", "", { "dependencies": { "@radix-ui/number": "1.1.1", "@radix-ui/primitive": "1.1.3", "@radix-ui/react-collection": "1.1.7", "@radix-ui/react-compose-refs": "1.1.2", "@radix-ui/react-context": "1.1.2", "@radix-ui/react-direction": "1.1.1", "@radix-ui/react-dismissable-layer": "1.1.11", "@radix-ui/react-focus-guards": "1.1.3", "@radix-ui/react-focus-scope": "1.1.7", "@radix-ui/react-id": "1.1.1", "@radix-ui/react-popper": "1.2.8", "@radix-ui/react-portal": "1.1.9", "@radix-ui/react-primitive": "2.1.3", "@radix-ui/react-slot": "1.2.3", "@radix-ui/react-use-callback-ref": "1.1.1", "@radix-ui/react-use-controllable-state": "1.2.2", "@radix-ui/react-use-layout-effect": "1.1.1", "@radix-ui/react-use-previous": "1.1.1", "@radix-ui/react-visually-hidden": "1.2.3", "aria-hidden": "^1.2.4", "react-remove-scroll": "^2.6.3" }, "peerDependencies": { "@types/react": "*", "@types/react-dom": "*", "react": "^16.8 || ^17.0 || ^18.0 || ^19.0 || ^19.0.0-rc", "react-dom": "^16.8 || ^17.0 || ^18.0 || ^19.0 || ^19.0.0-rc" }, "optionalPeers": ["@types/react", "@types/react-dom"] }, "sha512-I30RydO+bnn2PQztvo25tswPH+wFBjehVGtmagkU78yMdwTwVf12wnAOF+AeP8S2N8xD+5UPbGhkUfPyvT+mwQ=="],
308 +
309 "@radix-ui/react-slot": ["@radix-ui/react-slot@1.2.4", "", { "dependencies": { "@radix-ui/react-compose-refs": "1.1.2" }, "peerDependencies": { "@types/react": "*", "react": "^16.8 || ^17.0 || ^18.0 || ^19.0 || ^19.0.0-rc" }, "optionalPeers": ["@types/react"] }, "sha512-Jl+bCv8HxKnlTLVrcDE8zTMJ09R9/ukw4qBs/oZClOfoQk/cOTbDn+NceXfV7j09YPVQUryJPHurafcSg6EVKA=="],
310
311 "@radix-ui/react-tabs": ["@radix-ui/react-tabs@1.1.13", "", { "dependencies": { "@radix-ui/primitive": "1.1.3", "@radix-ui/react-context": "1.1.2", "@radix-ui/react-direction": "1.1.1", "@radix-ui/react-id": "1.1.1", "@radix-ui/react-presence": "1.1.5", "@radix-ui/react-primitive": "2.1.3", "@radix-ui/react-roving-focus": "1.1.11", "@radix-ui/react-use-controllable-state": "1.2.2" }, "peerDependencies": { "@types/react": "*", "@types/react-dom": "*", "react": "^16.8 || ^17.0 || ^18.0 || ^19.0 || ^19.0.0-rc", "react-dom": "^16.8 || ^17.0 || ^18.0 || ^19.0 || ^19.0.0-rc" }, "optionalPeers": ["@types/react", "@types/react-dom"] }, "sha512-7xdcatg7/U+7+Udyoj2zodtI9H/IIopqo+YOIcZOq1nJwXWBZ9p8xiu5llXlekDbZkca79a/fozEYQXIA4sW6A=="],
@@ -326,6 +332,16 @@
332
333 "@rtsao/scc": ["@rtsao/scc@1.1.0", "", {}, "sha512-zt6OdqaDoOnJ1ZYsCYGt9YmWzDXl4vQdKTyJev62gFhRGKdx7mcT54V9KIjg+d2wi9EXsPvAPKe7i7WjfVWB8g=="],
334
335 + "@scalar/helpers": ["@scalar/helpers@0.2.4", "", {}, "sha512-G7oGybO2QXM+MIxa4OZLXaYsS9mxKygFgOcY4UOXO6xpVoY5+8rahdak9cPk7HNj8RZSt4m/BveoT8g5BtnXxg=="],
336 +
337 + "@scalar/json-magic": ["@scalar/json-magic@0.8.8", "", { "dependencies": { "@scalar/helpers": "0.2.4", "yaml": "^2.8.0" } }, "sha512-BUyBfXrbwRrpjqPXHbUTYQD06KRtonoWIVTxCylQmS4kbp91k9G7SUCnJe9txX1GrpD6CwkBvyQ/Q9oNy1HTaw=="],
338 +
339 + "@scalar/openapi-parser": ["@scalar/openapi-parser@0.23.9", "", { "dependencies": { "@scalar/json-magic": "0.8.8", "@scalar/openapi-types": "0.5.3", "@scalar/openapi-upgrader": "0.1.6", "ajv": "^8.17.1", "ajv-draft-04": "^1.0.0", "ajv-formats": "^3.0.1", "jsonpointer": "^5.0.1", "leven": "^4.0.0", "yaml": "^2.8.0" } }, "sha512-0fMsZtTKKEXy9q4TDJnJa3DYXe450FcpZilaIYMJmjjEBVW78op8GnHJjuxvaYIw1gkj2Stz71qzvnoz1VomBg=="],
340 +
341 + "@scalar/openapi-types": ["@scalar/openapi-types@0.5.3", "", { "dependencies": { "zod": "^4.1.11" } }, "sha512-m4n/Su3K01d15dmdWO1LlqecdSPKuNjuokrJLdiQ485kW/hRHbXW1QP6tJL75myhw/XhX5YhYAR+jrwnGjXiMw=="],
342 +
343 + "@scalar/openapi-upgrader": ["@scalar/openapi-upgrader@0.1.6", "", { "dependencies": { "@scalar/openapi-types": "0.5.3" } }, "sha512-XdrNZUr0ASLfR89OS2zP6enbq9f7UGQQxov+a3WF1Wz9DClniAL2ChJ2fbGOrqL5F2kjbV6Fw/iO3bsBTMyLZA=="],
344 +
345 "@shikijs/core": ["@shikijs/core@3.20.0", "", { "dependencies": { "@shikijs/types": "3.20.0", "@shikijs/vscode-textmate": "^10.0.2", "@types/hast": "^3.0.4", "hast-util-to-html": "^9.0.5" } }, "sha512-f2ED7HYV4JEk827mtMDwe/yQ25pRiXZmtHjWF8uzZKuKiEsJR7Ce1nuQ+HhV9FzDcbIo4ObBCD9GPTzNuy9S1g=="],
346
347 "@shikijs/engine-javascript": ["@shikijs/engine-javascript@3.20.0", "", { "dependencies": { "@shikijs/types": "3.20.0", "@shikijs/vscode-textmate": "^10.0.2", "oniguruma-to-es": "^4.3.4" } }, "sha512-OFx8fHAZuk7I42Z9YAdZ95To6jDePQ9Rnfbw9uSRTSbBhYBp1kEOKv/3jOimcj3VRUKusDYM6DswLauwfhboLg=="],
@@ -472,6 +488,10 @@
488
489 "ajv": ["ajv@6.12.6", "", { "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", "json-schema-traverse": "^0.4.1", "uri-js": "^4.2.2" } }, "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g=="],
490
491 + "ajv-draft-04": ["ajv-draft-04@1.0.0", "", { "peerDependencies": { "ajv": "^8.5.0" }, "optionalPeers": ["ajv"] }, "sha512-mv00Te6nmYbRp5DCwclxtt7yV/joXJPGS7nM+97GdxvuttCOfgI3K4U25zboyeX0O+myI8ERluxQe5wljMmVIw=="],
492 +
493 + "ajv-formats": ["ajv-formats@3.0.1", "", { "dependencies": { "ajv": "^8.0.0" } }, "sha512-8iUql50EUR+uUcdRQ3HDqa6EVyo3docL8g5WJ3FNcWmu62IbkGUue/pEyLBW8VGKKucTPgqeks4fIU1DA4yowQ=="],
494 +
495 "ansi-styles": ["ansi-styles@4.3.0", "", { "dependencies": { "color-convert": "^2.0.1" } }, "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg=="],
496
497 "argparse": ["argparse@2.0.1", "", {}, "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q=="],
@@ -690,6 +710,10 @@
710
711 "fast-levenshtein": ["fast-levenshtein@2.0.6", "", {}, "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw=="],
712
713 + "fast-uri": ["fast-uri@3.1.0", "", {}, "sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA=="],
714 +
715 + "fast-xml-parser": ["fast-xml-parser@4.5.3", "", { "dependencies": { "strnum": "^1.1.1" }, "bin": { "fxparser": "src/cli/cli.js" } }, "sha512-RKihhV+SHsIUGXObeVy9AXiBbFwkVk7Syp8XgwN5U3JV416+Gwp/GO9i0JYKmikykgz/UHRrrV4ROuZEo/T0ig=="],
716 +
717 "fastq": ["fastq@1.19.1", "", { "dependencies": { "reusify": "^1.0.4" } }, "sha512-GwLTyxkCXjXbxqIhTsMI2Nui8huMPtnxg7krajPJAjnEG/iiOS7i+zCtWGZR9G0NBKbXKh6X9m9UIsYX/N6vvQ=="],
718
719 "fdir": ["fdir@6.5.0", "", { "peerDependencies": { "picomatch": "^3 || ^4" }, "optionalPeers": ["picomatch"] }, "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg=="],
@@ -706,10 +730,14 @@
730
731 "for-each": ["for-each@0.3.5", "", { "dependencies": { "is-callable": "^1.2.7" } }, "sha512-dKx12eRCVIzqCxFGplyFKJMPvLEWgmNtUrpTiJIR5u97zEhRG8ySrtboPHZXx7daLxQVrl643cTzbab2tkQjxg=="],
732
733 + "foreach": ["foreach@2.0.6", "", {}, "sha512-k6GAGDyqLe9JaebCsFCoudPPWfihKu8pylYXRlqP1J7ms39iPoTtk2fviNglIeQEwdh0bQeKJ01ZPyuyQvKzwg=="],
734 +
735 "fumadocs-core": ["fumadocs-core@16.3.2", "", { "dependencies": { "@formatjs/intl-localematcher": "^0.7.2", "@orama/orama": "^3.1.17", "@shikijs/rehype": "^3.20.0", "@shikijs/transformers": "^3.20.0", "estree-util-value-to-estree": "^3.5.0", "github-slugger": "^2.0.0", "hast-util-to-estree": "^3.1.3", "hast-util-to-jsx-runtime": "^2.3.6", "image-size": "^2.0.2", "negotiator": "^1.0.0", "npm-to-yarn": "^3.0.1", "path-to-regexp": "^8.3.0", "remark": "^15.0.1", "remark-gfm": "^4.0.1", "remark-rehype": "^11.1.2", "scroll-into-view-if-needed": "^3.1.0", "shiki": "^3.20.0", "unist-util-visit": "^5.0.0" }, "peerDependencies": { "@mixedbread/sdk": "^0.19.0", "@orama/core": "1.x.x", "@tanstack/react-router": "1.x.x", "@types/react": "*", "algoliasearch": "5.x.x", "lucide-react": "*", "next": "16.x.x", "react": "^19.2.0", "react-dom": "^19.2.0", "react-router": "7.x.x", "waku": "^0.26.0 || ^0.27.0", "zod": "*" }, "optionalPeers": ["@mixedbread/sdk", "@orama/core", "@tanstack/react-router", "@types/react", "algoliasearch", "lucide-react", "next", "react", "react-dom", "react-router", "waku", "zod"] }, "sha512-lpvW2qnH0C7c1CGCv6Ym1GrDTVyV+APb1h3hBuWcGiAamNN1vw7lldXQVJ5ENL/SJr6TQ6gJ+qHExNohsh/ynA=="],
736
737 "fumadocs-mdx": ["fumadocs-mdx@14.2.2", "", { "dependencies": { "@mdx-js/mdx": "^3.1.1", "@standard-schema/spec": "^1.1.0", "chokidar": "^5.0.0", "esbuild": "^0.27.2", "estree-util-value-to-estree": "^3.5.0", "js-yaml": "^4.1.1", "mdast-util-to-markdown": "^2.1.2", "picocolors": "^1.1.1", "picomatch": "^4.0.3", "remark-mdx": "^3.1.1", "tinyexec": "^1.0.2", "tinyglobby": "^0.2.15", "unified": "^11.0.5", "unist-util-remove-position": "^5.0.0", "unist-util-visit": "^5.0.0", "vfile": "^6.0.3", "zod": "^4.2.1" }, "peerDependencies": { "@fumadocs/mdx-remote": "^1.4.0", "@types/react": "*", "fumadocs-core": "^15.0.0 || ^16.0.0", "next": "^15.3.0 || ^16.0.0", "react": "*", "vite": "6.x.x || 7.x.x" }, "optionalPeers": ["@fumadocs/mdx-remote", "@types/react", "next", "react", "vite"], "bin": { "fumadocs-mdx": "dist/bin.js" } }, "sha512-ClRjZd5WloWhbNHcUgA0PvbiTFuVKjv+qmrfF4aAeHzae6jeZtm1dvSYZ6iKoEHjFz6bt3UqiCgLHAUuXS8ifg=="],
738
739 + "fumadocs-openapi": ["fumadocs-openapi@10.2.2", "", { "dependencies": { "@fumari/json-schema-to-typescript": "^2.0.0", "@radix-ui/react-accordion": "^1.2.12", "@radix-ui/react-dialog": "^1.1.15", "@radix-ui/react-select": "^2.2.6", "@radix-ui/react-slot": "^1.2.4", "@scalar/json-magic": "^0.8.8", "@scalar/openapi-parser": "0.23.9", "ajv": "^8.17.1", "class-variance-authority": "^0.7.1", "github-slugger": "^2.0.0", "hast-util-to-jsx-runtime": "^2.3.6", "js-yaml": "^4.1.1", "next-themes": "^0.4.6", "openapi-sampler": "^1.6.2", "react-hook-form": "^7.69.0", "remark": "^15.0.1", "remark-rehype": "^11.1.2", "tailwind-merge": "^3.4.0", "xml-js": "^1.6.11" }, "peerDependencies": { "@scalar/api-client-react": "*", "@types/react": "*", "fumadocs-core": "^16.2.0", "fumadocs-ui": "^16.2.0", "react": "^19.2.0", "react-dom": "^19.2.0" }, "optionalPeers": ["@scalar/api-client-react", "@types/react"] }, "sha512-cWmcoyOxoVMW6kezmYLuTe4W2tb0oTXlGBnCQFn5LgUS5+fTCf/HxnUImvGDTKt7zqoVPc8agjxv5vknDWua8Q=="],
740 +
741 "fumadocs-ui": ["fumadocs-ui@16.3.2", "", { "dependencies": { "@fumadocs/ui": "16.3.2", "@radix-ui/react-accordion": "^1.2.12", "@radix-ui/react-collapsible": "^1.1.12", "@radix-ui/react-dialog": "^1.1.15", "@radix-ui/react-direction": "^1.1.1", "@radix-ui/react-navigation-menu": "^1.2.14", "@radix-ui/react-popover": "^1.1.15", "@radix-ui/react-presence": "^1.1.5", "@radix-ui/react-scroll-area": "^1.2.10", "@radix-ui/react-slot": "^1.2.4", "@radix-ui/react-tabs": "^1.1.13", "class-variance-authority": "^0.7.1", "fumadocs-core": "16.3.2", "next-themes": "^0.4.6", "react-medium-image-zoom": "^5.4.0", "scroll-into-view-if-needed": "^3.1.0" }, "peerDependencies": { "@types/react": "*", "react": "^19.2.0", "react-dom": "^19.2.0", "tailwindcss": "^4.0.0" }, "optionalPeers": ["@types/react", "tailwindcss"] }, "sha512-ju7s+DOG5MhrAEgKZOMhSdcmGkywj8AW688EB6HovmS9xsjcezJq5Egp2izJte1Y9c9lfBEIjbgxX33W+lZI9g=="],
742
743 "function-bind": ["function-bind@1.1.2", "", {}, "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA=="],
@@ -864,12 +892,16 @@
892
893 "json-buffer": ["json-buffer@3.0.1", "", {}, "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ=="],
894
895 + "json-pointer": ["json-pointer@0.6.2", "", { "dependencies": { "foreach": "^2.0.4" } }, "sha512-vLWcKbOaXlO+jvRy4qNd+TI1QUPZzfJj1tpJ3vAXDych5XJf93ftpUKe5pKCrzyIIwgBJcOcCVRUfqQP25afBw=="],
896 +
897 "json-schema-traverse": ["json-schema-traverse@0.4.1", "", {}, "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg=="],
898
899 "json-stable-stringify-without-jsonify": ["json-stable-stringify-without-jsonify@1.0.1", "", {}, "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw=="],
900
901 "json5": ["json5@1.0.2", "", { "dependencies": { "minimist": "^1.2.0" }, "bin": { "json5": "lib/cli.js" } }, "sha512-g1MWMLBiz8FKi1e4w0UyVL3w+iJceWAFBAaBnnGKOpNa5f8TLktkbre1+s6oICydWAm+HRUGTmI+//xv2hvXYA=="],
902
903 + "jsonpointer": ["jsonpointer@5.0.1", "", {}, "sha512-p/nXbhSEcu3pZRdkW1OfJhpsVtW1gd4Wa1fnQc9YLiTfAjn0312eMKimbdIQzuZl9aa9xUGaRlP9T/CJE/ditQ=="],
904 +
905 "jsx-ast-utils": ["jsx-ast-utils@3.3.5", "", { "dependencies": { "array-includes": "^3.1.6", "array.prototype.flat": "^1.3.1", "object.assign": "^4.1.4", "object.values": "^1.1.6" } }, "sha512-ZZow9HBI5O6EPgSJLUb8n2NKgmVWTwCvHGwFuJlMjvLFqlGG6pjirPhtdsseaLZjSibD8eegzmYpUZwoIlj2cQ=="],
906
907 "keyv": ["keyv@4.5.4", "", { "dependencies": { "json-buffer": "3.0.1" } }, "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw=="],
@@ -878,6 +910,8 @@
910
911 "language-tags": ["language-tags@1.0.9", "", { "dependencies": { "language-subtag-registry": "^0.3.20" } }, "sha512-MbjN408fEndfiQXbFQ1vnd+1NoLDsnQW41410oQBXiyXDMYH5z505juWa4KUE1LqxRC7DgOgZDbKLxHIwm27hA=="],
912
913 + "leven": ["leven@4.1.0", "", {}, "sha512-KZ9W9nWDT7rF7Dazg8xyLHGLrmpgq2nVNFUckhqdW3szVP6YhCpp/RAnpmVExA9JvrMynjwSLVrEj3AepHR6ew=="],
914 +
915 "levn": ["levn@0.4.1", "", { "dependencies": { "prelude-ls": "^1.2.1", "type-check": "~0.4.0" } }, "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ=="],
916
917 "lightningcss": ["lightningcss@1.30.2", "", { "dependencies": { "detect-libc": "^2.0.3" }, "optionalDependencies": { "lightningcss-android-arm64": "1.30.2", "lightningcss-darwin-arm64": "1.30.2", "lightningcss-darwin-x64": "1.30.2", "lightningcss-freebsd-x64": "1.30.2", "lightningcss-linux-arm-gnueabihf": "1.30.2", "lightningcss-linux-arm64-gnu": "1.30.2", "lightningcss-linux-arm64-musl": "1.30.2", "lightningcss-linux-x64-gnu": "1.30.2", "lightningcss-linux-x64-musl": "1.30.2", "lightningcss-win32-arm64-msvc": "1.30.2", "lightningcss-win32-x64-msvc": "1.30.2" } }, "sha512-utfs7Pr5uJyyvDETitgsaqSyjCb2qNRAtuqUeWIAKztsOYdcACf2KtARYXg2pSvhkt+9NfoaNY7fxjl6nuMjIQ=="],
@@ -1072,6 +1106,8 @@
1106
1107 "oniguruma-to-es": ["oniguruma-to-es@4.3.4", "", { "dependencies": { "oniguruma-parser": "^0.12.1", "regex": "^6.0.1", "regex-recursion": "^6.0.2" } }, "sha512-3VhUGN3w2eYxnTzHn+ikMI+fp/96KoRSVK9/kMTcFqj1NRDh2IhQCKvYxDnWePKRXY/AqH+Fuiyb7VHSzBjHfA=="],
1108
1109 + "openapi-sampler": ["openapi-sampler@1.6.2", "", { "dependencies": { "@types/json-schema": "^7.0.7", "fast-xml-parser": "^4.5.0", "json-pointer": "0.6.2" } }, "sha512-NyKGiFKfSWAZr4srD/5WDhInOWDhfml32h/FKUqLpEwKJt0kG0LGUU0MdyNkKrVGuJnw6DuPWq/sHCwAMpiRxg=="],
1110 +
1111 "optionator": ["optionator@0.9.4", "", { "dependencies": { "deep-is": "^0.1.3", "fast-levenshtein": "^2.0.6", "levn": "^0.4.1", "prelude-ls": "^1.2.1", "type-check": "^0.4.0", "word-wrap": "^1.2.5" } }, "sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g=="],
1112
1113 "own-keys": ["own-keys@1.0.1", "", { "dependencies": { "get-intrinsic": "^1.2.6", "object-keys": "^1.1.1", "safe-push-apply": "^1.0.0" } }, "sha512-qFOyK5PjiWZd+QQIh+1jhdb9LpxTF0qs7Pm8o5QHYZ0M3vKqSqzsZaEB6oWlxZ+q2sJBMI/Ktgd2N5ZwQoRHfg=="],
@@ -1116,6 +1152,8 @@
1152
1153 "react-dom": ["react-dom@19.2.3", "", { "dependencies": { "scheduler": "^0.27.0" }, "peerDependencies": { "react": "^19.2.3" } }, "sha512-yELu4WmLPw5Mr/lmeEpox5rw3RETacE++JgHqQzd2dg+YbJuat3jH4ingc+WPZhxaoFzdv9y33G+F7Nl5O0GBg=="],
1154
1155 + "react-hook-form": ["react-hook-form@7.69.0", "", { "peerDependencies": { "react": "^16.8.0 || ^17 || ^18 || ^19" } }, "sha512-yt6ZGME9f4F6WHwevrvpAjh42HMvocuSnSIHUGycBqXIJdhqGSPQzTpGF+1NLREk/58IdPxEMfPcFCjlMhclGw=="],
1156 +
1157 "react-is": ["react-is@16.13.1", "", {}, "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ=="],
1158
1159 "react-medium-image-zoom": ["react-medium-image-zoom@5.4.0", "", { "peerDependencies": { "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0", "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0" } }, "sha512-BsE+EnFVQzFIlyuuQrZ9iTwyKpKkqdFZV1ImEQN573QPqGrIUuNni7aF+sZwDcxlsuOMayCr6oO/PZR/yJnbRg=="],
@@ -1160,6 +1198,8 @@
1198
1199 "remark-stringify": ["remark-stringify@11.0.0", "", { "dependencies": { "@types/mdast": "^4.0.0", "mdast-util-to-markdown": "^2.0.0", "unified": "^11.0.0" } }, "sha512-1OSmLd3awB/t8qdoEOMazZkNsfVTeY4fTsgzcQFdXNq8ToTN4ZGwrMnlda4K6smTFKD+GRV6O48i6Z4iKgPPpw=="],
1200
1201 + "require-from-string": ["require-from-string@2.0.2", "", {}, "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw=="],
1202 +
1203 "resolve": ["resolve@1.22.11", "", { "dependencies": { "is-core-module": "^2.16.1", "path-parse": "^1.0.7", "supports-preserve-symlinks-flag": "^1.0.0" }, "bin": { "resolve": "bin/resolve" } }, "sha512-RfqAvLnMl313r7c9oclB1HhUEAezcpLjz95wFH4LVuhk9JF/r22qmVP9AMmOU4vMX7Q8pN8jwNg/CSpdFnMjTQ=="],
1204
1205 "resolve-from": ["resolve-from@4.0.0", "", {}, "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g=="],
@@ -1176,6 +1216,8 @@
1216
1217 "safe-regex-test": ["safe-regex-test@1.1.0", "", { "dependencies": { "call-bound": "^1.0.2", "es-errors": "^1.3.0", "is-regex": "^1.2.1" } }, "sha512-x/+Cz4YrimQxQccJf5mKEbIa1NzeCRNI5Ecl/ekmlYaampdNLPalVyIcCZNNH3MvmqBugV5TMYZXv0ljslUlaw=="],
1218
1219 + "sax": ["sax@1.4.3", "", {}, "sha512-yqYn1JhPczigF94DMS+shiDMjDowYO6y9+wB/4WgO0Y19jWYk0lQ4tuG5KI7kj4FTp1wxPj5IFfcrz/s1c3jjQ=="],
1220 +
1221 "scheduler": ["scheduler@0.27.0", "", {}, "sha512-eNv+WrVbKu1f3vbYJT/xtiF5syA5HPIMtf9IgY/nKg0sWqzAUEvqY/xm7OcZc/qafLx/iO9FgOmeSAp4v5ti/Q=="],
1222
1223 "scroll-into-view-if-needed": ["scroll-into-view-if-needed@3.1.0", "", { "dependencies": { "compute-scroll-into-view": "^3.0.2" } }, "sha512-49oNpRjWRvnU8NyGVmUaYG4jtTkNonFZI86MmGRDqBphEK2EXT9gdEUoQPZhuBM8yWHxCWbobltqYO5M4XrUvQ=="],
@@ -1232,6 +1274,8 @@
1274
1275 "strip-json-comments": ["strip-json-comments@3.1.1", "", {}, "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig=="],
1276
1277 + "strnum": ["strnum@1.1.2", "", {}, "sha512-vrN+B7DBIoTTZjnPNewwhx6cBA/H+IS7rfW68n7XxC1y7uoiGQBxaKzqucGUgavX15dJgiGztLJ8vxuEzwqBdA=="],
1278 +
1279 "style-to-js": ["style-to-js@1.1.21", "", { "dependencies": { "style-to-object": "1.0.14" } }, "sha512-RjQetxJrrUJLQPHbLku6U/ocGtzyjbJMP9lCNK7Ag0CNh690nSH8woqWH9u16nMjYBAok+i7JO1NP2pOy8IsPQ=="],
1280
1281 "style-to-object": ["style-to-object@1.0.14", "", { "dependencies": { "inline-style-parser": "0.2.7" } }, "sha512-LIN7rULI0jBscWQYaSswptyderlarFkjQ+t79nzty8tcIAceVomEVlLzH5VP4Cmsv6MtKhs7qaAiwlcp+Mgaxw=="],
@@ -1328,8 +1372,12 @@
1372
1373 "word-wrap": ["word-wrap@1.2.5", "", {}, "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA=="],
1374
1375 + "xml-js": ["xml-js@1.6.11", "", { "dependencies": { "sax": "^1.2.4" }, "bin": { "xml-js": "./bin/cli.js" } }, "sha512-7rVi2KMfwfWFl+GpPg6m80IVMWXLRjO+PxTq7V2CDhoGak0wzYzFgUY2m4XJ47OGdXd8eLE8EmwfAmdjw7lC1g=="],
1376 +
1377 "yallist": ["yallist@3.1.1", "", {}, "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g=="],
1378
1379 + "yaml": ["yaml@2.8.2", "", { "bin": { "yaml": "bin.mjs" } }, "sha512-mplynKqc1C2hTVYxd0PU2xQAc22TI1vShAYGksCCfxbn/dFwnHTNi1bvYsBTkhdUNtGIf5xNOg938rrSSYvS9A=="],
1380 +
1381 "yocto-queue": ["yocto-queue@0.1.0", "", {}, "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q=="],
1382
1383 "zod": ["zod@4.2.1", "", {}, "sha512-0wZ1IRqGGhMP76gLqz8EyfBXKk0J2qo2+H3fi4mcUP/KtTocoX08nmIAHl1Z2kJIZbZee8KOpBCSNPRgauucjw=="],
@@ -1352,6 +1400,10 @@
1400
1401 "@radix-ui/react-primitive/@radix-ui/react-slot": ["@radix-ui/react-slot@1.2.3", "", { "dependencies": { "@radix-ui/react-compose-refs": "1.1.2" }, "peerDependencies": { "@types/react": "*", "react": "^16.8 || ^17.0 || ^18.0 || ^19.0 || ^19.0.0-rc" }, "optionalPeers": ["@types/react"] }, "sha512-aeNmHnBxbi2St0au6VBVC7JXFlhLlOnvIIlePNniyUNAClzmtAUEY8/pBiK3iHjufOlwA+c20/8jngo7xcrg8A=="],
1402
1403 + "@radix-ui/react-select/@radix-ui/react-slot": ["@radix-ui/react-slot@1.2.3", "", { "dependencies": { "@radix-ui/react-compose-refs": "1.1.2" }, "peerDependencies": { "@types/react": "*", "react": "^16.8 || ^17.0 || ^18.0 || ^19.0 || ^19.0.0-rc" }, "optionalPeers": ["@types/react"] }, "sha512-aeNmHnBxbi2St0au6VBVC7JXFlhLlOnvIIlePNniyUNAClzmtAUEY8/pBiK3iHjufOlwA+c20/8jngo7xcrg8A=="],
1404 +
1405 + "@scalar/openapi-parser/ajv": ["ajv@8.17.1", "", { "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", "json-schema-traverse": "^1.0.0", "require-from-string": "^2.0.2" } }, "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g=="],
1406 +
1407 "@tailwindcss/oxide-wasm32-wasi/@emnapi/core": ["@emnapi/core@1.7.1", "", { "dependencies": { "@emnapi/wasi-threads": "1.1.0", "tslib": "^2.4.0" }, "bundled": true }, "sha512-o1uhUASyo921r2XtHYOHy7gdkGLge8ghBEQHMWmyJFoXlpU58kIrhhN3w26lpQb6dspetweapMn2CSNwQ8I4wg=="],
1408
1409 "@tailwindcss/oxide-wasm32-wasi/@emnapi/runtime": ["@emnapi/runtime@1.7.1", "", { "dependencies": { "tslib": "^2.4.0" }, "bundled": true }, "sha512-PVtJr5CmLwYAU9PZDMITZoR5iAOShYREoR45EyyLrbntV50mdePTgUn4AmOw90Ifcj+x2kRjdzr1HP3RrNiHGA=="],
@@ -1370,6 +1422,8 @@
1422
1423 "@typescript-eslint/typescript-estree/semver": ["semver@7.7.3", "", { "bin": { "semver": "bin/semver.js" } }, "sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q=="],
1424
1425 + "ajv-formats/ajv": ["ajv@8.17.1", "", { "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", "json-schema-traverse": "^1.0.0", "require-from-string": "^2.0.2" } }, "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g=="],
1426 +
1427 "eslint-import-resolver-node/debug": ["debug@3.2.7", "", { "dependencies": { "ms": "^2.1.1" } }, "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ=="],
1428
1429 "eslint-module-utils/debug": ["debug@3.2.7", "", { "dependencies": { "ms": "^2.1.1" } }, "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ=="],
@@ -1380,6 +1434,8 @@
1434
1435 "fast-glob/glob-parent": ["glob-parent@5.1.2", "", { "dependencies": { "is-glob": "^4.0.1" } }, "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow=="],
1436
1437 + "fumadocs-openapi/ajv": ["ajv@8.17.1", "", { "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", "json-schema-traverse": "^1.0.0", "require-from-string": "^2.0.2" } }, "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g=="],
1438 +
1439 "is-bun-module/semver": ["semver@7.7.3", "", { "bin": { "semver": "bin/semver.js" } }, "sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q=="],
1440
1441 "mdast-util-find-and-replace/escape-string-regexp": ["escape-string-regexp@5.0.0", "", {}, "sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw=="],
@@ -1392,6 +1448,12 @@
1448
1449 "sharp/semver": ["semver@7.7.3", "", { "bin": { "semver": "bin/semver.js" } }, "sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q=="],
1450
1451 + "@scalar/openapi-parser/ajv/json-schema-traverse": ["json-schema-traverse@1.0.0", "", {}, "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug=="],
1452 +
1453 "@typescript-eslint/typescript-estree/minimatch/brace-expansion": ["brace-expansion@2.0.2", "", { "dependencies": { "balanced-match": "^1.0.0" } }, "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ=="],
1454 +
1455 + "ajv-formats/ajv/json-schema-traverse": ["json-schema-traverse@1.0.0", "", {}, "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug=="],
1456 +
1457 + "fumadocs-openapi/ajv/json-schema-traverse": ["json-schema-traverse@1.0.0", "", {}, "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug=="],
1458 }
1459 }
fumadocs/components/api-page.client.tsx new
+4
@@ -0,0 +1,4 @@
1 +'use client';
2 +import { defineClientConfig } from 'fumadocs-openapi/ui/client';
3 +
4 +export default defineClientConfig({});
fumadocs/components/api-page.tsx new
+5
@@ -0,0 +1,5 @@
1 +import { openapi } from '@/lib/openapi';
2 +import { createAPIPage } from 'fumadocs-openapi/ui';
3 +import client from './api-page.client';
4 +
5 +export const APIPage = createAPIPage(openapi, { client });
fumadocs/content/reference/index.mdx
+28 -8
@@ -3,14 +3,34 @@ title: API Reference
3 description: Complete API and SDK reference documentation for Composio
4 ---
5
6 -Welcome to the Composio API Reference. This section contains detailed documentation for:
6 +## Authentication
7
8 -- **REST API** - Complete HTTP API documentation
9 -- **Python SDK** - Python SDK reference
10 -- **TypeScript SDK** - TypeScript SDK reference
8 +All Composio API endpoints require authentication via API key.
9
12 -## Quick Links
10 +### API Key Authentication
11
14 -- [REST API Documentation](/reference/api)
15 -- [Python SDK Reference](/reference/python)
16 -- [TypeScript SDK Reference](/reference/typescript)
12 +Include your API key in the `x-api-key` header.
13 +
14 +#### Getting Your API Key
15 +
16 +1. Sign in to [composio.dev](https://composio.dev)
17 +2. Navigate to **Settings**
18 +3. In **Project Settings**, copy the key from the **API Keys** section
19 +
20 +<video autoPlay loop muted playsInline controls width="100%">
21 + <source src="/videos/fetch-project-key.mp4" type="video/mp4" />
22 +</video>
23 +
24 +### Organization API Key
25 +
26 +For organization-level access, use the `x-org-api-key` header.
27 +
28 +#### Getting Your Organization API Key
29 +
30 +1. Sign in to [composio.dev](https://composio.dev)
31 +2. Navigate to **Organization Settings** → **General Settings**
32 +3. Copy the token under **Organization Access Tokens**
33 +
34 +<video autoPlay loop muted playsInline controls width="100%">
35 + <source src="/videos/fetch-org-key.mp4" type="video/mp4" />
36 +</video>
fumadocs/content/reference/meta.json
+2 -2
@@ -1,7 +1,7 @@
1 {
2 "title": "Reference",
3 "pages": [
4 - "---API Reference---",
5 - "index"
4 + "index",
5 + "..."
6 ]
7 }
fumadocs/lib/layout.shared.tsx
+1
@@ -51,6 +51,7 @@ export function baseOptions(): BaseLayoutProps {
51 {
52 text: 'Reference',
53 url: '/reference',
54 + active: 'nested-url',
55 },
56 {
57 text: 'Examples',
fumadocs/lib/openapi.ts new
+7
@@ -0,0 +1,7 @@
1 +import { createOpenAPI } from 'fumadocs-openapi/server';
2 +
3 +// Use local filtered spec (generated by scripts/fetch-openapi.ts)
4 +// Run `bun run scripts/fetch-openapi.ts` to update the spec
5 +export const openapi = createOpenAPI({
6 + input: ['./public/openapi.json'],
7 +});
fumadocs/lib/source.ts
+14 -3
@@ -1,6 +1,8 @@
1 import { docs, toolRouter, reference, examples, toolkits, changelog } from 'fumadocs-mdx:collections/server';
2 -import { type InferPageType, loader } from 'fumadocs-core/source';
2 +import { type InferPageType, loader, multiple } from 'fumadocs-core/source';
3 import { lucideIconsPlugin } from 'fumadocs-core/source/lucide-icons';
4 +import { openapi } from './openapi';
5 +import { openapiSource, openapiPlugin } from 'fumadocs-openapi/server';
6
7 // See https://fumadocs.dev/docs/headless/source-api for more info
8 export const source = loader({
@@ -15,10 +17,18 @@ export const toolRouterSource = loader({
17 plugins: [lucideIconsPlugin()],
18 });
19
20 +// Combined reference source with MDX pages and OpenAPI-generated pages
21 +const openapiPages = await openapiSource(openapi, {
22 + groupBy: 'tag',
23 +});
24 +
25 export const referenceSource = loader({
26 baseUrl: '/reference',
20 - source: reference.toFumadocsSource(),
21 - plugins: [lucideIconsPlugin()],
27 + source: multiple({
28 + mdx: reference.toFumadocsSource(),
29 + openapi: openapiPages,
30 + }),
31 + plugins: [lucideIconsPlugin(), openapiPlugin()],
32 });
33
34 export const examplesSource = loader({
@@ -33,6 +43,7 @@ export const toolkitsSource = loader({
43 plugins: [lucideIconsPlugin()],
44 });
45
46 +
47 export const changelogEntries = changelog;
48
49 export function getPageImage(page: InferPageType<typeof source>) {
fumadocs/package.json
+2
@@ -16,11 +16,13 @@
16 "clsx": "^2.1.1",
17 "fumadocs-core": "16.3.2",
18 "fumadocs-mdx": "14.2.2",
19 + "fumadocs-openapi": "^10.2.2",
20 "fumadocs-ui": "16.3.2",
21 "lucide-react": "^0.562.0",
22 "next": "16.0.10",
23 "react": "^19.2.3",
24 "react-dom": "^19.2.3",
25 + "shiki": "^3.20.0",
26 "tailwind-merge": "^3.4.0"
27 },
28 "devDependencies": {
fumadocs/public/openapi.json new
+48351
@@ -0,0 +1,48351 @@
1 +{
2 + "openapi": "3.0.0",
3 + "info": {
4 + "version": "3.0.0",
5 + "title": "Composio Platform API",
6 + "description": "",
7 + "contact": {
8 + "name": "Composio Support",
9 + "url": "https://composio.dev/support",
10 + "email": "support@composio.dev"
11 + },
12 + "license": {
13 + "name": "Proprietary",
14 + "url": "https://composio.dev/terms"
15 + }
16 + },
17 + "servers": [
18 + {
19 + "url": "https://backend.composio.dev",
20 + "description": "PRODUCTION API"
21 + }
22 + ],
23 + "tags": [
24 + {
25 + "name": "Authentication",
26 + "description": "Authentication related endpoints"
27 + },
28 + {
29 + "name": "Auth Configs",
30 + "description": "Authentication configuration management"
31 + },
32 + {
33 + "name": "Connected Accounts",
34 + "description": "Connected account management"
35 + },
36 + {
37 + "name": "Logs",
38 + "description": "Logging and monitoring"
39 + },
40 + {
41 + "name": "OpenAPI",
42 + "description": "OpenAPI specification management"
43 + },
44 + {
45 + "name": "Organization",
46 + "description": "Organization management"
47 + },
48 + {
49 + "name": "API Keys",
50 + "description": "API key management"
51 + },
52 + {
53 + "name": "Webhooks",
54 + "description": "Webhook configuration"
55 + },
56 + {
57 + "name": "Team",
58 + "description": "Team member management"
59 + },
60 + {
61 + "name": "Toolkits",
62 + "description": "Toolkit and tool management"
63 + },
64 + {
65 + "name": "Tools",
66 + "description": "Tool execution endpoints"
67 + },
68 + {
69 + "name": "Recipes",
70 + "description": "Recipe management and execution. Recipes are reusable code modules that combine multiple tools."
71 + },
72 + {
73 + "name": "Triggers",
74 + "description": "Trigger management and execution"
75 + },
76 + {
77 + "name": "Payments",
78 + "description": "Payment and subscription management"
79 + },
80 + {
81 + "name": "Files",
82 + "description": "File management"
83 + },
84 + {
85 + "name": "MCP",
86 + "description": "MCP server management"
87 + },
88 + {
89 + "name": "Migration",
90 + "description": "Endpoints to help with migration from v1 to v3"
91 + },
92 + {
93 + "name": "MCP Partner",
94 + "description": "MCP partner management"
95 + },
96 + {
97 + "name": "Recipe",
98 + "description": "Recipe endpoints"
99 + },
100 + {
101 + "name": "Tool Router",
102 + "description": "(Labs) Tool router endpoints"
103 + }
104 + ],
105 + "components": {
106 + "securitySchemes": {
107 + "ApiKeyAuth": {
108 + "type": "apiKey",
109 + "in": "header",
110 + "name": "x-api-key",
111 + "description": "API key authentication"
112 + },
113 + "CookieAuth": {
114 + "type": "apiKey",
115 + "in": "cookie",
116 + "name": "authToken",
117 + "description": "Cookie-based session authentication"
118 + },
119 + "OrgApiKeyAuth": {
120 + "type": "apiKey",
121 + "in": "header",
122 + "name": "x-org-api-key",
123 + "description": "Organization API key authentication"
124 + }
125 + },
126 + "schemas": {
127 + "Error": {
128 + "type": "object",
129 + "properties": {
130 + "error": {
131 + "type": "object",
132 + "properties": {
133 + "message": {
134 + "type": "string"
135 + },
136 + "code": {
137 + "type": "number"
138 + },
139 + "status": {
140 + "type": "number"
141 + },
142 + "request_id": {
143 + "type": "string"
144 + },
145 + "suggested_fix": {
146 + "type": "string"
147 + },
148 + "errors": {
149 + "type": "array",
150 + "items": {
151 + "type": "string"
152 + }
153 + }
154 + },
155 + "required": [
156 + "message",
157 + "code",
158 + "status"
159 + ]
160 + }
161 + },
162 + "required": [
163 + "error"
164 + ]
165 + },
166 + "DeprecatedToolkitInfo": {
167 + "type": "object",
168 + "properties": {
169 + "toolkitId": {
170 + "type": "string"
171 + }
172 + },
173 + "required": [
174 + "toolkitId"
175 + ],
176 + "description": "Deprecated toolkit ID",
177 + "deprecated": true,
178 + "example": {
179 + "toolkitId": "550e8400-e29b-41d4-a716-446655440000"
180 + }
181 + },
182 + "Tool": {
183 + "type": "object",
184 + "properties": {
185 + "slug": {
186 + "type": "string",
187 + "description": "Unique identifier for the tool",
188 + "example": "github-actions"
189 + },
190 + "name": {
191 + "type": "string",
192 + "description": "Human-readable display name of the tool",
193 + "example": "GitHub Actions"
194 + },
195 + "description": {
196 + "type": "string",
197 + "description": "Detailed explanation of the tool's functionality and purpose",
198 + "example": "Automate GitHub workflows including CI/CD, issue management, and release processes"
199 + },
200 + "toolkit": {
201 + "type": "object",
202 + "properties": {
203 + "slug": {
204 + "type": "string",
205 + "description": "Unique identifier of the parent toolkit",
206 + "example": "github"
207 + },
208 + "name": {
209 + "type": "string",
210 + "description": "Human-readable name of the parent toolkit",
211 + "example": "GitHub"
212 + },
213 + "logo": {
214 + "type": "string",
215 + "description": "URL to the toolkit logo image",
216 + "example": "https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png"
217 + }
218 + },
219 + "required": [
220 + "slug",
221 + "name",
222 + "logo"
223 + ]
224 + },
225 + "input_parameters": {
226 + "type": "object",
227 + "additionalProperties": {
228 + "nullable": true
229 + },
230 + "description": "Schema definition of required input parameters for the tool",
231 + "example": {
232 + "repo_name": {
233 + "type": "string",
234 + "description": "GitHub repository name in owner/repo format",
235 + "required": true,
236 + "example": "octocat/Hello-World"
237 + },
238 + "workflow_id": {
239 + "type": "string",
240 + "description": "ID or filename of the workflow to trigger",
241 + "required": true,
242 + "example": "main.yml"
243 + }
244 + }
245 + },
246 + "no_auth": {
247 + "type": "boolean",
248 + "description": "Indicates if the tool can be used without authentication",
249 + "example": false
250 + },
251 + "available_versions": {
252 + "type": "array",
253 + "items": {
254 + "type": "string"
255 + },
256 + "description": "List of all available versions for this tool",
257 + "example": [
258 + "20250905_00",
259 + "20250906_00"
260 + ]
261 + },
262 + "version": {
263 + "type": "string",
264 + "description": "Current version of the tool",
265 + "example": "20250905_00"
266 + },
267 + "output_parameters": {
268 + "type": "object",
269 + "additionalProperties": {
270 + "nullable": true
271 + },
272 + "description": "Schema definition of return values from the tool",
273 + "example": {
274 + "run_id": {
275 + "type": "number",
276 + "description": "ID of the workflow run that was triggered",
277 + "example": 12345678
278 + },
279 + "status": {
280 + "type": "string",
281 + "description": "Status of the workflow run",
282 + "example": "completed",
283 + "enum": [
284 + "queued",
285 + "in_progress",
286 + "completed",
287 + "failed"
288 + ]
289 + }
290 + }
291 + },
292 + "scopes": {
293 + "type": "array",
294 + "items": {
295 + "type": "string"
296 + },
297 + "description": "List of scopes associated with the tool",
298 + "example": [
299 + "https://www.googleapis.com/auth/gmail.modify"
300 + ]
301 + },
302 + "tags": {
303 + "type": "array",
304 + "items": {
305 + "type": "string"
306 + },
307 + "description": "List of tags associated with the tool for categorization and filtering",
308 + "example": [
309 + "ci-cd",
310 + "github",
311 + "automation",
312 + "devops"
313 + ]
314 + },
315 + "is_deprecated": {
316 + "type": "boolean",
317 + "description": "Indicates if this tool is deprecated and may be removed in the future",
318 + "example": false
319 + },
320 + "deprecated": {
321 + "type": "object",
322 + "properties": {
323 + "displayName": {
324 + "type": "string",
325 + "description": "The display name of the tool",
326 + "example": "GitHub Actions"
327 + },
328 + "version": {
329 + "type": "string",
330 + "description": "Current version identifier of the tool",
331 + "example": "20250905_00"
332 + },
333 + "available_versions": {
334 + "type": "array",
335 + "items": {
336 + "type": "string"
337 + },
338 + "description": "List of all available versions for this tool",
339 + "example": [
340 + "20250905_00",
341 + "20250906_00"
342 + ]
343 + },
344 + "is_deprecated": {
345 + "type": "boolean",
346 + "description": "Indicates if this tool is deprecated and may be removed in the future",
347 + "example": false
348 + },
349 + "toolkit": {
350 + "type": "object",
351 + "properties": {
352 + "logo": {
353 + "type": "string",
354 + "description": "URL to the toolkit logo image",
355 + "example": "https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png"
356 + }
357 + },
358 + "required": [
359 + "logo"
360 + ]
361 + }
362 + },
363 + "required": [
364 + "displayName",
365 + "version",
366 + "available_versions",
367 + "is_deprecated",
368 + "toolkit"
369 + ]
370 + }
371 + },
372 + "required": [
373 + "slug",
374 + "name",
375 + "description",
376 + "toolkit",
377 + "input_parameters",
378 + "no_auth",
379 + "available_versions",
380 + "version",
381 + "output_parameters",
382 + "scopes",
383 + "tags",
384 + "is_deprecated",
385 + "deprecated"
386 + ]
387 + },
388 + "ToolsPaginated": {
389 + "type": "object",
390 + "properties": {
391 + "items": {
392 + "type": "array",
393 + "items": {
394 + "$ref": "#/components/schemas/Tool"
395 + }
396 + },
397 + "next_cursor": {
398 + "type": "string",
399 + "nullable": true
400 + },
401 + "total_pages": {
402 + "type": "number"
403 + },
404 + "current_page": {
405 + "type": "number"
406 + },
407 + "total_items": {
408 + "type": "number"
409 + }
410 + },
411 + "required": [
412 + "items",
413 + "total_pages",
414 + "current_page",
415 + "total_items"
416 + ]
417 + },
418 + "ToolRouterToolkitsListResponse": {
419 + "type": "object",
420 + "properties": {
421 + "items": {
422 + "type": "array",
423 + "items": {
424 + "type": "object",
425 + "properties": {
426 + "name": {
427 + "type": "string",
428 + "description": "Display name of the toolkit"
429 + },
430 + "slug": {
431 + "type": "string",
432 + "description": "Unique slug identifier"
433 + },
434 + "enabled": {
435 + "type": "boolean",
436 + "description": "Whether the toolkit is enabled"
437 + },
438 + "is_no_auth": {
439 + "type": "boolean",
440 + "description": "Whether the toolkit is no-auth"
441 + },
442 + "composio_managed_auth_schemes": {
443 + "type": "array",
444 + "items": {
445 + "type": "string"
446 + },
447 + "description": "Available Composio-managed auth schemes"
448 + },
449 + "meta": {
450 + "type": "object",
451 + "properties": {
452 + "logo": {
453 + "type": "string",
454 + "format": "uri",
455 + "description": "URL to the toolkit logo"
456 + },
457 + "description": {
458 + "type": "string",
459 + "description": "Description of the toolkit"
460 + }
461 + },
462 + "required": [
463 + "logo",
464 + "description"
465 + ],
466 + "description": "Toolkit metadata"
467 + },
468 + "connected_account": {
469 + "type": "object",
470 + "nullable": true,
471 + "properties": {
472 + "id": {
473 + "type": "string",
474 + "format": "connectedAccountId",
475 + "description": "Connected account identifier"
476 + },
477 + "user_id": {
478 + "type": "string",
479 + "description": "User identifier"
480 + },
481 + "status": {
482 + "type": "string",
483 + "description": "Connection status"
484 + },
485 + "created_at": {
486 + "type": "string",
487 + "format": "date-time",
488 + "description": "Creation timestamp"
489 + },
490 + "auth_config": {
491 + "type": "object",
492 + "properties": {
493 + "id": {
494 + "type": "string",
495 + "description": "Auth config identifier"
496 + },
497 + "auth_scheme": {
498 + "type": "string",
499 + "description": "Authentication scheme type"
500 + },
501 + "is_composio_managed": {
502 + "type": "boolean",
503 + "description": "Whether this is a Composio-managed auth config"
504 + }
505 + },
506 + "required": [
507 + "id",
508 + "auth_scheme",
509 + "is_composio_managed"
510 + ],
511 + "description": "Auth config details"
512 + }
513 + },
514 + "required": [
515 + "id",
516 + "user_id",
517 + "status",
518 + "created_at",
519 + "auth_config"
520 + ],
521 + "description": "Connected account if available"
522 + }
523 + },
524 + "required": [
525 + "name",
526 + "slug",
527 + "enabled",
528 + "is_no_auth",
529 + "composio_managed_auth_schemes",
530 + "meta",
531 + "connected_account"
532 + ]
533 + }
534 + },
535 + "next_cursor": {
536 + "type": "string",
537 + "nullable": true
538 + },
539 + "total_pages": {
540 + "type": "number"
541 + },
542 + "current_page": {
543 + "type": "number"
544 + },
545 + "total_items": {
546 + "type": "number"
547 + }
548 + },
549 + "required": [
550 + "items",
551 + "total_pages",
552 + "current_page",
553 + "total_items"
554 + ]
555 + }
556 + },
557 + "parameters": {}
558 + },
559 + "paths": {
560 + "/api/v3/auth/session/info": {
561 + "get": {
562 + "summary": "Get current user session information",
563 + "description": "Retrieves detailed information about the current authenticated user session, including project details, organization membership, and API key information if applicable. This endpoint is useful for verifying authentication status and retrieving contextual information about the authenticated user and their access privileges.",
564 + "tags": [
565 + "Authentication"
566 + ],
567 + "operationId": "getAuthSessionInfo",
568 + "security": [
569 + {
570 + "ApiKeyAuth": []
571 + },
572 + {
573 + "CookieAuth": []
574 + }
575 + ],
576 + "responses": {
577 + "200": {
578 + "description": "Session is valid and active. Returns detailed information about the authenticated user, their project, and organization.",
579 + "content": {
580 + "application/json": {
581 + "schema": {
582 + "type": "object",
583 + "properties": {
584 + "project": {
585 + "type": "object",
586 + "nullable": true,
587 + "properties": {
588 + "auto_id": {
589 + "type": "number",
590 + "description": "Internal auto-incrementing ID for the project",
591 + "example": 12345
592 + },
593 + "id": {
594 + "type": "string",
595 + "description": "UUID identifier for the project",
596 + "example": "550e8400-e29b-41d4-a716-446655440000"
597 + },
598 + "org_id": {
599 + "type": "string",
600 + "description": "Organization UUID that this project belongs to",
601 + "example": "550e8400-e29b-41d4-a716-446655440001"
602 + },
603 + "name": {
604 + "type": "string",
605 + "description": "User-defined name for the project",
606 + "example": "Production API"
607 + },
608 + "email": {
609 + "type": "string",
610 + "description": "Email address used for project notifications",
611 + "example": "project-123@composio.dev"
612 + },
613 + "nano_id": {
614 + "type": "string",
615 + "format": "projectId",
616 + "description": "Short, URL-friendly unique identifier for the project",
617 + "example": "proj_abc123xyz456"
618 + },
619 + "created_at": {
620 + "type": "string",
621 + "description": "Date and time when the project was created",
622 + "example": "2023-05-16T14:30:00.000Z"
623 + },
624 + "updated_at": {
625 + "type": "string",
626 + "description": "Date and time when the project was last modified",
627 + "example": "2023-05-18T09:15:30.000Z"
628 + },
629 + "webhook_url": {
630 + "type": "string",
631 + "nullable": true,
632 + "description": "Endpoint URL for trigger webhook notifications",
633 + "example": "https://example.com/webhook"
634 + },
635 + "event_webhook_url": {
636 + "type": "string",
637 + "nullable": true,
638 + "description": "Endpoint URL for event webhook notifications",
639 + "example": "https://example.com/events"
640 + },
641 + "webhook_secret": {
642 + "type": "string",
643 + "nullable": true,
644 + "description": "Secret used to verify webhook signatures",
645 + "example": "whsec_a1b2c3d4e5f6g7h8i9j0"
646 + },
647 + "triggers_enabled": {
648 + "type": "boolean",
649 + "description": "Flag indicating if triggers are enabled for this project",
650 + "example": true
651 + },
652 + "last_subscribed_at": {
653 + "type": "string",
654 + "nullable": true,
655 + "description": "Date and time when the project last subscribed to updates",
656 + "example": "2023-05-17T10:00:00.000Z"
657 + },
658 + "deleted": {
659 + "type": "boolean",
660 + "description": "Flag indicating if the project has been deleted",
661 + "example": false
662 + },
663 + "is_new_webhook": {
664 + "type": "boolean",
665 + "description": "Deprecated: Please refer to webhook_version instead. True indicates if the webhook configuration is using the previous new format (V2). False indicates the oldest format (V1)",
666 + "example": true,
667 + "deprecated": true
668 + },
669 + "webhook_version": {
670 + "type": "string",
671 + "enum": [
672 + "V1",
673 + "V2",
674 + "V3"
675 + ],
676 + "description": "Version of the webhook configuration",
677 + "example": "V2"
678 + },
679 + "org": {
680 + "type": "object",
681 + "properties": {
682 + "id": {
683 + "type": "string",
684 + "format": "orgId",
685 + "description": "Short, URL-friendly unique identifier for the organization",
686 + "example": "org_abc123xyz456"
687 + },
688 + "name": {
689 + "type": "string",
690 + "description": "User-defined name for the organization",
691 + "example": "Acme Corp"
692 + },
693 + "plan": {
694 + "type": "string",
695 + "description": "Current subscription plan level",
696 + "example": "BUSINESS"
697 + }
698 + },
699 + "required": [
700 + "id",
701 + "name",
702 + "plan"
703 + ],
704 + "description": "Organization details"
705 + }
706 + },
707 + "required": [
708 + "auto_id",
709 + "id",
710 + "org_id",
711 + "name",
712 + "email",
713 + "nano_id",
714 + "created_at",
715 + "updated_at",
716 + "webhook_url",
717 + "event_webhook_url",
718 + "webhook_secret",
719 + "triggers_enabled",
720 + "last_subscribed_at",
721 + "deleted",
722 + "is_new_webhook",
723 + "webhook_version",
724 + "org"
725 + ],
726 + "description": "Details of the current active project (null if accessing with org-level credentials)"
727 + },
728 + "api_key": {
729 + "type": "object",
730 + "nullable": true,
731 + "properties": {
732 + "auto_id": {
733 + "type": "number",
734 + "description": "Internal auto-incrementing ID for the API key",
735 + "example": 7890
736 + },
737 + "id": {
738 + "type": "string",
739 + "description": "UUID identifier for the API key",
740 + "example": "550e8400-e29b-41d4-a716-446655440003"
741 + },
742 + "name": {
743 + "type": "string",
744 + "description": "User-defined name for the API key",
745 + "example": "Development Key"
746 + },
747 + "project_id": {
748 + "type": "string",
749 + "format": "projectId",
750 + "description": "Short, URL-friendly unique identifier for the associated project",
751 + "example": "proj_abc123xyz456"
752 + },
753 + "org_member_id": {
754 + "type": "string",
755 + "description": "UUID identifier for the organization member who owns this API key",
756 + "example": "550e8400-e29b-41d4-a716-446655440002"
757 + },
758 + "created_at": {
759 + "type": "string",
760 + "description": "Date and time when the API key was created",
761 + "example": "2023-05-01T10:00:00.000Z"
762 + },
763 + "updated_at": {
764 + "type": "string",
765 + "description": "Date and time when the API key was last modified",
766 + "example": "2023-05-01T10:00:00.000Z"
767 + },
768 + "deleted_at": {
769 + "type": "string",
770 + "nullable": true,
771 + "description": "Date and time when the API key was deleted (if applicable)"
772 + },
773 + "key": {
774 + "type": "string",
775 + "description": "The actual API key value (usually only shown once during creation)",
776 + "example": "sk_live_abc123xyz456"
777 + },
778 + "deleted": {
779 + "type": "boolean",
780 + "description": "Flag indicating if the API key has been deleted",
781 + "example": false
782 + }
783 + },
784 + "required": [
785 + "auto_id",
786 + "id",
787 + "name",
788 + "project_id",
789 + "org_member_id",
790 + "created_at",
791 + "updated_at",
792 + "deleted_at",
793 + "key",
794 + "deleted"
795 + ],
796 + "description": "Details of the API key used for authentication (null if using session auth)"
797 + },
798 + "org_member": {
799 + "type": "object",
800 + "properties": {
801 + "id": {
802 + "type": "string",
803 + "description": "UUID identifier for the organization member",
804 + "example": "550e8400-e29b-41d4-a716-446655440002"
805 + },
806 + "email": {
807 + "type": "string",
808 + "description": "Email address of the authenticated user",
809 + "example": "user@example.com"
810 + },
811 + "name": {
812 + "type": "string",
813 + "description": "Display name of the authenticated user",
814 + "example": "John Doe"
815 + },
816 + "role": {
817 + "type": "string",
818 + "description": "Access role of the authenticated user within the organization",
819 + "example": "admin"
820 + }
821 + },
822 + "required": [
823 + "id",
824 + "email",
825 + "name",
826 + "role"
827 + ],
828 + "description": "Information about the authenticated user",
829 + "example": {
830 + "id": "550e8400-e29b-41d4-a716-446655440002",
831 + "email": "user@example.com",
832 + "name": "John Doe",
833 + "role": "admin"
834 + }
835 + }
836 + },
837 + "required": [
838 + "project",
839 + "api_key",
840 + "org_member"
841 + ],
842 + "description": "Response containing user session information"
843 + }
844 + }
845 + }
846 + },
847 + "400": {
848 + "description": "Bad request. The request format may be invalid or missing required parameters.",
849 + "content": {
850 + "application/json": {
851 + "schema": {
852 + "$ref": "#/components/schemas/Error"
853 + }
854 + }
855 + }
856 + },
857 + "401": {
858 + "description": "Unauthorized. Authentication is required or the provided credentials are invalid or expired.",
859 + "content": {
860 + "application/json": {
861 + "schema": {
862 + "$ref": "#/components/schemas/Error"
863 + }
864 + }
865 + }
866 + },
867 + "403": {
868 + "description": "Forbidden. The authenticated user does not have permission to access this resource.",
869 + "content": {
870 + "application/json": {
871 + "schema": {
872 + "$ref": "#/components/schemas/Error"
873 + }
874 + }
875 + }
876 + },
877 + "404": {
878 + "description": "Not found. The requested project, organization, or member resource could not be found.",
879 + "content": {
880 + "application/json": {
881 + "schema": {
882 + "$ref": "#/components/schemas/Error"
883 + }
884 + }
885 + }
886 + },
887 + "500": {
888 + "description": "Internal server error. An unexpected error occurred while processing the request.",
889 + "content": {
890 + "application/json": {
891 + "schema": {
892 + "$ref": "#/components/schemas/Error"
893 + }
894 + }
895 + }
896 + }
897 + }
898 + }
899 + },
900 + "/api/v3/auth_configs": {
901 + "post": {
902 + "summary": "Create new authentication configuration",
903 + "tags": [
904 + "Auth Configs"
905 + ],
906 + "operationId": "postAuthConfigs",
907 + "security": [
908 + {
909 + "ApiKeyAuth": []
910 + },
911 + {
912 + "CookieAuth": []
913 + }
914 + ],
915 + "requestBody": {
916 + "content": {
917 + "application/json": {
918 + "schema": {
919 + "type": "object",
920 + "properties": {
921 + "toolkit": {
922 + "type": "object",
923 + "properties": {
924 + "slug": {
925 + "type": "string",
926 + "description": "Toolkit slug to create auth config for"
927 + }
928 + },
929 + "required": [
930 + "slug"
931 + ]
932 + },
933 + "auth_config": {
934 + "oneOf": [
935 + {
936 + "type": "object",
937 + "properties": {
938 + "type": {
939 + "type": "string",
940 + "enum": [
941 + "use_composio_managed_auth"
942 + ]
943 + },
944 + "name": {
945 + "type": "string",
946 + "description": "The name of the integration"
947 + },
948 + "credentials": {
949 + "type": "object",
950 + "properties": {
951 + "scopes": {
952 + "anyOf": [
953 + {
954 + "type": "string"
955 + },
956 + {
957 + "type": "array",
958 + "items": {
959 + "type": "string"
960 + }
961 + }
962 + ]
963 + },
964 + "user_scopes": {
965 + "anyOf": [
966 + {
967 + "type": "string"
968 + },
969 + {
970 + "type": "array",
971 + "items": {
972 + "type": "string"
973 + }
974 + }
975 + ]
976 + }
977 + },
978 + "default": {}
979 + },
980 + "tool_access_config": {
981 + "type": "object",
982 + "properties": {
983 + "tools_for_connected_account_creation": {
984 + "type": "array",
985 + "items": {
986 + "type": "string"
987 + },
988 + "default": [],
989 + "description": "Tools used to generate the minimum required scopes for the auth config (only valid for OAuth). If passed, this will update the scopes."
990 + }
991 + }
992 + },
993 + "restrict_to_following_tools": {
994 + "type": "array",
995 + "items": {
996 + "type": "string"
997 + },
998 + "default": [],
999 + "description": "Use tool_access_config instead. This field will be deprecated in the future.",
1000 + "deprecated": true
1001 + },
1002 + "shared_credentials": {
1003 + "type": "object",
1004 + "additionalProperties": {
1005 + "nullable": true
1006 + },
1007 + "description": "[EXPERIMENTAL] Shared credentials that will be inherited by all connected accounts using this auth config"
1008 + }
1009 + },
1010 + "required": [
1011 + "type"
1012 + ]
1013 + },
1014 + {
1015 + "type": "object",
1016 + "properties": {
1017 + "type": {
1018 + "type": "string",
1019 + "enum": [
1020 + "use_custom_auth"
1021 + ]
1022 + },
1023 + "name": {
1024 + "type": "string",
1025 + "description": "The name of the integration"
1026 + },
1027 + "authScheme": {
1028 + "type": "string",
1029 + "enum": [
1030 + "OAUTH2",
1031 + "OAUTH1",
1032 + "API_KEY",
1033 + "BASIC",
1034 + "BILLCOM_AUTH",
1035 + "BEARER_TOKEN",
1036 + "GOOGLE_SERVICE_ACCOUNT",
1037 + "NO_AUTH",
1038 + "BASIC_WITH_JWT",
1039 + "CALCOM_AUTH",
1040 + "SERVICE_ACCOUNT",
1041 + "SAML",
1042 + "DCR_OAUTH"
1043 + ]
1044 + },
1045 + "credentials": {
1046 + "type": "object",
1047 + "properties": {
1048 + "scopes": {
1049 + "anyOf": [
1050 + {
1051 + "type": "string"
1052 + },
1053 + {
1054 + "type": "array",
1055 + "items": {
1056 + "type": "string"
1057 + }
1058 + }
1059 + ]
1060 + },
1061 + "user_scopes": {
1062 + "anyOf": [
1063 + {
1064 + "type": "string"
1065 + },
1066 + {
1067 + "type": "array",
1068 + "items": {
1069 + "type": "string"
1070 + }
1071 + }
1072 + ]
1073 + }
1074 + },
1075 + "default": {}
1076 + },
1077 + "proxy_config": {
1078 + "type": "object",
1079 + "properties": {
1080 + "proxy_url": {
1081 + "type": "string",
1082 + "format": "uri",
1083 + "description": "The url of the auth proxy"
1084 + },
1085 + "proxy_auth_key": {
1086 + "type": "string",
1087 + "description": "The auth key for the auth proxy"
1088 + }
1089 + },
1090 + "required": [
1091 + "proxy_url"
1092 + ]
1093 + },
1094 + "restrict_to_following_tools": {
1095 + "type": "array",
1096 + "items": {
1097 + "type": "string"
1098 + },
1099 + "default": [],
1100 + "description": "Use tool_access_config instead. This field will be deprecated in the future.",
1101 + "deprecated": true
1102 + },
1103 + "tool_access_config": {
1104 + "type": "object",
1105 + "properties": {
1106 + "tools_for_connected_account_creation": {
1107 + "type": "array",
1108 + "items": {
1109 + "type": "string"
1110 + },
1111 + "default": [],
1112 + "description": "Tools used to generate the minimum required scopes for the auth config (only valid for OAuth). If passed, this will update the scopes."
1113 + }
1114 + }
1115 + },
1116 + "shared_credentials": {
1117 + "type": "object",
1118 + "additionalProperties": {
1119 + "nullable": true
1120 + },
1121 + "description": "[EXPERIMENTAL] Shared credentials that will be inherited by all connected accounts using this auth config"
1122 + }
1123 + },
1124 + "required": [
1125 + "type",
1126 + "authScheme"
1127 + ]
1128 + }
1129 + ],
1130 + "default": {
1131 + "type": "use_composio_managed_auth",
1132 + "credentials": {},
1133 + "restrict_to_following_tools": []
1134 + }
1135 + }
1136 + },
1137 + "required": [
1138 + "toolkit"
1139 + ]
1140 + }
1141 + }
1142 + }
1143 + },
1144 + "responses": {
1145 + "201": {
1146 + "description": "Successfully created auth config",
1147 + "content": {
1148 + "application/json": {
1149 + "schema": {
1150 + "type": "object",
1151 + "properties": {
1152 + "toolkit": {
1153 + "type": "object",
1154 + "properties": {
1155 + "slug": {
1156 + "type": "string",
1157 + "description": "The unique key of the toolkit"
1158 + }
1159 + },
1160 + "required": [
1161 + "slug"
1162 + ]
1163 + },
1164 + "auth_config": {
1165 + "type": "object",
1166 + "properties": {
1167 + "id": {
1168 + "type": "string",
1169 + "format": "authConfigId",
1170 + "description": "The auth config id of the toolkit (must be a valid auth config id)"
1171 + },
1172 + "auth_scheme": {
1173 + "type": "string",
1174 + "description": "The authentication mode of the toolkit"
1175 + },
1176 + "is_composio_managed": {
1177 + "type": "boolean",
1178 + "description": "Whether the auth config is managed by Composio"
1179 + },
1180 + "restrict_to_following_tools": {
1181 + "type": "array",
1182 + "items": {
1183 + "type": "string"
1184 + },
1185 + "default": [],
1186 + "description": "The tools that the user can use with the auth config"
1187 + }
1188 + },
1189 + "required": [
1190 + "id",
1191 + "auth_scheme",
1192 + "is_composio_managed"
1193 + ]
1194 + }
1195 + },
1196 + "required": [
1197 + "toolkit",
1198 + "auth_config"
1199 + ]
1200 + }
1201 + }
1202 + }
1203 + },
1204 + "400": {
1205 + "description": "Bad request",
1206 + "content": {
1207 + "application/json": {
1208 + "schema": {
1209 + "$ref": "#/components/schemas/Error"
1210 + }
1211 + }
1212 + }
1213 + },
1214 + "401": {
1215 + "description": "Unauthorized",
1216 + "content": {
1217 + "application/json": {
1218 + "schema": {
1219 + "$ref": "#/components/schemas/Error"
1220 + }
1221 + }
1222 + }
1223 + },
1224 + "404": {
1225 + "description": "Not found",
1226 + "content": {
1227 + "application/json": {
1228 + "schema": {
1229 + "$ref": "#/components/schemas/Error"
1230 + }
1231 + }
1232 + }
1233 + },
1234 + "500": {
1235 + "description": "Internal server error",
1236 + "content": {
1237 + "application/json": {
1238 + "schema": {
1239 + "$ref": "#/components/schemas/Error"
1240 + }
1241 + }
1242 + }
1243 + }
1244 + }
1245 + },
1246 + "get": {
1247 + "summary": "List authentication configurations with optional filters",
1248 + "tags": [
1249 + "Auth Configs"
1250 + ],
1251 + "operationId": "getAuthConfigs",
1252 + "security": [
1253 + {
1254 + "ApiKeyAuth": []
1255 + },
1256 + {
1257 + "CookieAuth": []
1258 + }
1259 + ],
1260 + "parameters": [
1261 + {
1262 + "schema": {
1263 + "anyOf": [
1264 + {
1265 + "type": "string"
1266 + },
1267 + {
1268 + "type": "boolean"
1269 + }
1270 + ],
1271 + "description": "Whether to filter by composio managed auth configs"
1272 + },
1273 + "required": false,
1274 + "description": "Whether to filter by composio managed auth configs",
1275 + "name": "is_composio_managed",
1276 + "in": "query"
1277 + },
1278 + {
1279 + "schema": {
1280 + "type": "string"
1281 + },
1282 + "required": false,
1283 + "description": "Comma-separated list of toolkit slugs to filter auth configs by",
1284 + "in": "query",
1285 + "name": "toolkit_slug"
1286 + },
1287 + {
1288 + "schema": {
1289 + "type": "string",
1290 + "description": "DEPRECATED: This parameter will be removed in a future version. Please use toolkit_slug instead.",
1291 + "deprecated": true
1292 + },
1293 + "required": false,
1294 + "description": "The app id to filter by",
1295 + "name": "deprecated_app_id",
1296 + "in": "query"
1297 + },
1298 + {
1299 + "schema": {
1300 + "type": "string",
1301 + "description": "DEPRECATED: This parameter will be removed in a future version.",
1302 + "deprecated": true
1303 + },
1304 + "required": false,
1305 + "name": "deprecated_status",
1306 + "in": "query"
1307 + },
1308 + {
1309 + "schema": {
1310 + "type": "boolean",
1311 + "nullable": true,
1312 + "default": false,
1313 + "description": "Show disabled auth configs"
1314 + },
1315 + "required": false,
1316 + "description": "Show disabled auth configs",
1317 + "name": "show_disabled",
1318 + "in": "query"
1319 + },
1320 + {
1321 + "schema": {
1322 + "type": "string",
1323 + "description": "Search auth configs by name"
1324 + },
1325 + "required": false,
1326 + "description": "Search auth configs by name",
1327 + "name": "search",
1328 + "in": "query"
1329 + },
1330 + {
1331 + "schema": {
1332 + "type": "number",
1333 + "nullable": true
1334 + },
1335 + "required": false,
1336 + "description": "Number of items per page, max allowed is 1000",
1337 + "name": "limit",
1338 + "in": "query"
1339 + },
1340 + {
1341 + "schema": {
1342 + "type": "string"
1343 + },
1344 + "required": false,
1345 + "description": "Cursor for pagination. The cursor is a base64 encoded string of the page and limit. The page is the page number and the limit is the number of items per page. The cursor is used to paginate through the items. The cursor is not required for the first page.",
1346 + "name": "cursor",
1347 + "in": "query"
1348 + }
1349 + ],
1350 + "responses": {
1351 + "200": {
1352 + "description": "Successfully fetched auth configs",
1353 + "content": {
1354 + "application/json": {
1355 + "schema": {
1356 + "type": "object",
1357 + "properties": {
1358 + "items": {
1359 + "type": "array",
1360 + "items": {
1361 + "type": "object",
1362 + "properties": {
1363 + "id": {
1364 + "type": "string",
1365 + "format": "authConfigId",
1366 + "description": "The unique ID of the authentication configuration"
1367 + },
1368 + "uuid": {
1369 + "type": "string",
1370 + "description": "The UUID of the authentication configuration (for backward compatibility)"
1371 + },
1372 + "type": {
1373 + "type": "string",
1374 + "enum": [
1375 + "default",
1376 + "custom"
1377 + ],
1378 + "description": "The type of the authentication configuration (custom or default)"
1379 + },
1380 + "toolkit": {
1381 + "type": "object",
1382 + "properties": {
1383 + "slug": {
1384 + "type": "string",
1385 + "description": "The unique identifier of the integration app"
1386 + },
1387 + "logo": {
1388 + "type": "string",
1389 + "description": "The URL to the integration app's logo image"
1390 + }
1391 + },
1392 + "required": [
1393 + "slug",
1394 + "logo"
1395 + ],
1396 + "description": "Information about the associated integration"
1397 + },
1398 + "name": {
1399 + "type": "string",
1400 + "description": "The display name of the authentication configuration"
1401 + },
1402 + "auth_scheme": {
1403 + "type": "string",
1404 + "enum": [
1405 + "OAUTH2",
1406 + "OAUTH1",
1407 + "API_KEY",
1408 + "BASIC",
1409 + "BILLCOM_AUTH",
1410 + "BEARER_TOKEN",
1411 + "GOOGLE_SERVICE_ACCOUNT",
1412 + "NO_AUTH",
1413 + "BASIC_WITH_JWT",
1414 + "CALCOM_AUTH",
1415 + "SERVICE_ACCOUNT",
1416 + "SAML",
1417 + "DCR_OAUTH"
1418 + ],
1419 + "description": "The authentication scheme used (e.g., OAuth2, API Key, etc.)"
1420 + },
1421 + "is_composio_managed": {
1422 + "type": "boolean",
1423 + "description": "Whether this authentication configuration is managed by Composio or the user"
1424 + },
1425 + "credentials": {
1426 + "type": "object",
1427 + "additionalProperties": {
1428 + "nullable": true
1429 + },
1430 + "description": "The authentication credentials (tokens, keys, etc.) - may be partially hidden for security"
1431 + },
1432 + "proxy_config": {
1433 + "type": "object",
1434 + "properties": {
1435 + "proxy_url": {
1436 + "type": "string",
1437 + "format": "uri",
1438 + "description": "The url of the auth proxy"
1439 + },
1440 + "proxy_auth_key": {
1441 + "type": "string",
1442 + "description": "The auth key for the auth proxy"
1443 + }
1444 + },
1445 + "required": [
1446 + "proxy_url"
1447 + ]
1448 + },
1449 + "status": {
1450 + "type": "string",
1451 + "enum": [
1452 + "ENABLED",
1453 + "DISABLED"
1454 + ],
1455 + "description": "Current status of the authentication configuration"
1456 + },
1457 + "created_by": {
1458 + "type": "string",
1459 + "description": "The identifier of the user who created the auth config"
1460 + },
1461 + "created_at": {
1462 + "type": "string",
1463 + "description": "ISO 8601 date-time when the auth config was created"
1464 + },
1465 + "last_updated_at": {
1466 + "type": "string",
1467 + "description": "ISO 8601 date-time when the auth config was last updated"
1468 + },
1469 + "no_of_connections": {
1470 + "type": "number",
1471 + "description": "The number of active connections using this auth config"
1472 + },
1473 + "expected_input_fields": {
1474 + "type": "array",
1475 + "items": {
1476 + "nullable": true
1477 + },
1478 + "description": "Fields expected during connection initialization"
1479 + },
1480 + "restrict_to_following_tools": {
1481 + "type": "array",
1482 + "items": {
1483 + "type": "string"
1484 + },
1485 + "description": "Use tool_access_config instead. This field will be deprecated in the future.",
1486 + "deprecated": true
1487 + },
1488 + "tool_access_config": {
1489 + "type": "object",
1490 + "properties": {
1491 + "tools_for_connected_account_creation": {
1492 + "type": "array",
1493 + "items": {
1494 + "type": "string"
1495 + },
1496 + "default": [],
1497 + "description": "Tools used to generate the minimum required scopes for the auth config (only valid for OAuth). If passed, this will update the scopes."
1498 + },
1499 + "tools_available_for_execution": {
1500 + "type": "array",
1501 + "items": {
1502 + "type": "string"
1503 + },
1504 + "default": [],
1505 + "description": "The actions that the user can perform on the auth config. If passed, this will update the actions that the user can perform on the auth config."
1506 + }
1507 + }
1508 + },
1509 + "shared_credentials": {
1510 + "type": "object",
1511 + "additionalProperties": {
1512 + "nullable": true
1513 + },
1514 + "description": "[EXPERIMENTAL] Shared credentials that will be inherited by all connected accounts using this auth config"
1515 + },
1516 + "deprecated_params": {
1517 + "type": "object",
1518 + "properties": {
1519 + "default_connector_id": {
1520 + "type": "string",
1521 + "nullable": true,
1522 + "description": "Deprecated: Default connector ID"
1523 + },
1524 + "member_uuid": {
1525 + "type": "string",
1526 + "description": "Deprecated: Member UUID"
1527 + },
1528 + "toolkit_id": {
1529 + "type": "string",
1530 + "description": "Deprecated: Toolkit ID"
1531 + },
1532 + "expected_input_fields": {
1533 + "type": "array",
1534 + "items": {
1535 + "type": "object",
1536 + "additionalProperties": {
1537 + "nullable": true
1538 + }
1539 + },
1540 + "description": "Deprecated: Fields expected during connection initialization"
1541 + }
1542 + },
1543 + "required": [
1544 + "default_connector_id"
1545 + ],
1546 + "description": "DEPRECATED: This parameter will be removed in a future version.",
1547 + "deprecated": true
1548 + }
1549 + },
1550 + "required": [
1551 + "id",
1552 + "uuid",
1553 + "type",
1554 + "toolkit",
1555 + "name",
1556 + "status",
1557 + "no_of_connections",
1558 + "tool_access_config"
1559 + ]
1560 + }
1561 + },
1562 + "next_cursor": {
1563 + "type": "string",
1564 + "nullable": true
1565 + },
1566 + "total_pages": {
1567 + "type": "number"
1568 + },
1569 + "current_page": {
1570 + "type": "number"
1571 + },
1572 + "total_items": {
1573 + "type": "number"
1574 + }
1575 + },
1576 + "required": [
1577 + "items",
1578 + "total_pages",
1579 + "current_page",
1580 + "total_items"
1581 + ]
1582 + }
1583 + }
1584 + }
1585 + },
1586 + "400": {
1587 + "description": "Bad request",
1588 + "content": {
1589 + "application/json": {
1590 + "schema": {
1591 + "$ref": "#/components/schemas/Error"
1592 + }
1593 + }
1594 + }
1595 + },
1596 + "401": {
1597 + "description": "Unauthorized",
1598 + "content": {
1599 + "application/json": {
1600 + "schema": {
1601 + "$ref": "#/components/schemas/Error"
1602 + }
1603 + }
1604 + }
1605 + },
1606 + "404": {
1607 + "description": "Not found",
1608 + "content": {
1609 + "application/json": {
1610 + "schema": {
1611 + "$ref": "#/components/schemas/Error"
1612 + }
1613 + }
1614 + }
1615 + },
1616 + "500": {
1617 + "description": "Internal server error",
1618 + "content": {
1619 + "application/json": {
1620 + "schema": {
1621 + "$ref": "#/components/schemas/Error"
1622 + }
1623 + }
1624 + }
1625 + }
1626 + }
1627 + }
1628 + },
1629 + "/api/v3/auth_configs/{nanoid}": {
1630 + "get": {
1631 + "summary": "Get single authentication configuration by ID",
1632 + "description": "Retrieves detailed information about a specific authentication configuration using its unique identifier.",
1633 + "tags": [
1634 + "Auth Configs"
1635 + ],
1636 + "operationId": "getAuthConfigsByNanoid",
1637 + "security": [
1638 + {
1639 + "ApiKeyAuth": []
1640 + },
1641 + {
1642 + "CookieAuth": []
1643 + }
1644 + ],
1645 + "parameters": [
1646 + {
1647 + "schema": {
1648 + "type": "string",
1649 + "format": "authConfigId",
1650 + "description": "The unique identifier of the authentication configuration to retrieve"
1651 + },
1652 + "required": true,
1653 + "description": "The unique identifier of the authentication configuration to retrieve",
1654 + "name": "nanoid",
1655 + "in": "path"
1656 + }
1657 + ],
1658 + "responses": {
1659 + "200": {
1660 + "description": "Successfully fetched auth config",
1661 + "content": {
1662 + "application/json": {
1663 + "schema": {
1664 + "type": "object",
1665 + "properties": {
1666 + "id": {
1667 + "type": "string",
1668 + "format": "authConfigId",
1669 + "description": "The unique ID of the authentication configuration"
1670 + },
1671 + "uuid": {
1672 + "type": "string",
1673 + "description": "The UUID of the authentication configuration (for backward compatibility)"
1674 + },
1675 + "type": {
1676 + "type": "string",
1677 + "enum": [
1678 + "default",
1679 + "custom"
1680 + ],
1681 + "description": "The type of the authentication configuration (custom or default)"
1682 + },
1683 + "toolkit": {
1684 + "type": "object",
1685 + "properties": {
1686 + "slug": {
1687 + "type": "string",
1688 + "description": "The unique identifier of the integration app"
1689 + },
1690 + "logo": {
1691 + "type": "string",
1692 + "description": "The URL to the integration app's logo image"
1693 + }
1694 + },
1695 + "required": [
1696 + "slug",
1697 + "logo"
1698 + ],
1699 + "description": "Information about the associated integration"
1700 + },
1701 + "name": {
1702 + "type": "string",
1703 + "description": "The display name of the authentication configuration"
1704 + },
1705 + "auth_scheme": {
1706 + "type": "string",
1707 + "enum": [
1708 + "OAUTH2",
1709 + "OAUTH1",
1710 + "API_KEY",
1711 + "BASIC",
1712 + "BILLCOM_AUTH",
1713 + "BEARER_TOKEN",
1714 + "GOOGLE_SERVICE_ACCOUNT",
1715 + "NO_AUTH",
1716 + "BASIC_WITH_JWT",
1717 + "CALCOM_AUTH",
1718 + "SERVICE_ACCOUNT",
1719 + "SAML",
1720 + "DCR_OAUTH"
1721 + ],
1722 + "description": "The authentication scheme used (e.g., OAuth2, API Key, etc.)"
1723 + },
1724 + "is_composio_managed": {
1725 + "type": "boolean",
1726 + "description": "Whether this authentication configuration is managed by Composio or the user"
1727 + },
1728 + "credentials": {
1729 + "type": "object",
1730 + "additionalProperties": {
1731 + "nullable": true
1732 + },
1733 + "description": "The authentication credentials (tokens, keys, etc.) - may be partially hidden for security"
1734 + },
1735 + "proxy_config": {
1736 + "type": "object",
1737 + "properties": {
1738 + "proxy_url": {
1739 + "type": "string",
1740 + "format": "uri",
1741 + "description": "The url of the auth proxy"
1742 + },
1743 + "proxy_auth_key": {
1744 + "type": "string",
1745 + "description": "The auth key for the auth proxy"
1746 + }
1747 + },
1748 + "required": [
1749 + "proxy_url"
1750 + ]
1751 + },
1752 + "status": {
1753 + "type": "string",
1754 + "enum": [
1755 + "ENABLED",
1756 + "DISABLED"
1757 + ],
1758 + "description": "Current status of the authentication configuration"
1759 + },
1760 + "created_by": {
1761 + "type": "string",
1762 + "description": "The identifier of the user who created the auth config"
1763 + },
1764 + "created_at": {
1765 + "type": "string",
1766 + "description": "ISO 8601 date-time when the auth config was created"
1767 + },
1768 + "last_updated_at": {
1769 + "type": "string",
1770 + "description": "ISO 8601 date-time when the auth config was last updated"
1771 + },
1772 + "no_of_connections": {
1773 + "type": "number",
1774 + "description": "The number of active connections using this auth config"
1775 + },
1776 + "expected_input_fields": {
1777 + "type": "array",
1778 + "items": {
1779 + "nullable": true
1780 + },
1781 + "description": "Fields expected during connection initialization"
1782 + },
1783 + "restrict_to_following_tools": {
1784 + "type": "array",
1785 + "items": {
1786 + "type": "string"
1787 + },
1788 + "description": "Use tool_access_config instead. This field will be deprecated in the future.",
1789 + "deprecated": true
1790 + },
1791 + "tool_access_config": {
1792 + "type": "object",
1793 + "properties": {
1794 + "tools_for_connected_account_creation": {
1795 + "type": "array",
1796 + "items": {
1797 + "type": "string"
1798 + },
1799 + "default": [],
1800 + "description": "Tools used to generate the minimum required scopes for the auth config (only valid for OAuth). If passed, this will update the scopes."
1801 + },
1802 + "tools_available_for_execution": {
1803 + "type": "array",
1804 + "items": {
1805 + "type": "string"
1806 + },
1807 + "default": [],
1808 + "description": "The actions that the user can perform on the auth config. If passed, this will update the actions that the user can perform on the auth config."
1809 + }
1810 + }
1811 + },
1812 + "shared_credentials": {
1813 + "type": "object",
1814 + "additionalProperties": {
1815 + "nullable": true
1816 + },
1817 + "description": "[EXPERIMENTAL] Shared credentials that will be inherited by all connected accounts using this auth config"
1818 + },
1819 + "deprecated_params": {
1820 + "type": "object",
1821 + "properties": {
1822 + "default_connector_id": {
1823 + "type": "string",
1824 + "nullable": true,
1825 + "description": "Deprecated: Default connector ID"
1826 + },
1827 + "member_uuid": {
1828 + "type": "string",
1829 + "description": "Deprecated: Member UUID"
1830 + },
1831 + "toolkit_id": {
1832 + "type": "string",
1833 + "description": "Deprecated: Toolkit ID"
1834 + },
1835 + "expected_input_fields": {
1836 + "type": "array",
1837 + "items": {
1838 + "type": "object",
1839 + "additionalProperties": {
1840 + "nullable": true
1841 + }
1842 + },
1843 + "description": "Deprecated: Fields expected during connection initialization"
1844 + }
1845 + },
1846 + "required": [
1847 + "default_connector_id"
1848 + ],
1849 + "description": "DEPRECATED: This parameter will be removed in a future version.",
1850 + "deprecated": true
1851 + }
1852 + },
1853 + "required": [
1854 + "id",
1855 + "uuid",
1856 + "type",
1857 + "toolkit",
1858 + "name",
1859 + "status",
1860 + "no_of_connections",
1861 + "tool_access_config"
1862 + ]
1863 + }
1864 + }
1865 + }
1866 + },
1867 + "400": {
1868 + "description": "Bad request - Invalid auth config ID format",
1869 + "content": {
1870 + "application/json": {
1871 + "schema": {
1872 + "$ref": "#/components/schemas/Error"
1873 + }
1874 + }
1875 + }
1876 + },
1877 + "401": {
1878 + "description": "Unauthorized - Authentication required",
1879 + "content": {
1880 + "application/json": {
1881 + "schema": {
1882 + "$ref": "#/components/schemas/Error"
1883 + }
1884 + }
1885 + }
1886 + },
1887 + "404": {
1888 + "description": "Not found - Auth configuration does not exist",
1889 + "content": {
1890 + "application/json": {
1891 + "schema": {
1892 + "$ref": "#/components/schemas/Error"
1893 + }
1894 + }
1895 + }
1896 + },
1897 + "500": {
1898 + "description": "Internal server error - Something went wrong on the server",
1899 + "content": {
1900 + "application/json": {
1901 + "schema": {
1902 + "$ref": "#/components/schemas/Error"
1903 + }
1904 + }
1905 + }
1906 + }
1907 + }
1908 + },
1909 + "patch": {
1910 + "summary": "Update an authentication configuration",
1911 + "description": "Modifies an existing authentication configuration with new credentials or other settings. Only specified fields will be updated.",
1912 + "tags": [
1913 + "Auth Configs"
1914 + ],
1915 + "operationId": "patchAuthConfigsByNanoid",
1916 + "security": [
1917 + {
1918 + "ApiKeyAuth": []
1919 + },
1920 + {
1921 + "CookieAuth": []
1922 + }
1923 + ],
1924 + "parameters": [
1925 + {
1926 + "schema": {
1927 + "type": "string",
1928 + "format": "authConfigId",
1929 + "description": "The unique identifier of the authentication configuration to update"
1930 + },
1931 + "required": true,
1932 + "description": "The unique identifier of the authentication configuration to update",
1933 + "name": "nanoid",
1934 + "in": "path"
1935 + }
1936 + ],
1937 + "requestBody": {
1938 + "content": {
1939 + "application/json": {
1940 + "schema": {
1941 + "oneOf": [
1942 + {
1943 + "type": "object",
1944 + "properties": {
1945 + "type": {
1946 + "type": "string",
1947 + "enum": [
1948 + "custom"
1949 + ]
1950 + },
1951 + "credentials": {
1952 + "type": "object",
1953 + "properties": {
1954 + "scopes": {
1955 + "anyOf": [
1956 + {
1957 + "type": "string"
1958 + },
1959 + {
1960 + "type": "array",
1961 + "items": {
1962 + "type": "string"
1963 + }
1964 + }
1965 + ]
1966 + },
1967 + "user_scopes": {
1968 + "anyOf": [
1969 + {
1970 + "type": "string"
1971 + },
1972 + {
1973 + "type": "array",
1974 + "items": {
1975 + "type": "string"
1976 + }
1977 + }
1978 + ]
1979 + }
1980 + }
1981 + },
1982 + "proxy_config": {
1983 + "type": "object",
1984 + "properties": {
1985 + "proxy_url": {
1986 + "type": "string",
1987 + "format": "uri",
1988 + "description": "The url of the auth proxy"
1989 + },
1990 + "proxy_auth_key": {
1991 + "type": "string",
1992 + "description": "The auth key for the auth proxy"
1993 + }
1994 + },
1995 + "required": [
1996 + "proxy_url"
1997 + ]
1998 + },
1999 + "restrict_to_following_tools": {
2000 + "type": "array",
2001 + "items": {
2002 + "type": "string"
2003 + },
2004 + "default": [],
2005 + "description": "Use tool_access_config instead. This field will be deprecated in the future.",
2006 + "deprecated": true
2007 + },
2008 + "tool_access_config": {
2009 + "type": "object",
2010 + "properties": {
2011 + "tools_for_connected_account_creation": {
2012 + "type": "array",
2013 + "items": {
2014 + "type": "string"
2015 + },
2016 + "default": [],
2017 + "description": "Tools used to generate the minimum required scopes for the auth config (only valid for OAuth). If passed, this will update the scopes."
2018 + },
2019 + "tools_available_for_execution": {
2020 + "type": "array",
2021 + "items": {
2022 + "type": "string"
2023 + },
2024 + "default": [],
2025 + "description": "The actions that the user can perform on the auth config. If passed, this will update the actions that the user can perform on the auth config."
2026 + }
2027 + }
2028 + },
2029 + "shared_credentials": {
2030 + "type": "object",
2031 + "additionalProperties": {
2032 + "nullable": true
2033 + },
2034 + "description": "Shared credentials that will be inherited by connected accounts. For eg: this can be used to share the API key for a tool with all connected accounts using this auth config."
2035 + }
2036 + },
2037 + "required": [
2038 + "type",
2039 + "credentials"
2040 + ]
2041 + },
2042 + {
2043 + "type": "object",
2044 + "properties": {
2045 + "type": {
2046 + "type": "string",
2047 + "enum": [
2048 + "default"
2049 + ]
2050 + },
2051 + "scopes": {
2052 + "anyOf": [
2053 + {
2054 + "type": "string"
2055 + },
2056 + {
2057 + "type": "array",
2058 + "items": {
2059 + "type": "string"
2060 + }
2061 + }
2062 + ]
2063 + },
2064 + "restrict_to_following_tools": {
2065 + "type": "array",
2066 + "items": {
2067 + "type": "string"
2068 + },
2069 + "default": [],
2070 + "description": "Use tool_access_config instead. This field will be deprecated in the future.",
2071 + "deprecated": true
2072 + },
2073 + "tool_access_config": {
2074 + "type": "object",
2075 + "properties": {
2076 + "tools_for_connected_account_creation": {
2077 + "type": "array",
2078 + "items": {
2079 + "type": "string"
2080 + },
2081 + "default": [],
2082 + "description": "Tools used to generate the minimum required scopes for the auth config (only valid for OAuth). If passed, this will update the scopes."
2083 + },
2084 + "tools_available_for_execution": {
2085 + "type": "array",
2086 + "items": {
2087 + "type": "string"
2088 + },
2089 + "default": [],
2090 + "description": "The actions that the user can perform on the auth config. If passed, this will update the actions that the user can perform on the auth config."
2091 + }
2092 + }
2093 + },
2094 + "shared_credentials": {
2095 + "type": "object",
2096 + "additionalProperties": {
2097 + "nullable": true
2098 + },
2099 + "description": "Shared credentials that will be inherited by connected accounts. For eg: this can be used to share the API key for a tool with all connected accounts using this auth config."
2100 + }
2101 + },
2102 + "required": [
2103 + "type"
2104 + ]
2105 + }
2106 + ]
2107 + },
2108 + "examples": {
2109 + "standardUpdate": {
2110 + "summary": "Standard credential update",
2111 + "value": {
2112 + "auth_config": {
2113 + "credentials": {
2114 + "api_key": "YOUR_NEW_API_KEY",
2115 + "client_secret": "YOUR_NEW_CLIENT_SECRET"
2116 + },
2117 + "restrict_to_following_tools": [
2118 + "tool1",
2119 + "tool2"
2120 + ]
2121 + }
2122 + }
2123 + }
2124 + }
2125 + }
2126 + }
2127 + },
2128 + "responses": {
2129 + "200": {
2130 + "description": "Successfully updated auth config",
2131 + "content": {
2132 + "application/json": {
2133 + "schema": {
2134 + "type": "object",
2135 + "properties": {}
2136 + }
2137 + }
2138 + }
2139 + },
2140 + "400": {
2141 + "description": "Bad request - Invalid input or credentials format",
2142 + "content": {
2143 + "application/json": {
2144 + "schema": {
2145 + "$ref": "#/components/schemas/Error"
2146 + }
2147 + }
2148 + }
2149 + },
2150 + "401": {
2151 + "description": "Unauthorized - Authentication required",
2152 + "content": {
2153 + "application/json": {
2154 + "schema": {
2155 + "$ref": "#/components/schemas/Error"
2156 + }
2157 + }
2158 + }
2159 + },
2160 + "404": {
2161 + "description": "Not found - Auth configuration does not exist",
2162 + "content": {
2163 + "application/json": {
2164 + "schema": {
2165 + "$ref": "#/components/schemas/Error"
2166 + }
2167 + }
2168 + }
2169 + },
2170 + "500": {
2171 + "description": "Internal server error - Something went wrong on the server",
2172 + "content": {
2173 + "application/json": {
2174 + "schema": {
2175 + "$ref": "#/components/schemas/Error"
2176 + }
2177 + }
2178 + }
2179 + }
2180 + }
2181 + },
2182 + "delete": {
2183 + "summary": "Delete an authentication configuration",
2184 + "description": "Soft-deletes an authentication configuration by marking it as deleted in the database. This operation cannot be undone.",
2185 + "tags": [
2186 + "Auth Configs"
2187 + ],
2188 + "operationId": "deleteAuthConfigsByNanoid",
2189 + "security": [
2190 + {
2191 + "ApiKeyAuth": []
2192 + },
2193 + {
2194 + "CookieAuth": []
2195 + }
2196 + ],
2197 + "parameters": [
2198 + {
2199 + "schema": {
2200 + "type": "string",
2201 + "format": "authConfigId",
2202 + "description": "The unique identifier of the authentication configuration to delete"
2203 + },
2204 + "required": true,
2205 + "description": "The unique identifier of the authentication configuration to delete",
2206 + "name": "nanoid",
2207 + "in": "path"
2208 + }
2209 + ],
2210 + "responses": {
2211 + "200": {
2212 + "description": "Successfully deleted auth config",
2213 + "content": {
2214 + "application/json": {
2215 + "schema": {
2216 + "type": "object",
2217 + "properties": {}
2218 + }
2219 + }
2220 + }
2221 + },
2222 + "400": {
2223 + "description": "Bad request - Invalid auth config ID format",
2224 + "content": {
2225 + "application/json": {
2226 + "schema": {
2227 + "$ref": "#/components/schemas/Error"
2228 + }
2229 + }
2230 + }
2231 + },
2232 + "401": {
2233 + "description": "Unauthorized - Authentication required",
2234 + "content": {
2235 + "application/json": {
2236 + "schema": {
2237 + "$ref": "#/components/schemas/Error"
2238 + }
2239 + }
2240 + }
2241 + },
2242 + "404": {
2243 + "description": "Auth config not found - The specified configuration does not exist or was already deleted",
2244 + "content": {
2245 + "application/json": {
2246 + "schema": {
2247 + "type": "object",
2248 + "properties": {}
2249 + }
2250 + }
2251 + }
2252 + },
2253 + "500": {
2254 + "description": "Internal server error - Something went wrong on the server",
2255 + "content": {
2256 + "application/json": {
2257 + "schema": {
2258 + "$ref": "#/components/schemas/Error"
2259 + }
2260 + }
2261 + }
2262 + }
2263 + }
2264 + }
2265 + },
2266 + "/api/v3/auth_configs/{nanoid}/{status}": {
2267 + "patch": {
2268 + "summary": "Enable or disable an authentication configuration",
2269 + "description": "Updates the status of an authentication configuration to either enabled or disabled. Disabled configurations cannot be used for new connections.",
2270 + "tags": [
2271 + "Auth Configs"
2272 + ],
2273 + "operationId": "patchAuthConfigsByNanoidByStatus",
2274 + "security": [
2275 + {
2276 + "ApiKeyAuth": []
2277 + },
2278 + {
2279 + "CookieAuth": []
2280 + }
2281 + ],
2282 + "parameters": [
2283 + {
2284 + "schema": {
2285 + "type": "string",
2286 + "format": "authConfigId",
2287 + "description": "The unique identifier of the authentication configuration to update"
2288 + },
2289 + "required": true,
2290 + "description": "The unique identifier of the authentication configuration to update",
2291 + "name": "nanoid",
2292 + "in": "path"
2293 + },
2294 + {
2295 + "schema": {
2296 + "type": "string",
2297 + "enum": [
2298 + "ENABLED",
2299 + "DISABLED"
2300 + ],
2301 + "description": "The new status to set for the auth configuration"
2302 + },
2303 + "required": true,
2304 + "description": "The new status to set for the auth configuration",
2305 + "name": "status",
2306 + "in": "path"
2307 + }
2308 + ],
2309 + "responses": {
2310 + "200": {
2311 + "description": "Successfully updated auth config status",
2312 + "content": {
2313 + "application/json": {
2314 + "schema": {
2315 + "type": "object",
2316 + "properties": {}
2317 + }
2318 + }
2319 + }
2320 + },
2321 + "400": {
2322 + "description": "Bad request - Invalid auth config ID or status value",
2323 + "content": {
2324 + "application/json": {
2325 + "schema": {
2326 + "$ref": "#/components/schemas/Error"
2327 + }
2328 + }
2329 + }
2330 + },
2331 + "401": {
2332 + "description": "Unauthorized - Authentication required",
2333 + "content": {
2334 + "application/json": {
2335 + "schema": {
2336 + "$ref": "#/components/schemas/Error"
2337 + }
2338 + }
2339 + }
2340 + },
2341 + "404": {
2342 + "description": "Not found - Auth configuration does not exist",
2343 + "content": {
2344 + "application/json": {
2345 + "schema": {
2346 + "$ref": "#/components/schemas/Error"
2347 + }
2348 + }
2349 + }
2350 + },
2351 + "500": {
2352 + "description": "Internal server error - Something went wrong on the server",
2353 + "content": {
2354 + "application/json": {
2355 + "schema": {
2356 + "$ref": "#/components/schemas/Error"
2357 + }
2358 + }
2359 + }
2360 + }
2361 + }
2362 + }
2363 + },
2364 + "/api/v3/connected_accounts": {
2365 + "get": {
2366 + "summary": "List connected accounts with optional filters",
2367 + "tags": [
2368 + "Connected Accounts"
2369 + ],
2370 + "operationId": "getConnectedAccounts",
2371 + "security": [
2372 + {
2373 + "ApiKeyAuth": []
2374 + },
2375 + {
2376 + "CookieAuth": []
2377 + }
2378 + ],
2379 + "parameters": [
2380 + {
2381 + "schema": {
2382 + "type": "array",
2383 + "nullable": true,
2384 + "items": {
2385 + "type": "string"
2386 + },
2387 + "description": "The toolkit slugs of the connected accounts"
2388 + },
2389 + "required": false,
2390 + "description": "The toolkit slugs of the connected accounts",
2391 + "name": "toolkit_slugs",
2392 + "in": "query"
2393 + },
2394 + {
2395 + "schema": {
2396 + "type": "array",
2397 + "nullable": true,
2398 + "items": {
2399 + "type": "string",
2400 + "enum": [
2401 + "INITIALIZING",
2402 + "INITIATED",
2403 + "ACTIVE",
2404 + "FAILED",
2405 + "EXPIRED",
2406 + "INACTIVE"
2407 + ]
2408 + },
2409 + "description": "The status of the connected account"
2410 + },
2411 + "required": false,
2412 + "description": "The status of the connected account",
2413 + "name": "statuses",
2414 + "in": "query"
2415 + },
2416 + {
2417 + "schema": {
2418 + "type": "string",
2419 + "nullable": true,
2420 + "description": "The cursor to paginate through the connected accounts"
2421 + },
2422 + "required": false,
2423 + "description": "The cursor to paginate through the connected accounts",
2424 + "name": "cursor",
2425 + "in": "query"
2426 + },
2427 + {
2428 + "schema": {
2429 + "type": "number",
2430 + "nullable": true,
2431 + "description": "The limit of the connected accounts to return"
2432 + },
2433 + "required": false,
2434 + "description": "The limit of the connected accounts to return",
2435 + "name": "limit",
2436 + "in": "query"
2437 + },
2438 + {
2439 + "schema": {
2440 + "type": "array",
2441 + "nullable": true,
2442 + "items": {
2443 + "type": "string"
2444 + },
2445 + "description": "The user ids of the connected accounts"
2446 + },
2447 + "required": false,
2448 + "description": "The user ids of the connected accounts",
2449 + "name": "user_ids",
2450 + "in": "query"
2451 + },
2452 + {
2453 + "schema": {
2454 + "type": "array",
2455 + "nullable": true,
2456 + "items": {
2457 + "type": "string",
2458 + "format": "authConfigId"
2459 + },
2460 + "description": "The auth config ids of the connected accounts"
2461 + },
2462 + "required": false,
2463 + "description": "The auth config ids of the connected accounts",
2464 + "name": "auth_config_ids",
2465 + "in": "query"
2466 + },
2467 + {
2468 + "schema": {
2469 + "type": "array",
2470 + "nullable": true,
2471 + "items": {
2472 + "type": "string",
2473 + "format": "connectedAccountId"
2474 + },
2475 + "description": "The connected account ids to filter by"
2476 + },
2477 + "required": false,
2478 + "description": "The connected account ids to filter by",
2479 + "name": "connected_account_ids",
2480 + "in": "query"
2481 + },
2482 + {
2483 + "schema": {
2484 + "type": "string",
2485 + "enum": [
2486 + "created_at",
2487 + "updated_at"
2488 + ],
2489 + "default": "created_at",
2490 + "description": "The order by of the connected accounts"
2491 + },
2492 + "required": false,
2493 + "description": "The order by of the connected accounts",
2494 + "name": "order_by",
2495 + "in": "query"
2496 + },
2497 + {
2498 + "schema": {
2499 + "type": "string",
2500 + "enum": [
2501 + "asc",
2502 + "desc"
2503 + ],
2504 + "default": "desc",
2505 + "description": "The order direction of the connected accounts"
2506 + },
2507 + "required": false,
2508 + "description": "The order direction of the connected accounts",
2509 + "name": "order_direction",
2510 + "in": "query"
2511 + }
2512 + ],
2513 + "responses": {
2514 + "200": {
2515 + "description": "Successfully retrieved connected accounts",
2516 + "content": {
2517 + "application/json": {
2518 + "schema": {
2519 + "type": "object",
2520 + "properties": {
2521 + "items": {
2522 + "type": "array",
2523 + "items": {
2524 + "type": "object",
2525 + "properties": {
2526 + "toolkit": {
2527 + "type": "object",
2528 + "properties": {
2529 + "slug": {
2530 + "type": "string",
2531 + "description": "The slug of the toolkit"
2532 + }
2533 + },
2534 + "required": [
2535 + "slug"
2536 + ]
2537 + },
2538 + "auth_config": {
2539 + "type": "object",
2540 + "properties": {
2541 + "id": {
2542 + "type": "string",
2543 + "format": "authConfigId",
2544 + "description": "The id of the auth config"
2545 + },
2546 + "auth_scheme": {
2547 + "type": "string",
2548 + "enum": [
2549 + "OAUTH2",
2550 + "OAUTH1",
2551 + "API_KEY",
2552 + "BASIC",
2553 + "BILLCOM_AUTH",
2554 + "BEARER_TOKEN",
2555 + "GOOGLE_SERVICE_ACCOUNT",
2556 + "NO_AUTH",
2557 + "BASIC_WITH_JWT",
2558 + "CALCOM_AUTH",
2559 + "SERVICE_ACCOUNT",
2560 + "SAML",
2561 + "DCR_OAUTH"
2562 + ],
2563 + "description": "the authScheme is part of the connection state use it there",
2564 + "deprecated": true
2565 + },
2566 + "is_composio_managed": {
2567 + "type": "boolean",
2568 + "description": "Whether the auth config is managed by Composio"
2569 + },
2570 + "is_disabled": {
2571 + "type": "boolean",
2572 + "description": "Whether the auth config is disabled"
2573 + },
2574 + "deprecated": {
2575 + "type": "object",
2576 + "properties": {
2577 + "uuid": {
2578 + "type": "string",
2579 + "format": "uuid",
2580 + "description": "The uuid of the auth config"
2581 + }
2582 + },
2583 + "required": [
2584 + "uuid"
2585 + ],
2586 + "deprecated": true
2587 + }
2588 + },
2589 + "required": [
2590 + "id",
2591 + "auth_scheme",
2592 + "is_composio_managed",
2593 + "is_disabled"
2594 + ]
2595 + },
2596 + "id": {
2597 + "type": "string",
2598 + "format": "connectedAccountId",
2599 + "description": "The id of the connection"
2600 + },
2601 + "user_id": {
2602 + "type": "string",
2603 + "description": "This is deprecated, we will not be providing userId from this api anymore, you will only be able to read via userId not get it back",
2604 + "deprecated": true
2605 + },
2606 + "status": {
2607 + "type": "string",
2608 + "enum": [
2609 + "INITIALIZING",
2610 + "INITIATED",
2611 + "ACTIVE",
2612 + "FAILED",
2613 + "EXPIRED",
2614 + "INACTIVE"
2615 + ],
2616 + "description": "The status of the connection"
2617 + },
2618 + "created_at": {
2619 + "type": "string",
2620 + "description": "The created at of the connection"
2621 + },
2622 + "updated_at": {
2623 + "type": "string",
2624 + "description": "The updated at of the connection"
2625 + },
2626 + "state": {
2627 + "oneOf": [
2628 + {
2629 + "type": "object",
2630 + "properties": {
2631 + "authScheme": {
2632 + "type": "string",
2633 + "enum": [
2634 + "OAUTH1"
2635 + ]
2636 + },
2637 + "val": {
2638 + "oneOf": [
2639 + {
2640 + "type": "object",
2641 + "properties": {
2642 + "subdomain": {
2643 + "type": "string"
2644 + },
2645 + "your-domain": {
2646 + "type": "string"
2647 + },
2648 + "region": {
2649 + "type": "string"
2650 + },
2651 + "shop": {
2652 + "type": "string"
2653 + },
2654 + "account_url": {
2655 + "type": "string"
2656 + },
2657 + "COMPANYDOMAIN": {
2658 + "type": "string"
2659 + },
2660 + "extension": {
2661 + "type": "string"
2662 + },
2663 + "form_api_base_url": {
2664 + "type": "string"
2665 + },
2666 + "instanceEndpoint": {
2667 + "type": "string"
2668 + },
2669 + "api_url": {
2670 + "type": "string"
2671 + },
2672 + "borneo_dashboard_url": {
2673 + "type": "string"
2674 + },
2675 + "proxy_username": {
2676 + "type": "string"
2677 + },
2678 + "proxy_password": {
2679 + "type": "string"
2680 + },
2681 + "domain": {
2682 + "type": "string"
2683 + },
2684 + "version": {
2685 + "type": "string"
2686 + },
2687 + "dc": {
2688 + "type": "string"
2689 + },
2690 + "site_name": {
2691 + "type": "string"
2692 + },
2693 + "instanceName": {
2694 + "type": "string"
2695 + },
2696 + "account_id": {
2697 + "type": "string"
2698 + },
2699 + "your_server": {
2700 + "type": "string"
2701 + },
2702 + "server_location": {
2703 + "type": "string"
2704 + },
2705 + "base_url": {
2706 + "type": "string"
2707 + },
2708 + "status": {
2709 + "type": "string",
2710 + "enum": [
2711 + "INITIALIZING"
2712 + ]
2713 + }
2714 + },
2715 + "required": [
2716 + "status"
2717 + ],
2718 + "additionalProperties": {
2719 + "nullable": true
2720 + }
2721 + },
2722 + {
2723 + "type": "object",
2724 + "properties": {
2725 + "subdomain": {
2726 + "type": "string"
2727 + },
2728 + "your-domain": {
2729 + "type": "string"
2730 + },
2731 + "region": {
2732 + "type": "string"
2733 + },
2734 + "shop": {
2735 + "type": "string"
2736 + },
2737 + "account_url": {
2738 + "type": "string"
2739 + },
2740 + "COMPANYDOMAIN": {
2741 + "type": "string"
2742 + },
2743 + "extension": {
2744 + "type": "string"
2745 + },
2746 + "form_api_base_url": {
2747 + "type": "string"
2748 + },
2749 + "instanceEndpoint": {
2750 + "type": "string"
2751 + },
2752 + "api_url": {
2753 + "type": "string"
2754 + },
2755 + "borneo_dashboard_url": {
2756 + "type": "string"
2757 + },
2758 + "proxy_username": {
2759 + "type": "string"
2760 + },
2761 + "proxy_password": {
2762 + "type": "string"
2763 + },
2764 + "domain": {
2765 + "type": "string"
2766 + },
2767 + "version": {
2768 + "type": "string"
2769 + },
2770 + "dc": {
2771 + "type": "string"
2772 + },
2773 + "site_name": {
2774 + "type": "string"
2775 + },
2776 + "instanceName": {
2777 + "type": "string"
2778 + },
2779 + "account_id": {
2780 + "type": "string"
2781 + },
2782 + "your_server": {
2783 + "type": "string"
2784 + },
2785 + "server_location": {
2786 + "type": "string"
2787 + },
2788 + "base_url": {
2789 + "type": "string"
2790 + },
2791 + "status": {
2792 + "type": "string",
2793 + "enum": [
2794 + "INITIATED"
2795 + ]
2796 + },
2797 + "oauth_token": {
2798 + "type": "string"
2799 + },
2800 + "authUri": {
2801 + "type": "string"
2802 + },
2803 + "oauth_token_secret": {
2804 + "type": "string"
2805 + },
2806 + "redirectUrl": {
2807 + "type": "string"
2808 + },
2809 + "callbackUrl": {
2810 + "type": "string"
2811 + }
2812 + },
2813 + "required": [
2814 + "status",
2815 + "oauth_token",
2816 + "authUri",
2817 + "oauth_token_secret",
2818 + "redirectUrl"
2819 + ],
2820 + "additionalProperties": {
2821 + "nullable": true
2822 + }
2823 + },
2824 + {
2825 + "type": "object",
2826 + "properties": {
2827 + "subdomain": {
2828 + "type": "string"
2829 + },
2830 + "your-domain": {
2831 + "type": "string"
2832 + },
2833 + "region": {
2834 + "type": "string"
2835 + },
2836 + "shop": {
2837 + "type": "string"
2838 + },
2839 + "account_url": {
2840 + "type": "string"
2841 + },
2842 + "COMPANYDOMAIN": {
2843 + "type": "string"
2844 + },
2845 + "extension": {
2846 + "type": "string"
2847 + },
2848 + "form_api_base_url": {
2849 + "type": "string"
2850 + },
2851 + "instanceEndpoint": {
2852 + "type": "string"
2853 + },
2854 + "api_url": {
2855 + "type": "string"
2856 + },
2857 + "borneo_dashboard_url": {
2858 + "type": "string"
2859 + },
2860 + "proxy_username": {
2861 + "type": "string"
2862 + },
2863 + "proxy_password": {
2864 + "type": "string"
2865 + },
2866 + "domain": {
2867 + "type": "string"
2868 + },
2869 + "version": {
2870 + "type": "string"
2871 + },
2872 + "dc": {
2873 + "type": "string"
2874 + },
2875 + "site_name": {
2876 + "type": "string"
2877 + },
2878 + "instanceName": {
2879 + "type": "string"
2880 + },
2881 + "account_id": {
2882 + "type": "string"
2883 + },
2884 + "your_server": {
2885 + "type": "string"
2886 + },
2887 + "server_location": {
2888 + "type": "string"
2889 + },
2890 + "base_url": {
2891 + "type": "string"
2892 + },
2893 + "status": {
2894 + "type": "string",
2895 + "enum": [
2896 + "ACTIVE"
2897 + ]
2898 + },
2899 + "oauth_token": {
2900 + "type": "string"
2901 + },
2902 + "oauth_token_secret": {
2903 + "type": "string"
2904 + },
2905 + "oauth_verifier": {
2906 + "type": "string"
2907 + },
2908 + "consumer_key": {
2909 + "type": "string"
2910 + },
2911 + "redirectUrl": {
2912 + "type": "string"
2913 + },
2914 + "callback_url": {
2915 + "type": "string"
2916 + }
2917 + },
2918 + "required": [
2919 + "status",
2920 + "oauth_token",
2921 + "oauth_token_secret"
2922 + ],
2923 + "additionalProperties": {
2924 + "nullable": true
2925 + }
2926 + },
2927 + {
2928 + "type": "object",
2929 + "properties": {
2930 + "subdomain": {
2931 + "type": "string"
2932 + },
2933 + "your-domain": {
2934 + "type": "string"
2935 + },
2936 + "region": {
2937 + "type": "string"
2938 + },
2939 + "shop": {
2940 + "type": "string"
2941 + },
2942 + "account_url": {
2943 + "type": "string"
2944 + },
2945 + "COMPANYDOMAIN": {
2946 + "type": "string"
2947 + },
2948 + "extension": {
2949 + "type": "string"
2950 + },
2951 + "form_api_base_url": {
2952 + "type": "string"
2953 + },
2954 + "instanceEndpoint": {
2955 + "type": "string"
2956 + },
2957 + "api_url": {
2958 + "type": "string"
2959 + },
2960 + "borneo_dashboard_url": {
2961 + "type": "string"
2962 + },
2963 + "proxy_username": {
2964 + "type": "string"
2965 + },
2966 + "proxy_password": {
2967 + "type": "string"
2968 + },
2969 + "domain": {
2970 + "type": "string"
2971 + },
2972 + "version": {
2973 + "type": "string"
2974 + },
2975 + "dc": {
2976 + "type": "string"
2977 + },
2978 + "site_name": {
2979 + "type": "string"
2980 + },
2981 + "instanceName": {
2982 + "type": "string"
2983 + },
2984 + "account_id": {
2985 + "type": "string"
2986 + },
2987 + "your_server": {
2988 + "type": "string"
2989 + },
2990 + "server_location": {
2991 + "type": "string"
2992 + },
2993 + "base_url": {
2994 + "type": "string"
2995 + },
2996 + "status": {
2997 + "type": "string",
2998 + "enum": [
2999 + "FAILED"
3000 + ]
3001 + },
3002 + "error": {
3003 + "type": "string"
3004 + },
3005 + "error_description": {
3006 + "type": "string"
3007 + }
3008 + },
3009 + "required": [
3010 + "status"
3011 + ],
3012 + "additionalProperties": {
3013 + "nullable": true
3014 + }
3015 + },
3016 + {
3017 + "type": "object",
3018 + "properties": {
3019 + "subdomain": {
3020 + "type": "string"
3021 + },
3022 + "your-domain": {
3023 + "type": "string"
3024 + },
3025 + "region": {
3026 + "type": "string"
3027 + },
3028 + "shop": {
3029 + "type": "string"
3030 + },
3031 + "account_url": {
3032 + "type": "string"
3033 + },
3034 + "COMPANYDOMAIN": {
3035 + "type": "string"
3036 + },
3037 + "extension": {
3038 + "type": "string"
3039 + },
3040 + "form_api_base_url": {
3041 + "type": "string"
3042 + },
3043 + "instanceEndpoint": {
3044 + "type": "string"
3045 + },
3046 + "api_url": {
3047 + "type": "string"
3048 + },
3049 + "borneo_dashboard_url": {
3050 + "type": "string"
3051 + },
3052 + "proxy_username": {
3053 + "type": "string"
3054 + },
3055 + "proxy_password": {
3056 + "type": "string"
3057 + },
3058 + "domain": {
3059 + "type": "string"
3060 + },
3061 + "version": {
3062 + "type": "string"
3063 + },
3064 + "dc": {
3065 + "type": "string"
3066 + },
3067 + "site_name": {
3068 + "type": "string"
3069 + },
3070 + "instanceName": {
3071 + "type": "string"
3072 + },
3073 + "account_id": {
3074 + "type": "string"
3075 + },
3076 + "your_server": {
3077 + "type": "string"
3078 + },
3079 + "server_location": {
3080 + "type": "string"
3081 + },
3082 + "base_url": {
3083 + "type": "string"
3084 + },
3085 + "status": {
3086 + "type": "string",
3087 + "enum": [
3088 + "EXPIRED"
3089 + ]
3090 + },
3091 + "expired_at": {
3092 + "type": "string"
3093 + }
3094 + },
3095 + "required": [
3096 + "status"
3097 + ],
3098 + "additionalProperties": {
3099 + "nullable": true
3100 + }
3101 + },
3102 + {
3103 + "type": "object",
3104 + "properties": {
3105 + "subdomain": {
3106 + "type": "string"
3107 + },
3108 + "your-domain": {
3109 + "type": "string"
3110 + },
3111 + "region": {
3112 + "type": "string"
3113 + },
3114 + "shop": {
3115 + "type": "string"
3116 + },
3117 + "account_url": {
3118 + "type": "string"
3119 + },
3120 + "COMPANYDOMAIN": {
3121 + "type": "string"
3122 + },
3123 + "extension": {
3124 + "type": "string"
3125 + },
3126 + "form_api_base_url": {
3127 + "type": "string"
3128 + },
3129 + "instanceEndpoint": {
3130 + "type": "string"
3131 + },
3132 + "api_url": {
3133 + "type": "string"
3134 + },
3135 + "borneo_dashboard_url": {
3136 + "type": "string"
3137 + },
3138 + "proxy_username": {
3139 + "type": "string"
3140 + },
3141 + "proxy_password": {
3142 + "type": "string"
3143 + },
3144 + "domain": {
3145 + "type": "string"
3146 + },
3147 + "version": {
3148 + "type": "string"
3149 + },
3150 + "dc": {
3151 + "type": "string"
3152 + },
3153 + "site_name": {
3154 + "type": "string"
3155 + },
3156 + "instanceName": {
3157 + "type": "string"
3158 + },
3159 + "account_id": {
3160 + "type": "string"
3161 + },
3162 + "your_server": {
3163 + "type": "string"
3164 + },
3165 + "server_location": {
3166 + "type": "string"
3167 + },
3168 + "base_url": {
3169 + "type": "string"
3170 + },
3171 + "status": {
3172 + "type": "string",
3173 + "enum": [
3174 + "INACTIVE"
3175 + ]
3176 + },
3177 + "oauth_token": {
3178 + "type": "string"
3179 + },
3180 + "oauth_token_secret": {
3181 + "type": "string"
3182 + },
3183 + "oauth_verifier": {
3184 + "type": "string"
3185 + },
3186 + "consumer_key": {
3187 + "type": "string"
3188 + },
3189 + "redirectUrl": {
3190 + "type": "string"
3191 + },
3192 + "callback_url": {
3193 + "type": "string"
3194 + }
3195 + },
3196 + "required": [
3197 + "status",
3198 + "oauth_token",
3199 + "oauth_token_secret"
3200 + ],
3201 + "additionalProperties": {
3202 + "nullable": true
3203 + }
3204 + }
3205 + ]
3206 + }
3207 + },
3208 + "required": [
3209 + "authScheme",
3210 + "val"
3211 + ]
3212 + },
3213 + {
3214 + "type": "object",
3215 + "properties": {
3216 + "authScheme": {
3217 + "type": "string",
3218 + "enum": [
3219 + "OAUTH2"
3220 + ]
3221 + },
3222 + "val": {
3223 + "oneOf": [
3224 + {
3225 + "type": "object",
3226 + "properties": {
3227 + "subdomain": {
3228 + "type": "string"
3229 + },
3230 + "your-domain": {
3231 + "type": "string"
3232 + },
3233 + "region": {
3234 + "type": "string"
3235 + },
3236 + "shop": {
3237 + "type": "string"
3238 + },
3239 + "account_url": {
3240 + "type": "string"
3241 + },
3242 + "COMPANYDOMAIN": {
3243 + "type": "string"
3244 + },
3245 + "extension": {
3246 + "type": "string"
3247 + },
3248 + "form_api_base_url": {
3249 + "type": "string"
3250 + },
3251 + "instanceEndpoint": {
3252 + "type": "string"
3253 + },
3254 + "api_url": {
3255 + "type": "string"
3256 + },
3257 + "borneo_dashboard_url": {
3258 + "type": "string"
3259 + },
3260 + "proxy_username": {
3261 + "type": "string"
3262 + },
3263 + "proxy_password": {
3264 + "type": "string"
3265 + },
3266 + "domain": {
3267 + "type": "string"
3268 + },
3269 + "version": {
3270 + "type": "string"
3271 + },
3272 + "dc": {
3273 + "type": "string"
3274 + },
3275 + "site_name": {
3276 + "type": "string"
3277 + },
3278 + "instanceName": {
3279 + "type": "string"
3280 + },
3281 + "account_id": {
3282 + "type": "string"
3283 + },
3284 + "your_server": {
3285 + "type": "string"
3286 + },
3287 + "server_location": {
3288 + "type": "string"
3289 + },
3290 + "base_url": {
3291 + "type": "string"
3292 + },
3293 + "status": {
3294 + "type": "string",
3295 + "enum": [
3296 + "INITIALIZING"
3297 + ]
3298 + },
3299 + "state_prefix": {
3300 + "type": "string",
3301 + "maxLength": 40,
3302 + "description": "The oauth2 state prefix for the connection"
3303 + },
3304 + "long_redirect_url": {
3305 + "type": "boolean",
3306 + "description": "Whether to return the redirect url without shortening"
3307 + }
3308 + },
3309 + "required": [
3310 + "status"
3311 + ],
3312 + "additionalProperties": {
3313 + "nullable": true
3314 + }
3315 + },
3316 + {
3317 + "type": "object",
3318 + "properties": {
3319 + "subdomain": {
3320 + "type": "string"
3321 + },
3322 + "your-domain": {
3323 + "type": "string"
3324 + },
3325 + "region": {
3326 + "type": "string"
3327 + },
3328 + "shop": {
3329 + "type": "string"
3330 + },
3331 + "account_url": {
3332 + "type": "string"
3333 + },
3334 + "COMPANYDOMAIN": {
3335 + "type": "string"
3336 + },
3337 + "extension": {
3338 + "type": "string"
3339 + },
3340 + "form_api_base_url": {
3341 + "type": "string"
3342 + },
3343 + "instanceEndpoint": {
3344 + "type": "string"
3345 + },
3346 + "api_url": {
3347 + "type": "string"
3348 + },
3349 + "borneo_dashboard_url": {
3350 + "type": "string"
3351 + },
3352 + "proxy_username": {
3353 + "type": "string"
3354 + },
3355 + "proxy_password": {
3356 + "type": "string"
3357 + },
3358 + "domain": {
3359 + "type": "string"
3360 + },
3361 + "version": {
3362 + "type": "string"
3363 + },
3364 + "dc": {
3365 + "type": "string"
3366 + },
3367 + "site_name": {
3368 + "type": "string"
3369 + },
3370 + "instanceName": {
3371 + "type": "string"
3372 + },
3373 + "account_id": {
3374 + "type": "string"
3375 + },
3376 + "your_server": {
3377 + "type": "string"
3378 + },
3379 + "server_location": {
3380 + "type": "string"
3381 + },
3382 + "base_url": {
3383 + "type": "string"
3384 + },
3385 + "status": {
3386 + "type": "string",
3387 + "enum": [
3388 + "INITIATED"
3389 + ]
3390 + },
3391 + "state_prefix": {
3392 + "type": "string",
3393 + "maxLength": 40,
3394 + "description": "The oauth2 state prefix for the connection"
3395 + },
3396 + "long_redirect_url": {
3397 + "type": "boolean",
3398 + "description": "Whether to return the redirect url without shortening"
3399 + },
3400 + "code_verifier": {
3401 + "type": "string"
3402 + },
3403 + "redirectUrl": {
3404 + "type": "string"
3405 + },
3406 + "callback_url": {
3407 + "type": "string"
3408 + },
3409 + "finalRedirectUri": {
3410 + "type": "string"
3411 + },
3412 + "webhook_signature": {
3413 + "type": "string"
3414 + }
3415 + },
3416 + "required": [
3417 + "status",
3418 + "redirectUrl"
3419 + ],
3420 + "additionalProperties": {
3421 + "nullable": true
3422 + }
3423 + },
3424 + {
3425 + "type": "object",
3426 + "properties": {
3427 + "subdomain": {
3428 + "type": "string"
3429 + },
3430 + "your-domain": {
3431 + "type": "string"
3432 + },
3433 + "region": {
3434 + "type": "string"
3435 + },
3436 + "shop": {
3437 + "type": "string"
3438 + },
3439 + "account_url": {
3440 + "type": "string"
3441 + },
3442 + "COMPANYDOMAIN": {
3443 + "type": "string"
3444 + },
3445 + "extension": {
3446 + "type": "string"
3447 + },
3448 + "form_api_base_url": {
3449 + "type": "string"
3450 + },
3451 + "instanceEndpoint": {
3452 + "type": "string"
3453 + },
3454 + "api_url": {
3455 + "type": "string"
3456 + },
3457 + "borneo_dashboard_url": {
3458 + "type": "string"
3459 + },
3460 + "proxy_username": {
3461 + "type": "string"
3462 + },
3463 + "proxy_password": {
3464 + "type": "string"
3465 + },
3466 + "domain": {
3467 + "type": "string"
3468 + },
3469 + "version": {
3470 + "type": "string"
3471 + },
3472 + "dc": {
3473 + "type": "string"
3474 + },
3475 + "site_name": {
3476 + "type": "string"
3477 + },
3478 + "instanceName": {
3479 + "type": "string"
3480 + },
3481 + "account_id": {
3482 + "type": "string"
3483 + },
3484 + "your_server": {
3485 + "type": "string"
3486 + },
3487 + "server_location": {
3488 + "type": "string"
3489 + },
3490 + "base_url": {
3491 + "type": "string"
3492 + },
3493 + "status": {
3494 + "type": "string",
3495 + "enum": [
3496 + "ACTIVE"
3497 + ]
3498 + },
3499 + "state_prefix": {
3500 + "type": "string",
3501 + "maxLength": 40,
3502 + "description": "The oauth2 state prefix for the connection"
3503 + },
3504 + "long_redirect_url": {
3505 + "type": "boolean",
3506 + "description": "Whether to return the redirect url without shortening"
3507 + },
3508 + "access_token": {
3509 + "type": "string"
3510 + },
3511 + "id_token": {
3512 + "type": "string"
3513 + },
3514 + "token_type": {
3515 + "type": "string"
3516 + },
3517 + "refresh_token": {
3518 + "type": "string",
3519 + "nullable": true
3520 + },
3521 + "expires_in": {
3522 + "anyOf": [
3523 + {
3524 + "type": "number"
3525 + },
3526 + {
3527 + "type": "string"
3528 + },
3529 + {
3530 + "nullable": true
3531 + }
3532 + ]
3533 + },
3534 + "scope": {
3535 + "anyOf": [
3536 + {
3537 + "type": "string"
3538 + },
3539 + {
3540 + "type": "array",
3541 + "items": {
3542 + "type": "string"
3543 + }
3544 + },
3545 + {
3546 + "nullable": true
3547 + }
3548 + ]
3549 + },
3550 + "webhook_signature": {
3551 + "type": "string"
3552 + },
3553 + "authed_user": {
3554 + "type": "object",
3555 + "properties": {
3556 + "access_token": {
3557 + "type": "string"
3558 + },
3559 + "scope": {
3560 + "type": "string"
3561 + }
3562 + },
3563 + "description": "for slack user scopes"
3564 + }
3565 + },
3566 + "required": [
3567 + "status",
3568 + "access_token"
3569 + ],
3570 + "additionalProperties": {
3571 + "nullable": true
3572 + }
3573 + },
3574 + {
3575 + "type": "object",
3576 + "properties": {
3577 + "subdomain": {
3578 + "type": "string"
3579 + },
3580 + "your-domain": {
3581 + "type": "string"
3582 + },
3583 + "region": {
3584 + "type": "string"
3585 + },
3586 + "shop": {
3587 + "type": "string"
3588 + },
3589 + "account_url": {
3590 + "type": "string"
3591 + },
3592 + "COMPANYDOMAIN": {
3593 + "type": "string"
3594 + },
3595 + "extension": {
3596 + "type": "string"
3597 + },
3598 + "form_api_base_url": {
3599 + "type": "string"
3600 + },
3601 + "instanceEndpoint": {
3602 + "type": "string"
3603 + },
3604 + "api_url": {
3605 + "type": "string"
3606 + },
3607 + "borneo_dashboard_url": {
3608 + "type": "string"
3609 + },
3610 + "proxy_username": {
3611 + "type": "string"
3612 + },
3613 + "proxy_password": {
3614 + "type": "string"
3615 + },
3616 + "domain": {
3617 + "type": "string"
3618 + },
3619 + "version": {
3620 + "type": "string"
3621 + },
3622 + "dc": {
3623 + "type": "string"
3624 + },
3625 + "site_name": {
3626 + "type": "string"
3627 + },
3628 + "instanceName": {
3629 + "type": "string"
3630 + },
3631 + "account_id": {
3632 + "type": "string"
3633 + },
3634 + "your_server": {
3635 + "type": "string"
3636 + },
3637 + "server_location": {
3638 + "type": "string"
3639 + },
3640 + "base_url": {
3641 + "type": "string"
3642 + },
3643 + "status": {
3644 + "type": "string",
3645 + "enum": [
3646 + "INACTIVE"
3647 + ]
3648 + },
3649 + "state_prefix": {
3650 + "type": "string",
3651 + "maxLength": 40,
3652 + "description": "The oauth2 state prefix for the connection"
3653 + },
3654 + "long_redirect_url": {
3655 + "type": "boolean",
3656 + "description": "Whether to return the redirect url without shortening"
3657 + },
3658 + "access_token": {
3659 + "type": "string"
3660 + },
3661 + "id_token": {
3662 + "type": "string"
3663 + },
3664 + "token_type": {
3665 + "type": "string"
3666 + },
3667 + "refresh_token": {
3668 + "type": "string",
3669 + "nullable": true
3670 + },
3671 + "expires_in": {
3672 + "anyOf": [
3673 + {
3674 + "type": "number"
3675 + },
3676 + {
3677 + "type": "string"
3678 + },
3679 + {
3680 + "nullable": true
3681 + }
3682 + ]
3683 + },
3684 + "scope": {
3685 + "anyOf": [
3686 + {
3687 + "type": "string"
3688 + },
3689 + {
3690 + "type": "array",
3691 + "items": {
3692 + "type": "string"
3693 + }
3694 + },
3695 + {
3696 + "nullable": true
3697 + }
3698 + ]
3699 + },
3700 + "webhook_signature": {
3701 + "type": "string"
3702 + },
3703 + "authed_user": {
3704 + "type": "object",
3705 + "properties": {
3706 + "access_token": {
3707 + "type": "string"
3708 + },
3709 + "scope": {
3710 + "type": "string"
3711 + }
3712 + },
3713 + "description": "for slack user scopes"
3714 + }
3715 + },
3716 + "required": [
3717 + "status",
3718 + "access_token"
3719 + ],
3720 + "additionalProperties": {
3721 + "nullable": true
3722 + }
3723 + },
3724 + {
3725 + "type": "object",
3726 + "properties": {
3727 + "subdomain": {
3728 + "type": "string"
3729 + },
3730 + "your-domain": {
3731 + "type": "string"
3732 + },
3733 + "region": {
3734 + "type": "string"
3735 + },
3736 + "shop": {
3737 + "type": "string"
3738 + },
3739 + "account_url": {
3740 + "type": "string"
3741 + },
3742 + "COMPANYDOMAIN": {
3743 + "type": "string"
3744 + },
3745 + "extension": {
3746 + "type": "string"
3747 + },
3748 + "form_api_base_url": {
3749 + "type": "string"
3750 + },
3751 + "instanceEndpoint": {
3752 + "type": "string"
3753 + },
3754 + "api_url": {
3755 + "type": "string"
3756 + },
3757 + "borneo_dashboard_url": {
3758 + "type": "string"
3759 + },
3760 + "proxy_username": {
3761 + "type": "string"
3762 + },
3763 + "proxy_password": {
3764 + "type": "string"
3765 + },
3766 + "domain": {
3767 + "type": "string"
3768 + },
3769 + "version": {
3770 + "type": "string"
3771 + },
3772 + "dc": {
3773 + "type": "string"
3774 + },
3775 + "site_name": {
3776 + "type": "string"
3777 + },
3778 + "instanceName": {
3779 + "type": "string"
3780 + },
3781 + "account_id": {
3782 + "type": "string"
3783 + },
3784 + "your_server": {
3785 + "type": "string"
3786 + },
3787 + "server_location": {
3788 + "type": "string"
3789 + },
3790 + "base_url": {
3791 + "type": "string"
3792 + },
3793 + "status": {
3794 + "type": "string",
3795 + "enum": [
3796 + "FAILED"
3797 + ]
3798 + },
3799 + "state_prefix": {
3800 + "type": "string",
3801 + "maxLength": 40,
3802 + "description": "The oauth2 state prefix for the connection"
3803 + },
3804 + "long_redirect_url": {
3805 + "type": "boolean",
3806 + "description": "Whether to return the redirect url without shortening"
3807 + },
3808 + "error": {
3809 + "type": "string"
3810 + },
3811 + "error_description": {
3812 + "type": "string"
3813 + }
3814 + },
3815 + "required": [
3816 + "status"
3817 + ],
3818 + "additionalProperties": {
3819 + "nullable": true
3820 + }
3821 + },
3822 + {
3823 + "type": "object",
3824 + "properties": {
3825 + "subdomain": {
3826 + "type": "string"
3827 + },
3828 + "your-domain": {
3829 + "type": "string"
3830 + },
3831 + "region": {
3832 + "type": "string"
3833 + },
3834 + "shop": {
3835 + "type": "string"
3836 + },
3837 + "account_url": {
3838 + "type": "string"
3839 + },
3840 + "COMPANYDOMAIN": {
3841 + "type": "string"
3842 + },
3843 + "extension": {
3844 + "type": "string"
3845 + },
3846 + "form_api_base_url": {
3847 + "type": "string"
3848 + },
3849 + "instanceEndpoint": {
3850 + "type": "string"
3851 + },
3852 + "api_url": {
3853 + "type": "string"
3854 + },
3855 + "borneo_dashboard_url": {
3856 + "type": "string"
3857 + },
3858 + "proxy_username": {
3859 + "type": "string"
3860 + },
3861 + "proxy_password": {
3862 + "type": "string"
3863 + },
3864 + "domain": {
3865 + "type": "string"
3866 + },
3867 + "version": {
3868 + "type": "string"
3869 + },
3870 + "dc": {
3871 + "type": "string"
3872 + },
3873 + "site_name": {
3874 + "type": "string"
3875 + },
3876 + "instanceName": {
3877 + "type": "string"
3878 + },
3879 + "account_id": {
3880 + "type": "string"
3881 + },
3882 + "your_server": {
3883 + "type": "string"
3884 + },
3885 + "server_location": {
3886 + "type": "string"
3887 + },
3888 + "base_url": {
3889 + "type": "string"
3890 + },
3891 + "status": {
3892 + "type": "string",
3893 + "enum": [
3894 + "EXPIRED"
3895 + ]
3896 + },
3897 + "state_prefix": {
3898 + "type": "string",
3899 + "maxLength": 40,
3900 + "description": "The oauth2 state prefix for the connection"
3901 + },
3902 + "long_redirect_url": {
3903 + "type": "boolean",
3904 + "description": "Whether to return the redirect url without shortening"
3905 + },
3906 + "expired_at": {
3907 + "type": "string"
3908 + }
3909 + },
3910 + "required": [
3911 + "status"
3912 + ],
3913 + "additionalProperties": {
3914 + "nullable": true
3915 + }
3916 + }
3917 + ]
3918 + }
3919 + },
3920 + "required": [
3921 + "authScheme",
3922 + "val"
3923 + ]
3924 + },
3925 + {
3926 + "type": "object",
3927 + "properties": {
3928 + "authScheme": {
3929 + "type": "string",
3930 + "enum": [
3931 + "API_KEY"
3932 + ]
3933 + },
3934 + "val": {
3935 + "oneOf": [
3936 + {
3937 + "type": "object",
3938 + "properties": {
3939 + "subdomain": {
3940 + "type": "string"
3941 + },
3942 + "your-domain": {
3943 + "type": "string"
3944 + },
3945 + "region": {
3946 + "type": "string"
3947 + },
3948 + "shop": {
3949 + "type": "string"
3950 + },
3951 + "account_url": {
3952 + "type": "string"
3953 + },
3954 + "COMPANYDOMAIN": {
3955 + "type": "string"
3956 + },
3957 + "extension": {
3958 + "type": "string"
3959 + },
3960 + "form_api_base_url": {
3961 + "type": "string"
3962 + },
3963 + "instanceEndpoint": {
3964 + "type": "string"
3965 + },
3966 + "api_url": {
3967 + "type": "string"
3968 + },
3969 + "borneo_dashboard_url": {
3970 + "type": "string"
3971 + },
3972 + "proxy_username": {
3973 + "type": "string"
3974 + },
3975 + "proxy_password": {
3976 + "type": "string"
3977 + },
3978 + "domain": {
3979 + "type": "string"
3980 + },
3981 + "version": {
3982 + "type": "string"
3983 + },
3984 + "dc": {
3985 + "type": "string"
3986 + },
3987 + "site_name": {
3988 + "type": "string"
3989 + },
3990 + "instanceName": {
3991 + "type": "string"
3992 + },
3993 + "account_id": {
3994 + "type": "string"
3995 + },
3996 + "your_server": {
3997 + "type": "string"
3998 + },
3999 + "server_location": {
4000 + "type": "string"
4001 + },
4002 + "base_url": {
4003 + "type": "string"
4004 + },
4005 + "status": {
4006 + "type": "string",
4007 + "enum": [
4008 + "INITIALIZING"
4009 + ]
4010 + }
4011 + },
4012 + "required": [
4013 + "status"
4014 + ],
4015 + "additionalProperties": {
4016 + "nullable": true
4017 + }
4018 + },
4019 + {
4020 + "type": "object",
4021 + "properties": {
4022 + "subdomain": {
4023 + "type": "string"
4024 + },
4025 + "your-domain": {
4026 + "type": "string"
4027 + },
4028 + "region": {
4029 + "type": "string"
4030 + },
4031 + "shop": {
4032 + "type": "string"
4033 + },
4034 + "account_url": {
4035 + "type": "string"
4036 + },
4037 + "COMPANYDOMAIN": {
4038 + "type": "string"
4039 + },
4040 + "extension": {
4041 + "type": "string"
4042 + },
4043 + "form_api_base_url": {
4044 + "type": "string"
4045 + },
4046 + "instanceEndpoint": {
4047 + "type": "string"
4048 + },
4049 + "api_url": {
4050 + "type": "string"
4051 + },
4052 + "borneo_dashboard_url": {
4053 + "type": "string"
4054 + },
4055 + "proxy_username": {
4056 + "type": "string"
4057 + },
4058 + "proxy_password": {
4059 + "type": "string"
4060 + },
4061 + "domain": {
4062 + "type": "string"
4063 + },
4064 + "version": {
4065 + "type": "string"
4066 + },
4067 + "dc": {
4068 + "type": "string"
4069 + },
4070 + "site_name": {
4071 + "type": "string"
4072 + },
4073 + "instanceName": {
4074 + "type": "string"
4075 + },
4076 + "account_id": {
4077 + "type": "string"
4078 + },
4079 + "your_server": {
4080 + "type": "string"
4081 + },
4082 + "server_location": {
4083 + "type": "string"
4084 + },
4085 + "base_url": {
4086 + "type": "string"
4087 + },
4088 + "status": {
4089 + "type": "string",
4090 + "enum": [
4091 + "INITIATED"
4092 + ]
4093 + }
4094 + },
4095 + "required": [
4096 + "status"
4097 + ],
4098 + "additionalProperties": {
4099 + "nullable": true
4100 + }
4101 + },
4102 + {
4103 + "type": "object",
4104 + "properties": {
4105 + "subdomain": {
4106 + "type": "string"
4107 + },
4108 + "your-domain": {
4109 + "type": "string"
4110 + },
4111 + "region": {
4112 + "type": "string"
4113 + },
4114 + "shop": {
4115 + "type": "string"
4116 + },
4117 + "account_url": {
4118 + "type": "string"
4119 + },
4120 + "COMPANYDOMAIN": {
4121 + "type": "string"
4122 + },
4123 + "extension": {
4124 + "type": "string"
4125 + },
4126 + "form_api_base_url": {
4127 + "type": "string"
4128 + },
4129 + "instanceEndpoint": {
4130 + "type": "string"
4131 + },
4132 + "api_url": {
4133 + "type": "string"
4134 + },
4135 + "borneo_dashboard_url": {
4136 + "type": "string"
4137 + },
4138 + "proxy_username": {
4139 + "type": "string"
4140 + },
4141 + "proxy_password": {
4142 + "type": "string"
4143 + },
4144 + "domain": {
4145 + "type": "string"
4146 + },
4147 + "version": {
4148 + "type": "string"
4149 + },
4150 + "dc": {
4151 + "type": "string"
4152 + },
4153 + "site_name": {
4154 + "type": "string"
4155 + },
4156 + "instanceName": {
4157 + "type": "string"
4158 + },
4159 + "account_id": {
4160 + "type": "string"
4161 + },
4162 + "your_server": {
4163 + "type": "string"
4164 + },
4165 + "server_location": {
4166 + "type": "string"
4167 + },
4168 + "base_url": {
4169 + "type": "string"
4170 + },
4171 + "status": {
4172 + "type": "string",
4173 + "enum": [
4174 + "ACTIVE"
4175 + ]
4176 + },
4177 + "generic_api_key": {
4178 + "type": "string"
4179 + },
4180 + "api_key": {
4181 + "type": "string"
4182 + },
4183 + "bearer_token": {
4184 + "type": "string"
4185 + },
4186 + "basic_encoded": {
4187 + "type": "string"
4188 + }
4189 + },
4190 + "required": [
4191 + "status"
4192 + ],
4193 + "additionalProperties": {
4194 + "nullable": true
4195 + }
4196 + },
4197 + {
4198 + "type": "object",
4199 + "properties": {
4200 + "subdomain": {
4201 + "type": "string"
4202 + },
4203 + "your-domain": {
4204 + "type": "string"
4205 + },
4206 + "region": {
4207 + "type": "string"
4208 + },
4209 + "shop": {
4210 + "type": "string"
4211 + },
4212 + "account_url": {
4213 + "type": "string"
4214 + },
4215 + "COMPANYDOMAIN": {
4216 + "type": "string"
4217 + },
4218 + "extension": {
4219 + "type": "string"
4220 + },
4221 + "form_api_base_url": {
4222 + "type": "string"
4223 + },
4224 + "instanceEndpoint": {
4225 + "type": "string"
4226 + },
4227 + "api_url": {
4228 + "type": "string"
4229 + },
4230 + "borneo_dashboard_url": {
4231 + "type": "string"
4232 + },
4233 + "proxy_username": {
4234 + "type": "string"
4235 + },
4236 + "proxy_password": {
4237 + "type": "string"
4238 + },
4239 + "domain": {
4240 + "type": "string"
4241 + },
4242 + "version": {
4243 + "type": "string"
4244 + },
4245 + "dc": {
4246 + "type": "string"
4247 + },
4248 + "site_name": {
4249 + "type": "string"
4250 + },
4251 + "instanceName": {
4252 + "type": "string"
4253 + },
4254 + "account_id": {
4255 + "type": "string"
4256 + },
4257 + "your_server": {
4258 + "type": "string"
4259 + },
4260 + "server_location": {
4261 + "type": "string"
4262 + },
4263 + "base_url": {
4264 + "type": "string"
4265 + },
4266 + "status": {
4267 + "type": "string",
4268 + "enum": [
4269 + "INACTIVE"
4270 + ]
4271 + },
4272 + "generic_api_key": {
4273 + "type": "string"
4274 + },
4275 + "api_key": {
4276 + "type": "string"
4277 + },
4278 + "bearer_token": {
4279 + "type": "string"
4280 + },
4281 + "basic_encoded": {
4282 + "type": "string"
4283 + }
4284 + },
4285 + "required": [
4286 + "status"
4287 + ],
4288 + "additionalProperties": {
4289 + "nullable": true
4290 + }
4291 + }
4292 + ]
4293 + }
4294 + },
4295 + "required": [
4296 + "authScheme",
4297 + "val"
4298 + ]
4299 + },
4300 + {
4301 + "type": "object",
4302 + "properties": {
4303 + "authScheme": {
4304 + "type": "string",
4305 + "enum": [
4306 + "BASIC"
4307 + ]
4308 + },
4309 + "val": {
4310 + "oneOf": [
4311 + {
4312 + "type": "object",
4313 + "properties": {
4314 + "subdomain": {
4315 + "type": "string"
4316 + },
4317 + "your-domain": {
4318 + "type": "string"
4319 + },
4320 + "region": {
4321 + "type": "string"
4322 + },
4323 + "shop": {
4324 + "type": "string"
4325 + },
4326 + "account_url": {
4327 + "type": "string"
4328 + },
4329 + "COMPANYDOMAIN": {
4330 + "type": "string"
4331 + },
4332 + "extension": {
4333 + "type": "string"
4334 + },
4335 + "form_api_base_url": {
4336 + "type": "string"
4337 + },
4338 + "instanceEndpoint": {
4339 + "type": "string"
4340 + },
4341 + "api_url": {
4342 + "type": "string"
4343 + },
4344 + "borneo_dashboard_url": {
4345 + "type": "string"
4346 + },
4347 + "proxy_username": {
4348 + "type": "string"
4349 + },
4350 + "proxy_password": {
4351 + "type": "string"
4352 + },
4353 + "domain": {
4354 + "type": "string"
4355 + },
4356 + "version": {
4357 + "type": "string"
4358 + },
4359 + "dc": {
4360 + "type": "string"
4361 + },
4362 + "site_name": {
4363 + "type": "string"
4364 + },
4365 + "instanceName": {
4366 + "type": "string"
4367 + },
4368 + "account_id": {
4369 + "type": "string"
4370 + },
4371 + "your_server": {
4372 + "type": "string"
4373 + },
4374 + "server_location": {
4375 + "type": "string"
4376 + },
4377 + "base_url": {
4378 + "type": "string"
4379 + },
4380 + "status": {
4381 + "type": "string",
4382 + "enum": [
4383 + "INITIALIZING"
4384 + ]
4385 + }
4386 + },
4387 + "required": [
4388 + "status"
4389 + ],
4390 + "additionalProperties": {
4391 + "nullable": true
4392 + }
4393 + },
4394 + {
4395 + "type": "object",
4396 + "properties": {
4397 + "subdomain": {
4398 + "type": "string"
4399 + },
4400 + "your-domain": {
4401 + "type": "string"
4402 + },
4403 + "region": {
4404 + "type": "string"
4405 + },
4406 + "shop": {
4407 + "type": "string"
4408 + },
4409 + "account_url": {
4410 + "type": "string"
4411 + },
4412 + "COMPANYDOMAIN": {
4413 + "type": "string"
4414 + },
4415 + "extension": {
4416 + "type": "string"
4417 + },
4418 + "form_api_base_url": {
4419 + "type": "string"
4420 + },
4421 + "instanceEndpoint": {
4422 + "type": "string"
4423 + },
4424 + "api_url": {
4425 + "type": "string"
4426 + },
4427 + "borneo_dashboard_url": {
4428 + "type": "string"
4429 + },
4430 + "proxy_username": {
4431 + "type": "string"
4432 + },
4433 + "proxy_password": {
4434 + "type": "string"
4435 + },
4436 + "domain": {
4437 + "type": "string"
4438 + },
4439 + "version": {
4440 + "type": "string"
4441 + },
4442 + "dc": {
4443 + "type": "string"
4444 + },
4445 + "site_name": {
4446 + "type": "string"
4447 + },
4448 + "instanceName": {
4449 + "type": "string"
4450 + },
4451 + "account_id": {
4452 + "type": "string"
4453 + },
4454 + "your_server": {
4455 + "type": "string"
4456 + },
4457 + "server_location": {
4458 + "type": "string"
4459 + },
4460 + "base_url": {
4461 + "type": "string"
4462 + },
4463 + "status": {
4464 + "type": "string",
4465 + "enum": [
4466 + "INITIATED"
4467 + ]
4468 + }
4469 + },
4470 + "required": [
4471 + "status"
4472 + ],
4473 + "additionalProperties": {
4474 + "nullable": true
4475 + }
4476 + },
4477 + {
4478 + "type": "object",
4479 + "properties": {
4480 + "subdomain": {
4481 + "type": "string"
4482 + },
4483 + "your-domain": {
4484 + "type": "string"
4485 + },
4486 + "region": {
4487 + "type": "string"
4488 + },
4489 + "shop": {
4490 + "type": "string"
4491 + },
4492 + "account_url": {
4493 + "type": "string"
4494 + },
4495 + "COMPANYDOMAIN": {
4496 + "type": "string"
4497 + },
4498 + "extension": {
4499 + "type": "string"
4500 + },
4501 + "form_api_base_url": {
4502 + "type": "string"
4503 + },
4504 + "instanceEndpoint": {
4505 + "type": "string"
4506 + },
4507 + "api_url": {
4508 + "type": "string"
4509 + },
4510 + "borneo_dashboard_url": {
4511 + "type": "string"
4512 + },
4513 + "proxy_username": {
4514 + "type": "string"
4515 + },
4516 + "proxy_password": {
4517 + "type": "string"
4518 + },
4519 + "domain": {
4520 + "type": "string"
4521 + },
4522 + "version": {
4523 + "type": "string"
4524 + },
4525 + "dc": {
4526 + "type": "string"
4527 + },
4528 + "site_name": {
4529 + "type": "string"
4530 + },
4531 + "instanceName": {
4532 + "type": "string"
4533 + },
4534 + "account_id": {
4535 + "type": "string"
4536 + },
4537 + "your_server": {
4538 + "type": "string"
4539 + },
4540 + "server_location": {
4541 + "type": "string"
4542 + },
4543 + "base_url": {
4544 + "type": "string"
4545 + },
4546 + "status": {
4547 + "type": "string",
4548 + "enum": [
4549 + "ACTIVE"
4550 + ]
4551 + },
4552 + "username": {
4553 + "type": "string"
4554 + },
4555 + "password": {
4556 + "type": "string"
4557 + }
4558 + },
4559 + "required": [
4560 + "status",
4561 + "username"
4562 + ],
4563 + "additionalProperties": {
4564 + "nullable": true
4565 + }
4566 + },
4567 + {
4568 + "type": "object",
4569 + "properties": {
4570 + "subdomain": {
4571 + "type": "string"
4572 + },
4573 + "your-domain": {
4574 + "type": "string"
4575 + },
4576 + "region": {
4577 + "type": "string"
4578 + },
4579 + "shop": {
4580 + "type": "string"
4581 + },
4582 + "account_url": {
4583 + "type": "string"
4584 + },
4585 + "COMPANYDOMAIN": {
4586 + "type": "string"
4587 + },
4588 + "extension": {
4589 + "type": "string"
4590 + },
4591 + "form_api_base_url": {
4592 + "type": "string"
4593 + },
4594 + "instanceEndpoint": {
4595 + "type": "string"
4596 + },
4597 + "api_url": {
4598 + "type": "string"
4599 + },
4600 + "borneo_dashboard_url": {
4601 + "type": "string"
4602 + },
4603 + "proxy_username": {
4604 + "type": "string"
4605 + },
4606 + "proxy_password": {
4607 + "type": "string"
4608 + },
4609 + "domain": {
4610 + "type": "string"
4611 + },
4612 + "version": {
4613 + "type": "string"
4614 + },
4615 + "dc": {
4616 + "type": "string"
4617 + },
4618 + "site_name": {
4619 + "type": "string"
4620 + },
4621 + "instanceName": {
4622 + "type": "string"
4623 + },
4624 + "account_id": {
4625 + "type": "string"
4626 + },
4627 + "your_server": {
4628 + "type": "string"
4629 + },
4630 + "server_location": {
4631 + "type": "string"
4632 + },
4633 + "base_url": {
4634 + "type": "string"
4635 + },
4636 + "status": {
4637 + "type": "string",
4638 + "enum": [
4639 + "INACTIVE"
4640 + ]
4641 + },
4642 + "username": {
4643 + "type": "string"
4644 + },
4645 + "password": {
4646 + "type": "string"
4647 + }
4648 + },
4649 + "required": [
4650 + "status",
4651 + "username"
4652 + ],
4653 + "additionalProperties": {
4654 + "nullable": true
4655 + }
4656 + }
4657 + ]
4658 + }
4659 + },
4660 + "required": [
4661 + "authScheme",
4662 + "val"
4663 + ]
4664 + },
4665 + {
4666 + "type": "object",
4667 + "properties": {
4668 + "authScheme": {
4669 + "type": "string",
4670 + "enum": [
4671 + "BEARER_TOKEN"
4672 + ]
4673 + },
4674 + "val": {
4675 + "oneOf": [
4676 + {
4677 + "type": "object",
4678 + "properties": {
4679 + "subdomain": {
4680 + "type": "string"
4681 + },
4682 + "your-domain": {
4683 + "type": "string"
4684 + },
4685 + "region": {
4686 + "type": "string"
4687 + },
4688 + "shop": {
4689 + "type": "string"
4690 + },
4691 + "account_url": {
4692 + "type": "string"
4693 + },
4694 + "COMPANYDOMAIN": {
4695 + "type": "string"
4696 + },
4697 + "extension": {
4698 + "type": "string"
4699 + },
4700 + "form_api_base_url": {
4701 + "type": "string"
4702 + },
4703 + "instanceEndpoint": {
4704 + "type": "string"
4705 + },
4706 + "api_url": {
4707 + "type": "string"
4708 + },
4709 + "borneo_dashboard_url": {
4710 + "type": "string"
4711 + },
4712 + "proxy_username": {
4713 + "type": "string"
4714 + },
4715 + "proxy_password": {
4716 + "type": "string"
4717 + },
4718 + "domain": {
4719 + "type": "string"
4720 + },
4721 + "version": {
4722 + "type": "string"
4723 + },
4724 + "dc": {
4725 + "type": "string"
4726 + },
4727 + "site_name": {
4728 + "type": "string"
4729 + },
4730 + "instanceName": {
4731 + "type": "string"
4732 + },
4733 + "account_id": {
4734 + "type": "string"
4735 + },
4736 + "your_server": {
4737 + "type": "string"
4738 + },
4739 + "server_location": {
4740 + "type": "string"
4741 + },
4742 + "base_url": {
4743 + "type": "string"
4744 + },
4745 + "status": {
4746 + "type": "string",
4747 + "enum": [
4748 + "INITIALIZING"
4749 + ]
4750 + }
4751 + },
4752 + "required": [
4753 + "status"
4754 + ],
4755 + "additionalProperties": {
4756 + "nullable": true
4757 + }
4758 + },
4759 + {
4760 + "type": "object",
4761 + "properties": {
4762 + "subdomain": {
4763 + "type": "string"
4764 + },
4765 + "your-domain": {
4766 + "type": "string"
4767 + },
4768 + "region": {
4769 + "type": "string"
4770 + },
4771 + "shop": {
4772 + "type": "string"
4773 + },
4774 + "account_url": {
4775 + "type": "string"
4776 + },
4777 + "COMPANYDOMAIN": {
4778 + "type": "string"
4779 + },
4780 + "extension": {
4781 + "type": "string"
4782 + },
4783 + "form_api_base_url": {
4784 + "type": "string"
4785 + },
4786 + "instanceEndpoint": {
4787 + "type": "string"
4788 + },
4789 + "api_url": {
4790 + "type": "string"
4791 + },
4792 + "borneo_dashboard_url": {
4793 + "type": "string"
4794 + },
4795 + "proxy_username": {
4796 + "type": "string"
4797 + },
4798 + "proxy_password": {
4799 + "type": "string"
4800 + },
4801 + "domain": {
4802 + "type": "string"
4803 + },
4804 + "version": {
4805 + "type": "string"
4806 + },
4807 + "dc": {
4808 + "type": "string"
4809 + },
4810 + "site_name": {
4811 + "type": "string"
4812 + },
4813 + "instanceName": {
4814 + "type": "string"
4815 + },
4816 + "account_id": {
4817 + "type": "string"
4818 + },
4819 + "your_server": {
4820 + "type": "string"
4821 + },
4822 + "server_location": {
4823 + "type": "string"
4824 + },
4825 + "base_url": {
4826 + "type": "string"
4827 + },
4828 + "status": {
4829 + "type": "string",
4830 + "enum": [
4831 + "INITIATED"
4832 + ]
4833 + }
4834 + },
4835 + "required": [
4836 + "status"
4837 + ],
4838 + "additionalProperties": {
4839 + "nullable": true
4840 + }
4841 + },
4842 + {
4843 + "type": "object",
4844 + "properties": {
4845 + "subdomain": {
4846 + "type": "string"
4847 + },
4848 + "your-domain": {
4849 + "type": "string"
4850 + },
4851 + "region": {
4852 + "type": "string"
4853 + },
4854 + "shop": {
4855 + "type": "string"
4856 + },
4857 + "account_url": {
4858 + "type": "string"
4859 + },
4860 + "COMPANYDOMAIN": {
4861 + "type": "string"
4862 + },
4863 + "extension": {
4864 + "type": "string"
4865 + },
4866 + "form_api_base_url": {
4867 + "type": "string"
4868 + },
4869 + "instanceEndpoint": {
4870 + "type": "string"
4871 + },
4872 + "api_url": {
4873 + "type": "string"
4874 + },
4875 + "borneo_dashboard_url": {
4876 + "type": "string"
4877 + },
4878 + "proxy_username": {
4879 + "type": "string"
4880 + },
4881 + "proxy_password": {
4882 + "type": "string"
4883 + },
4884 + "domain": {
4885 + "type": "string"
4886 + },
4887 + "version": {
4888 + "type": "string"
4889 + },
4890 + "dc": {
4891 + "type": "string"
4892 + },
4893 + "site_name": {
4894 + "type": "string"
4895 + },
4896 + "instanceName": {
4897 + "type": "string"
4898 + },
4899 + "account_id": {
4900 + "type": "string"
4901 + },
4902 + "your_server": {
4903 + "type": "string"
4904 + },
4905 + "server_location": {
4906 + "type": "string"
4907 + },
4908 + "base_url": {
4909 + "type": "string"
4910 + },
4911 + "status": {
4912 + "type": "string",
4913 + "enum": [
4914 + "ACTIVE"
4915 + ]
4916 + },
4917 + "token": {
4918 + "type": "string"
4919 + }
4920 + },
4921 + "required": [
4922 + "status",
4923 + "token"
4924 + ],
4925 + "additionalProperties": {
4926 + "nullable": true
4927 + }
4928 + },
4929 + {
4930 + "type": "object",
4931 + "properties": {
4932 + "subdomain": {
4933 + "type": "string"
4934 + },
4935 + "your-domain": {
4936 + "type": "string"
4937 + },
4938 + "region": {
4939 + "type": "string"
4940 + },
4941 + "shop": {
4942 + "type": "string"
4943 + },
4944 + "account_url": {
4945 + "type": "string"
4946 + },
4947 + "COMPANYDOMAIN": {
4948 + "type": "string"
4949 + },
4950 + "extension": {
4951 + "type": "string"
4952 + },
4953 + "form_api_base_url": {
4954 + "type": "string"
4955 + },
4956 + "instanceEndpoint": {
4957 + "type": "string"
4958 + },
4959 + "api_url": {
4960 + "type": "string"
4961 + },
4962 + "borneo_dashboard_url": {
4963 + "type": "string"
4964 + },
4965 + "proxy_username": {
4966 + "type": "string"
4967 + },
4968 + "proxy_password": {
4969 + "type": "string"
4970 + },
4971 + "domain": {
4972 + "type": "string"
4973 + },
4974 + "version": {
4975 + "type": "string"
4976 + },
4977 + "dc": {
4978 + "type": "string"
4979 + },
4980 + "site_name": {
4981 + "type": "string"
4982 + },
4983 + "instanceName": {
4984 + "type": "string"
4985 + },
4986 + "account_id": {
4987 + "type": "string"
4988 + },
4989 + "your_server": {
4990 + "type": "string"
4991 + },
4992 + "server_location": {
4993 + "type": "string"
4994 + },
4995 + "base_url": {
4996 + "type": "string"
4997 + },
4998 + "status": {
4999 + "type": "string",

This file is too large to show in full.

fumadocs/public/videos/fetch-org-key.mp4
Binary files /dev/null and b/fumadocs/public/videos/fetch-org-key.mp4 differ
fumadocs/public/videos/fetch-project-key.mp4
Binary files /dev/null and b/fumadocs/public/videos/fetch-project-key.mp4 differ
fumadocs/scripts/README.md new
+53
@@ -0,0 +1,53 @@
1 +# OpenAPI Scripts
2 +
3 +## fetch-openapi.mjs
4 +
5 +Fetches the Composio OpenAPI spec and filters it for use in Fumadocs API reference documentation.
6 +
7 +### Usage
8 +
9 +```bash
10 +bun run scripts/fetch-openapi.mjs
11 +```
12 +
13 +This outputs `public/openapi.json` which is used by `lib/openapi.ts`.
14 +
15 +### Why Filtering is Needed
16 +
17 +The raw OpenAPI spec from `https://backend.composio.dev/api/v3/openapi.json` has issues that break documentation generators:
18 +
19 +1. **Endpoints with multiple tags** - Causes duplicate entries in sidebar
20 +2. **Internal endpoints exposed** - CLI, Admin, Profiling endpoints shouldn't be in public docs
21 +
22 +See `OPENAPI_IMPROVEMENTS.md` in the fumadocs root for planned fixes to the spec itself.
23 +
24 +### What Gets Filtered
25 +
26 +#### Ignored Paths
27 +These endpoints are completely removed:
28 +- `/api/v3/mcp/validate/{uuid}`
29 +- `/api/v3/cli/get-session`
30 +- `/api/v3/cli/create-session`
31 +- `/api/v3/auth/session/logout`
32 +
33 +#### Ignored Tags
34 +Endpoints with only these tags are removed:
35 +- `CLI`
36 +- `Admin`
37 +- `Profiling`
38 +
39 +#### Duplicate Prevention
40 +If an endpoint has multiple tags, only the first tag is kept. This prevents the same endpoint appearing in multiple sidebar sections.
41 +
42 +### Configuration
43 +
44 +The script uses environment variables:
45 +
46 +| Variable | Default | Description |
47 +|----------|---------|-------------|
48 +| `OPENAPI_SPEC_URL` | `https://backend.composio.dev/api/v3/openapi.json` | Source OpenAPI spec URL |
49 +
50 +For staging deployments, set:
51 +```bash
52 +OPENAPI_SPEC_URL=https://staging.composio.dev/api/v3/openapi.json
53 +```
fumadocs/scripts/fetch-openapi.mjs new
+93
@@ -0,0 +1,93 @@
1 +/**
2 + * Fetches and filters the OpenAPI spec for fumadocs
3 + * Mirrors the filtering done in fern/apis/openapi-overrides.yml
4 + *
5 + * Run: bun run scripts/fetch-openapi.mjs
6 + */
7 +
8 +import { writeFileSync } from 'node:fs';
9 +import { fileURLToPath } from 'node:url';
10 +import { dirname, join } from 'node:path';
11 +
12 +const OPENAPI_URL = process.env.OPENAPI_SPEC_URL || 'https://backend.composio.dev/api/v3/openapi.json';
13 +
14 +// Endpoints to ignore (same as fern openapi-overrides.yml)
15 +const IGNORED_PATHS = [
16 + '/api/v3/mcp/validate/{uuid}',
17 + '/api/v3/cli/get-session',
18 + '/api/v3/cli/create-session',
19 + '/api/v3/auth/session/logout',
20 +];
21 +
22 +// Tags to ignore (internal/admin)
23 +const IGNORED_TAGS = [
24 + 'CLI',
25 + 'Admin',
26 + 'Profiling',
27 +];
28 +
29 +async function fetchAndFilterSpec() {
30 + console.log(`Fetching OpenAPI spec from ${OPENAPI_URL}...`);
31 +
32 + const response = await fetch(OPENAPI_URL);
33 + if (!response.ok) {
34 + throw new Error(`Failed to fetch: ${response.status}`);
35 + }
36 +
37 + const spec = await response.json();
38 +
39 + // Filter paths
40 + const filteredPaths = {};
41 + let removedCount = 0;
42 +
43 + for (const [path, methods] of Object.entries(spec.paths)) {
44 + // Skip ignored paths
45 + if (IGNORED_PATHS.includes(path)) {
46 + removedCount++;
47 + continue;
48 + }
49 +
50 + const filteredMethods = {};
51 +
52 + for (const [method, operation] of Object.entries(methods)) {
53 + // Skip if all tags are ignored
54 + const tags = operation.tags || [];
55 + const hasValidTag = tags.some(tag => !IGNORED_TAGS.includes(tag));
56 +
57 + if (!hasValidTag && tags.length > 0) {
58 + removedCount++;
59 + continue;
60 + }
61 +
62 + // Keep only the first tag to avoid duplicates in sidebar
63 + if (tags.length > 1) {
64 + operation.tags = [tags[0]];
65 + }
66 +
67 + filteredMethods[method] = operation;
68 + }
69 +
70 + if (Object.keys(filteredMethods).length > 0) {
71 + filteredPaths[path] = filteredMethods;
72 + }
73 + }
74 +
75 + spec.paths = filteredPaths;
76 +
77 + // Filter tags list
78 + if (spec.tags) {
79 + spec.tags = spec.tags.filter(tag => !IGNORED_TAGS.includes(tag.name));
80 + }
81 +
82 + console.log(`Removed ${removedCount} endpoints/operations`);
83 + console.log(`Final spec has ${Object.keys(filteredPaths).length} paths`);
84 +
85 + // Write to public directory for fumadocs to fetch
86 + const __dirname = dirname(fileURLToPath(import.meta.url));
87 + const outputPath = join(__dirname, '../public/openapi.json');
88 + writeFileSync(outputPath, JSON.stringify(spec, null, 2));
89 +
90 + console.log(`Written to ${outputPath}`);
91 +}
92 +
93 +fetchAndFilterSpec().catch(console.error);