Immutable slug for this connector: lowercase letters, digits, _ and -, starting with a letter or digit, at most 48 characters. Unique within the workspace, where - and _ count as the same. Records pushed through /ingest become rows of the table custom_<source_name> in POST /v1/knowledge/query, with - written as _.
Key/value metadata applied to every event from this connector. String values only.
Show child attributes
Example:
{ "env": "staging", "pipeline": "acme-crm@v2" }
Response
Successful Response
Returned on creation. Auth for ingest is via platform API keys
(pk_live_…); call /v1/custom-connectors/{connector_id}/ingest… with
Authorization: Bearer pk_live_… to push data.
Table in POST /v1/knowledge/query holding one row per record pushed through /ingest, one column per top-level field. It appears after the next knowledge build.
Key/value metadata applied to every event from this connector. String values only. Per-item metadata on ingest overrides on key conflict.
Show child attributes
Example:
{ "env": "staging" }
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Adapter","colors":{"primary":"#8765F0","light":"#8765F0","dark":"#8765F0"},"logo":{"light":"https://mintcdn.com/adapter/J3Ydy4fSe61BUDTE/logo/light.svg?fit=max\u0026auto=format\u0026n=J3Ydy4fSe61BUDTE\u0026q=85\u0026s=459bd6410eb825d264414176cd7eba07","dark":"https://mintcdn.com/adapter/J3Ydy4fSe61BUDTE/logo/dark.svg?fit=max\u0026auto=format\u0026n=J3Ydy4fSe61BUDTE\u0026q=85\u0026s=0bed0f3d3311b99106ba98e43a63d5e2"},"favicon":"https://mintcdn.com/adapter/J3Ydy4fSe61BUDTE/favicon.svg?fit=max\u0026auto=format\u0026n=J3Ydy4fSe61BUDTE\u0026q=85\u0026s=83406b22c16edb6994e5b28b146a7446","api":{"openapi":"api-reference/openapi.json","playground":{}},"background":{"color":{"light":"#F2F2F0","dark":"#171717"}},"navbar":{"links":[{"href":"mailto:support@adapter.com","label":"Support"}],"primary":{"type":"button","label":"Sign In","href":"https://mind.adapter.com"}},"footer":{"socials":{"x":"https://x.com/adapter"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"adapter","hasAudioNarration":false,"actualSubdomain":"adapter","customDomains":["docs.beta.adapter.com"],"gitSource":{"type":"github","owner":"adapter-group","repo":"adapter-platform","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae23bb95db1d64f77da812c","collectionId":"3e863929-e534-43f8-bffd-cc13d5f5a900","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae23bb95db1d64f77da812c"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae23bb95db1d64f77da812c","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":40},{"language":"default","tag":"Documentation","count":13},{"language":"default","tag":"Knowledge","count":11},{"language":"default","tag":"Triggers","count":10},{"language":"default","tag":"Core Concepts","count":7},{"language":"default","tag":"Ingestion","count":6},{"language":"default","tag":"Custom Connectors","count":5},{"language":"default","tag":"Getting Started","count":4},{"language":"default","tag":"Connectors","count":3},{"language":"default","tag":"Data","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/custom-connectors/create-custom-connector","slug":"/api-reference/custom-connectors/create-custom-connector","pageMetadata":{"title":"Create a custom connector","openapi":"POST /v1/custom-connectors","description":"Create a new custom connector. The response includes the `connector_id`\nyou'll use in the `/v1/custom-connectors/{connector_id}/ingest…` paths.","href":"/api-reference/custom-connectors/create-custom-connector"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Create a new custom connector. The response includes the \", _jsx(_components.code, {\n children: \"connector_id\"\n }), \"\\nyou’ll use in the \", _jsx(_components.code, {\n children: \"/v1/custom-connectors/{connector_id}/ingest…\"\n }), \" paths.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a custom connector","openapi":"POST /v1/custom-connectors","description":"Create a new custom connector. The response includes the `connector_id`\nyou'll use in the `/v1/custom-connectors/{connector_id}/ingest…` paths.","href":"/api-reference/custom-connectors/create-custom-connector"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["custom-connectors"],"summary":"Create a custom connector","description":"Create a new custom connector. The response includes the `connector_id`\nyou'll use in the `/v1/custom-connectors/{connector_id}/ingest…` paths.","operationId":"create_custom_connector","requestBody":"c8843f5c-bf44-4a0f-9ca9-58984f55e57a","responses":{"200":"61d1fd2e-7a64-4a81-b09c-a29c6e3fc1ec","401":"5112038f-b22a-495c-a4f3-61afb5f49dbc","403":"49466402-219e-48f0-bc39-2e4c1ef3c2fd","409":"f0155820-49e0-476c-a1ee-85799716d015","422":"dd70bfad-19a0-410f-a073-ec5ab2948055","500":"ee026546-bd04-4c6a-a526-1e80d34b4a52"},"method":"post","type":"path","servers":["b45a6dfc-eec4-42ae-a72a-9361a1098054"],"security":[],"path":"/v1/custom-connectors","baseUrlOptions":["http://localhost:8080"],"title":"Create a custom connector","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"source_name":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$","title":"Source Name","description":"Immutable slug for this connector: lowercase letters, digits, `_` and `-`, starting with a letter or digit, at most 48 characters. Unique within the workspace, where `-` and `_` count as the same. Records pushed through `/ingest` become rows of the table `custom_\u003csource_name>` in `POST /v1/knowledge/query`, with `-` written as `_`.","examples":["acme-crm"],"isRequired":true,"uniqueKey":"source_name","typeLabel":"string"},"accepted_kinds":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"accepted_kinds.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Accepted Kinds","description":"Kinds this connector may emit: first-party kinds and/or evidence types. Empty/None = all allowed.","uniqueKey":"accepted_kinds.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Accepted Kinds","description":"Kinds this connector may emit: first-party kinds and/or evidence types. Empty/None = all allowed.","uniqueKey":"accepted_kinds.oneOf.1","typeLabel":"null"}],"uniqueKey":"accepted_kinds","typeLabel":"string[] | null"},"metadata":{"oneOf":[{"type":"object","title":"Metadata","description":"Key/value metadata applied to every event from this connector. String values only.","example":{"env":"staging","pipeline":"acme-crm@v2"},"additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.0","typeLabel":"Metadata · object"},{"type":"null","title":"Metadata","description":"Key/value metadata applied to every event from this connector. String values only.","example":{"env":"staging","pipeline":"acme-crm@v2"},"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"Metadata · object | null"}},"type":"object","required":["name","source_name"],"title":"CreateClientRequest","uniqueKey":"","typeLabel":"CreateClientRequest · object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","source_name":"acme-crm","accepted_kinds":["\u003cstring>"],"metadata":{"env":"staging","pipeline":"acme-crm@v2"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"61d1fd2e-7a64-4a81-b09c-a29c6e3fc1ec":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"connector_id":{"type":"string","title":"Connector Id","description":"Unique identifier for the connector.","examples":["c0ffee01-1234-5678-90ab-cdef01234567"],"isRequired":true,"uniqueKey":"connector_id","typeLabel":"string"},"name":{"type":"string","title":"Name","description":"Human display name.","examples":["Acme CRM"],"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"source_name":{"type":"string","title":"Source Name","description":"Immutable slug used in the event source (`custom:\u003csource_name>`).","examples":["acme-crm"],"isRequired":true,"uniqueKey":"source_name","typeLabel":"string"},"created_at":{"type":"string","title":"Created At","description":"ISO 8601 creation timestamp.","isRequired":true,"uniqueKey":"created_at","typeLabel":"string"},"created_by":{"properties":{"type":{"type":"string","enum":["user","api_key"],"title":"Type","description":"Principal type that created the resource.","examples":["user"],"isRequired":true,"uniqueKey":"created_by.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","title":"Id","description":"user_id for user callers, key_id for API key callers.","examples":["u_01abc123"],"isRequired":true,"uniqueKey":"created_by.id","typeLabel":"string"}},"type":"object","required":["type","id"],"title":"CreatedBy","description":"Principal that created a resource. `id` is a user_id for `type=\"user\"`\nand a key_id (UUID) for `type=\"api_key\"`.","isRequired":true,"uniqueKey":"created_by","typeLabel":"CreatedBy · object"},"is_active":{"type":"boolean","title":"Is Active","description":"False once the connector has been deactivated.","isRequired":true,"uniqueKey":"is_active","typeLabel":"boolean"},"table_name":{"type":"string","title":"Table Name","description":"Table in `POST /v1/knowledge/query` holding one row per record pushed through `/ingest`, one column per top-level field. It appears after the next knowledge build.","examples":["custom_acme_crm"],"isRequired":true,"uniqueKey":"table_name","typeLabel":"string"},"accepted_kinds":{"items":{"type":"string","uniqueKey":"accepted_kinds.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Accepted Kinds","description":"Kinds this connector may emit: first-party kinds and/or evidence types. Empty = all allowed.","examples":[["email","page"]],"uniqueKey":"accepted_kinds","typeLabel":"string[]"},"metadata":{"oneOf":[{"type":"object","title":"Metadata","description":"Key/value metadata applied to every event from this connector. String values only. Per-item `metadata` on ingest overrides on key conflict.","example":{"env":"staging"},"additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.0","typeLabel":"Metadata · object"},{"type":"null","title":"Metadata","description":"Key/value metadata applied to every event from this connector. String values only. Per-item `metadata` on ingest overrides on key conflict.","example":{"env":"staging"},"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"Metadata · object | null"}},"type":"object","required":["connector_id","name","source_name","created_at","created_by","is_active","table_name"],"title":"CustomConnectorCreateResponse","description":"Returned on creation. Auth for ingest is via platform API keys\n(`pk_live_…`); call `/v1/custom-connectors/{connector_id}/ingest…` with\n`Authorization: Bearer pk_live_…` to push data.","uniqueKey":"","typeLabel":"CustomConnectorCreateResponse · object"},"examples":{"Example":{"title":"Example","value":{"connector_id":"c0ffee01-1234-5678-90ab-cdef01234567","name":"Acme CRM","source_name":"acme-crm","created_at":"\u003cstring>","created_by":{"type":"user","id":"u_01abc123"},"is_active":true,"table_name":"custom_acme_crm","accepted_kinds":["email","page"],"metadata":{"env":"staging"}}}},"exampleType":"generated"}},"exampleType":"generated"},"5112038f-b22a-495c-a4f3-61afb5f49dbc":{"content":{"application/json":{"schema":{"properties":{"error_code":{"type":"string","const":"authentication_error","title":"Error Code","default":"authentication_error","uniqueKey":"error_code","typeLabel":"string"},"message":{"type":"string","title":"Message","default":"Invalid or missing credentials.","uniqueKey":"message","typeLabel":"string"},"details":{"oneOf":[{"type":"object","title":"Details","additionalProperties":true,"uniqueKey":"details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object | null"}},"type":"object","title":"AuthenticationErrorModel","uniqueKey":"","typeLabel":"AuthenticationErrorModel · object"},"examples":{"Example":{"title":"Example","value":{"error_code":"authentication_error","message":"Invalid or missing credentials.","details":{}}}},"exampleType":"generated"}},"description":"Unauthorized","exampleType":"generated"},"49466402-219e-48f0-bc39-2e4c1ef3c2fd":{"content":{"application/json":{"schema":{"properties":{"error_code":{"type":"string","const":"permission_denied","title":"Error Code","default":"permission_denied","uniqueKey":"error_code","typeLabel":"string"},"message":{"type":"string","title":"Message","default":"You do not have permission to perform this action.","uniqueKey":"message","typeLabel":"string"},"details":{"oneOf":[{"type":"object","title":"Details","additionalProperties":true,"uniqueKey":"details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object | null"}},"type":"object","title":"PermissionDeniedErrorModel","uniqueKey":"","typeLabel":"PermissionDeniedErrorModel · object"},"examples":{"Example":{"title":"Example","value":{"error_code":"permission_denied","message":"You do not have permission to perform this action.","details":{}}}},"exampleType":"generated"}},"description":"Forbidden","exampleType":"generated"},"f0155820-49e0-476c-a1ee-85799716d015":{"description":"The source name is already in use in this workspace, which retrying won't change; or the workspace's data is being reset (`details.reason`: `data_reset_in_progress`); retry once the reset has finished.","content":{"application/json":{"schema":{"properties":{"message":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error_code":{"type":"string","const":"conflict","title":"Error Code","default":"conflict","uniqueKey":"error_code","typeLabel":"string"},"details":{"oneOf":[{"type":"object","title":"Details","additionalProperties":true,"uniqueKey":"details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object | null"}},"type":"object","required":["message"],"title":"ConflictErrorModel","uniqueKey":"","typeLabel":"ConflictErrorModel · object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error_code":"conflict","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"dd70bfad-19a0-410f-a073-ec5ab2948055":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"ee026546-bd04-4c6a-a526-1e80d34b4a52":{"content":{"application/json":{"schema":{"properties":{"error_code":{"type":"string","const":"internal_server_error","title":"Error Code","default":"internal_server_error","uniqueKey":"error_code","typeLabel":"string"},"message":{"type":"string","title":"Message","default":"An unexpected error occurred.","uniqueKey":"message","typeLabel":"string"},"details":{"oneOf":[{"type":"object","title":"Details","additionalProperties":true,"uniqueKey":"details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object | null"}},"type":"object","title":"InternalServerErrorModel","uniqueKey":"","typeLabel":"InternalServerErrorModel · object"},"examples":{"Example":{"title":"Example","value":{"error_code":"internal_server_error","message":"An unexpected error occurred.","details":{}}}},"exampleType":"generated"}},"description":"Internal Server Error","exampleType":"generated"}},"security":{},"servers":{"b45a6dfc-eec4-42ae-a72a-9361a1098054":{"url":"http://localhost:8080"}}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"adapter","siteName":"Adapter","title":"Create a custom connector - Adapter","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-31T21:45:06.733Z","originalFileLocation":"api-reference/custom-connectors/create-custom-connector.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a new custom connector. The response includes the connector_id you\u0026#x27;ll use in the /v1/custom-connectors/{connector_id}/ingest… paths.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Adapter\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a custom connector - Adapter\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new custom connector. The response includes the connector_id you\u0026#x27;ll use in the /v1/custom-connectors/{connector_id}/ingest… paths.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Adapter\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.beta.adapter.com/api-reference/custom-connectors/create-custom-connector\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://adapter.mintlify.app/_mintlify/api/og/v2?division=Custom+Connectors\u0026amp;title=Create+a+custom+connector\u0026amp;description=Create+a+new+custom+connector.+The+response+includes+the+%60connector_id%60%0Ayou%27ll+use+in+the+%60%2Fv1%2Fcustom-connectors%2F%7Bconnector_id%7D%2Fingest%E2%80%A6%60+paths.\u0026amp;theme=172df802757f1536c21dc595\u0026amp;signature=a07f47ff27a100cf185856c9d54d2f08325e9798bc8518333b4b65dc6a31b70e\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a custom connector - Adapter\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new custom connector. The response includes the connector_id you\u0026#x27;ll use in the /v1/custom-connectors/{connector_id}/ingest… paths.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://adapter.mintlify.app/_mintlify/api/og/v2?division=Custom+Connectors\u0026amp;title=Create+a+custom+connector\u0026amp;description=Create+a+new+custom+connector.+The+response+includes+the+%60connector_id%60%0Ayou%27ll+use+in+the+%60%2Fv1%2Fcustom-connectors%2F%7Bconnector_id%7D%2Fingest%E2%80%A6%60+paths.\u0026amp;theme=172df802757f1536c21dc595\u0026amp;signature=a07f47ff27a100cf185856c9d54d2f08325e9798bc8518333b4b65dc6a31b70e\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Adapter\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8765F0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.beta.adapter.com/api-reference/custom-connectors/create-custom-connector\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/custom-connectors/create-custom-connector.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.beta.adapter.com/#organization\",\"name\":\"Adapter\",\"url\":\"https://docs.beta.adapter.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/adapter/J3Ydy4fSe61BUDTE/logo/light.svg?fit=max\u0026auto=format\u0026n=J3Ydy4fSe61BUDTE\u0026q=85\u0026s=459bd6410eb825d264414176cd7eba07\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.beta.adapter.com#website\",\"name\":\"Adapter\",\"url\":\"https://docs.beta.adapter.com\",\"publisher\":{\"@id\":\"https://docs.beta.adapter.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.beta.adapter.com/api-reference/custom-connectors/create-custom-connector#webpage\",\"url\":\"https://docs.beta.adapter.com/api-reference/custom-connectors/create-custom-connector\",\"name\":\"Create a custom connector\",\"description\":\"Create a new custom connector. The response includes the connector_id you'll use in the /v1/custom-connectors/{connector_id}/ingest… paths.\",\"dateModified\":\"2026-05-31T21:45:06.733Z\",\"isPartOf\":{\"@id\":\"https://docs.beta.adapter.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.beta.adapter.com/api-reference/custom-connectors/create-custom-connector#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.beta.adapter.com/api-reference/custom-connectors/create-custom-connector#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Custom Connectors\",\"item\":\"https://docs.beta.adapter.com/api-reference/custom-connectors/list-custom-connectors\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a custom connector\",\"item\":\"https://docs.beta.adapter.com/api-reference/custom-connectors/create-custom-connector\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.beta.adapter.com/api-reference/custom-connectors/create-custom-connector#apireference\",\"headline\":\"Create a custom connector\",\"name\":\"Create a custom connector\",\"description\":\"Create a new custom connector. The response includes the connector_id you'll use in the /v1/custom-connectors/{connector_id}/ingest… paths.\",\"url\":\"https://docs.beta.adapter.com/api-reference/custom-connectors/create-custom-connector\",\"mainEntityOfPage\":{\"@id\":\"https://docs.beta.adapter.com/api-reference/custom-connectors/create-custom-connector#webpage\"},\"dateModified\":\"2026-05-31T21:45:06.733Z\",\"publisher\":{\"@id\":\"https://docs.beta.adapter.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.beta.adapter.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Adapter\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Adapter","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/getting-started/introduction"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/getting-started/mcp"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Overview","href":"/api-reference/introduction"}]},{"group":"Connectors","expanded":false,"pages":[{"title":"List Connections","openapi":"GET /v1/connections","href":"/api-reference/connectors/list-connections"},{"title":"Get Connection","openapi":"GET /v1/connections/{connection_id}","href":"/api-reference/connectors/get-connection"},{"title":"List Resource Facets","openapi":"GET /v1/connections/{connection_id}/resources/{resource}/facets/{facet_name}","href":"/api-reference/connectors/list-resource-facets"}]},{"group":"Custom Connectors","expanded":false,"pages":[{"title":"List custom connectors","openapi":"GET /v1/custom-connectors","description":"List custom connectors for the calling workspace. Set `include_inactive=true`\nto include deactivated connectors.","href":"/api-reference/custom-connectors/list-custom-connectors"},{"title":"Create a custom connector","openapi":"POST /v1/custom-connectors","href":"/api-reference/custom-connectors/create-custom-connector"},{"title":"Get a custom connector","openapi":"GET /v1/custom-connectors/{connector_id}","description":"Fetch a single connector by ID.","href":"/api-reference/custom-connectors/get-custom-connector"},{"title":"Update a custom connector","openapi":"PATCH /v1/custom-connectors/{connector_id}","href":"/api-reference/custom-connectors/update-custom-connector"},{"title":"Deactivate a custom connector","openapi":"DELETE /v1/custom-connectors/{connector_id}","href":"/api-reference/custom-connectors/delete-custom-connector"}]},{"group":"Data","expanded":false,"pages":[{"title":"Download Document Raw","openapi":"GET /v1/data/{connection_id}/{resource}/raw/{external_id}","href":"/api-reference/data/download-document-raw"},{"title":"Get Document Detail","openapi":"GET /v1/data/{connection_id}/{resource}/{external_id}","href":"/api-reference/data/get-document-detail"}]},{"group":"Documents","expanded":false,"pages":[{"title":"Get Document By Urn","openapi":"GET /v1/documents/{urn}","href":"/api-reference/documents/get-document-by-urn"},{"title":"Download Document By Urn","openapi":"GET /v1/documents/{urn}/raw","href":"/api-reference/documents/download-document-by-urn"}]},{"group":"Ingestion","expanded":false,"pages":[{"title":"Ingest generic JSON events","openapi":"POST /v1/custom-connectors/{connector_id}/ingest","href":"/api-reference/ingestion/ingest-custom"},{"title":"Upload a binary as a generic event","openapi":"POST /v1/custom-connectors/{connector_id}/ingest/upload","href":"/api-reference/ingestion/ingest-custom-upload"},{"title":"Start a presigned video upload","openapi":"POST /v1/custom-connectors/{connector_id}/ingest/video/upload-url","href":"/api-reference/ingestion/ingest-video-upload-url"},{"title":"Finalize a presigned video upload","openapi":"POST /v1/custom-connectors/{connector_id}/ingest/video/complete","href":"/api-reference/ingestion/ingest-video-complete"},{"title":"Ingest typed first-party events","openapi":"POST /v1/custom-connectors/{connector_id}/ingest/typed","href":"/api-reference/ingestion/ingest-typed"},{"title":"Upload a binary as a typed event","openapi":"POST /v1/custom-connectors/{connector_id}/ingest/typed/upload","href":"/api-reference/ingestion/ingest-typed-upload"}]},{"group":"Knowledge","expanded":false,"pages":[{"title":"Search","openapi":"POST /v1/knowledge/search","href":"/api-reference/knowledge/search"},{"title":"Ask","openapi":"POST /v1/knowledge/ask","href":"/api-reference/knowledge/ask"},{"title":"Ask Stream","openapi":"POST /v1/knowledge/ask/stream","href":"/api-reference/knowledge/ask-stream"},{"title":"List Ask Jobs","openapi":"GET /v1/knowledge/ask/jobs","href":"/api-reference/knowledge/list-ask-jobs"},{"title":"Create Ask Job","openapi":"POST /v1/knowledge/ask/jobs","href":"/api-reference/knowledge/create-ask-job"},{"title":"Get Ask Job","openapi":"GET /v1/knowledge/ask/jobs/{job_id}","href":"/api-reference/knowledge/get-ask-job"},{"title":"Get Entity","openapi":"GET /v1/knowledge/entities/{entity_id}","href":"/api-reference/knowledge/get-entity"},{"title":"Refresh Context","openapi":"POST /v1/knowledge/refresh","href":"/api-reference/knowledge/refresh-context"},{"title":"Context Status","openapi":"GET /v1/knowledge/status","href":"/api-reference/knowledge/context-status"},{"title":"Get Knowledge Settings","openapi":"GET /v1/knowledge/settings","href":"/api-reference/knowledge/get-knowledge-settings"},{"title":"Update Knowledge Settings","openapi":"PATCH /v1/knowledge/settings","href":"/api-reference/knowledge/update-knowledge-settings"}]},{"group":"Triggers","expanded":false,"pages":[{"title":"List triggers","openapi":"GET /v1/triggers","href":"/api-reference/Triggers/list-triggers"},{"title":"Create trigger","openapi":"POST /v1/triggers","href":"/api-reference/Triggers/create-trigger"},{"title":"List trigger registry","openapi":"GET /v1/triggers/kinds","href":"/api-reference/Triggers/list-trigger-kinds"},{"title":"Get delivery counts","openapi":"GET /v1/triggers/deliveries/summary","href":"/api-reference/Triggers/get-trigger-delivery-summary"},{"title":"Get trigger details","openapi":"GET /v1/triggers/{trigger_id}","href":"/api-reference/Triggers/get-trigger"},{"title":"Update trigger","openapi":"PATCH /v1/triggers/{trigger_id}","href":"/api-reference/Triggers/update-trigger"},{"title":"Delete trigger","openapi":"DELETE /v1/triggers/{trigger_id}","href":"/api-reference/Triggers/delete-trigger"},{"title":"List deliveries","openapi":"GET /v1/triggers/{trigger_id}/deliveries","href":"/api-reference/Triggers/list-trigger-deliveries"}]},{"group":"Writeback","expanded":false,"pages":[{"title":"Write agent output back into the workspace","openapi":"POST /v1/writeback","href":"/api-reference/writeback/write-back"},{"title":"Recently written-back items","openapi":"GET /v1/writeback/recent","href":"/api-reference/writeback/recent-writebacks"}]}]}]},"basePath":"","title":"Create a custom connector - Adapter","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}