Repository navigation
Conversation
Add the POST /v1/oauth/connections/custom_api example beside the API-key one, with the auth_method values and their companion fields, the test and update endpoints, and a warning that a connector's name is its identity within the organization: creating another with the same name updates the existing connector.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
kcmartin
requested changes
Oct 19, 2026
kcmartin
left a comment
kcmartin
left a comment
Collaborator
There was a problem hiding this comment.
I left some suggestions for wording clarity.
Another (optional) thing to consider is adding is a short curl example for testing a credential. Not a blocker though!
Co-authored-by: Kristin Martin <kcmartin@users.noreply.github.com>
Co-authored-by: Kristin Martin <kcmartin@users.noreply.github.com>
Co-authored-by: Kristin Martin <kcmartin@users.noreply.github.com>
Co-authored-by: Kristin Martin <kcmartin@users.noreply.github.com>
Co-authored-by: Kristin Martin <kcmartin@users.noreply.github.com>
Co-authored-by: Kristin Martin <kcmartin@users.noreply.github.com>
Contributor
Author
|
@kcmartin I accepted all your suggestions. They were great. Thanks for the review and help! |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
A design-partner customer provisioning custom API connectors programmatically could not find the
custom_apiendpoint or its field names in the public spec or the docs. The connectors page covered API-key and managed connectors but never showed how to create a Custom API connector.What
Adds a "Create a Custom API connector" section to
concepts/connectors.mdx, beside the existing API-key example:POST /v1/oauth/connections/custom_apicurl with every field name (name,base_api_url,access_tokenrequired;auth_method,auth_header_prefix,test_url,description,access_policyoptional)auth_methodvalues (header,url_path,query_param,custom_header) with each one's companion field and defaultnameis its identity within the organization, so creating another with the same name updates the existing connector/custom_api/testandPUT /custom_api/<id>endpointsCompanion change in sprites-api, which adds these endpoints to the generated OpenAPI reference: https://github.com/superfly/sprites-api/pull/1600.
api/openapi.jsonhere should be refreshed once that deploys.🤖 Generated with Claude Code