integrations

Create Instance From Manifest

CONNECT-A-CAPABILITY FLOW step 1 (REST/Pipedream variant): define the integration here, then install it for the current identity with integration_install. Add a new REST 'connected tool' owned by the calling identity, built from a Pipedream component's source on github.com/PipedreamHQ/pipedream (pass component_path as the directory name under components/, e.g. 'perplexity' for components/perplexity/). Unlike integration_create_from_openapi, this parses hand-written JavaScript rather than a declarative spec, so it ONLY converts actions in one narrow, verified shape: a plain string _baseUrl(), a Bearer this.$auth.<field> auth template, and a flat (no conditional/computed) request body. Actions outside that shape are skipped, never guessed at - the response's skipped_actions lists every one with its reason, so tool_count can legitimately be less than the component's total action count, or even zero (a clear error, not a silent empty registration). connection_mode is required, no default: pass 'shared' or 'per_caller'. For a secured manifest (bearer or API-key auth) with no secret available yet, pass allow_unconnected=True to create the row unauthenticated -- the auth scheme is still recorded and the installer supplies their own credential at connect time.

post/api/integrations/instances/from-manifest

Request

  • Base URL: https://app.thinqos.com (the document declares no server; this is the origin it was published from)
  • URL: https://app.thinqos.com/api/integrations/instances/from-manifest
  • Auth: none declared

Headers

x-impersonate-identity-idstring nullable

Request body

namestring required
manifestobject required
connection_mode'shared' | 'per_caller' required
descriptionstring nullable
plaintext_secretstring nullable
auth_secret_refstring nullable
secret_refsobject
secret_valuesobject
credential_fit_override_reasonstring nullable
allow_unconnectedboolean

Response

Successful Response

idstring uuid required
definition_idstring uuid required
definition_slugstring nullable
account_capture_source'gmail' | 'google-calendar' nullable
library_idstring uuid nullable
library_namestring nullable
my_rolestring nullable
connection_mode'shared' | 'per_caller' required
aliasstring required
namestring required
transport'http' | 'sse' | 'stdio_bridge' | 'rest' required
base_urlstring required
display_icon_urlstring nullable
display_icon_is_inferredboolean
auth_kind'none' | 'bearer' | 'api_key_header' | 'oauth2' | 'gcp_oidc' | 'gcp_service_account' | 'github_app' required
auth_header_namestring nullable required
auth_secret_refstring nullable
descriptionstring nullable required
trustedboolean required
enabledboolean required
health_check_toolstring nullable required
health_check_argumentsobject
health_check_declinedboolean
health_check_decline_reasonstring nullable
refresh_secondsinteger required
rate_limit_per_minuteinteger nullable required
request_max_bytesinteger required
response_max_bytesinteger required
talkableboolean
stdio_commandstring nullable
stdio_envobject
rest_manifestobject nullable
rest_openapi_source_urlstring nullable
icon_urlstring nullable
icon_data_urlstring nullable
secret_refsobject
config_versioninteger nullable
tool_overridesobject
installed_template_versioninteger nullable
latest_template_versioninteger nullable
template_update_availableboolean
published_as_templateboolean
published_template_versioninteger nullable
published_template_visibilitystring nullable
oauth_resource_urlstring nullable
oauth_authorization_urlstring nullable
oauth_token_urlstring nullable
oauth_client_idstring nullable
oauth_scopesstring nullable
oauth_pkce_enabledboolean
oauth_client_secret_setboolean
oauth_requires_manual_clientboolean
oauth_token_expires_atstring date-time nullable
oauth_connectedboolean
oauth_granted_scopesstring nullable
oauth_principalobject nullable
account_identifiableboolean nullable
permissions_summarystring nullable
provider_namestring nullable
provider_consent_urlstring nullable
sign_in_notestring nullable
owned_by_viewerboolean nullable
org_naming_mismatch_warningstring nullable
credential_connectedboolean
credential_status'connected' | 'needs_reconnect' | 'admin_repair' | 'unreachable' | 'missing'
viewer_removal'self' | 'other' nullable
credential_last_auth_errorstring nullable
credential_failure_codestring nullable
access_naturestring nullable
reauth_classstring nullable
server_namestring nullable
server_versionstring nullable
protocol_versionstring nullable
server_capabilitiesobject nullable
server_instructionsstring nullable
last_test_successboolean nullable
last_test_tool_countinteger nullable
last_test_errorstring nullable
last_test_duration_msinteger nullable
last_test_atstring date-time nullable
credential_fit_warningstring nullable

Changes

No recorded changes to this operation across all 3 revisions of this API.