Smithery

tools.execute.proxy.create

Proxy an HTTP request to a third-party API using connected account credentials. This endpoint allows making authenticated API calls to external services while abstracting away authentication details.

Remote smithery/composio

Other tools also called tools.execute.proxy.create? See providers with this name

Input Schema


            {
  "type": "object",
  "properties": {
    "body": {
      "example": {
        "name": "New Resource",
        "description": "This is a new resource"
      },
      "nullable": true,
      "description": "The request body (for POST, PUT, and PATCH requests)"
    },
    "method": {
      "enum": [
        "GET",
        "POST",
        "PUT",
        "DELETE",
        "PATCH",
        "HEAD"
      ],
      "type": "string",
      "example": "GET",
      "description": "The HTTP method to use for the request"
    },
    "endpoint": {
      "type": "string",
      "example": "/api/v1/resources",
      "description": "The API endpoint to call (absolute URL or path relative to base URL of the connected account)"
    },
    "parameters": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name",
          "value",
          "type"
        ],
        "properties": {
          "name": {
            "type": "string",
            "example": "x-api-key",
            "description": "Parameter name"
          },
          "type": {
            "enum": [
              "header",
              "query"
            ],
            "type": "string",
            "example": "header",
            "description": "Parameter type (header or query)"
          },
          "value": {
            "type": "string",
            "example": "abc123def456",
            "description": "Parameter value"
          }
        }
      },
      "example": [
        {
          "name": "x-api-key",
          "type": "header",
          "value": "abc123def456"
        },
        {
          "name": "filter",
          "type": "query",
          "value": "active"
        }
      ],
      "description": "Additional HTTP headers or query parameters to include in the request"
    },
    "binary_body": {
      "anyOf": [
        {
          "type": "object",
          "required": [
            "url"
          ],
          "properties": {
            "url": {
              "type": "string",
              "format": "uri",
              "description": "URL to fetch binary content from"
            },
            "content_type": {
              "type": "string",
              "description": "Content-Type header to use for the request"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "base64"
          ],
          "properties": {
            "base64": {
              "type": "string",
              "minLength": 1,
              "description": "Base64-encoded binary data"
            },
            "content_type": {
              "type": "string",
              "description": "Content-Type header to use for the request"
            }
          }
        }
      ],
      "description": "Binary body to send. For binary upload via URL: use {url: \"https://...\", content_type?: \"...\"}. For binary upload via base64: use {base64: \"...\", content_type?: \"...\"}."
    },
    "connected_account_id": {
      "type": "string",
      "format": "connectedAccountId",
      "example": "ca_1a2b3c4d5e6f",
      "description": "The ID of the connected account to use for authentication (if not provided, will use the default account for the project)"
    },
    "custom_connection_data": {
      "oneOf": [
        {
          "type": "object",
          "required": [
            "authScheme",
            "toolkitSlug",
            "val"
          ],
          "properties": {
            "val": {
              "type": "object",
              "required": [
                "access_token"
              ],
              "properties": {
                "dc": {
                  "type": "string"
                },
                "shop": {
                  "type": "string"
                },
                "scope": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    {
                      "nullable": true
                    }
                  ]
                },
                "domain": {
                  "type": "string"
                },
                "region": {
                  "type": "string"
                },
                "api_url": {
                  "type": "string"
                },
                "version": {
                  "type": "string"
                },
                "base_url": {
                  "type": "string"
                },
                "id_token": {
                  "type": "string"
                },
                "extension": {
                  "type": "string"
                },
                "site_name": {
                  "type": "string"
                },
                "subdomain": {
                  "type": "string"
                },
                "account_id": {
                  "type": "string"
                },
                "expires_in": {
                  "anyOf": [
                    {
                      "type": "number"
                    },
                    {
                      "type": "string"
                    },
                    {
                      "nullable": true
                    }
                  ]
                },
                "token_type": {
                  "type": "string"
                },
                "account_url": {
                  "type": "string"
                },
                "authed_user": {
                  "type": "object",
                  "properties": {
                    "scope": {
                      "type": "string"
                    },
                    "access_token": {
                      "type": "string"
                    }
                  },
                  "description": "for slack user scopes"
                },
                "your-domain": {
                  "type": "string"
                },
                "your_server": {
                  "type": "string"
                },
                "access_token": {
                  "type": "string"
                },
                "instanceName": {
                  "type": "string"
                },
                "state_prefix": {
                  "type": "string",
                  "maxLength": 40,
                  "description": "The oauth2 state prefix for the connection"
                },
                "COMPANYDOMAIN": {
                  "type": "string"
                },
                "refresh_token": {
                  "type": "string",
                  "nullable": true
                },
                "proxy_password": {
                  "type": "string"
                },
                "proxy_username": {
                  "type": "string"
                },
                "server_location": {
                  "type": "string"
                },
                "extra_token_data": {
                  "type": "object",
                  "additionalProperties": {
                    "nullable": true
                  }
                },
                "instanceEndpoint": {
                  "type": "string"
                },
                "form_api_base_url": {
                  "type": "string"
                },
                "long_redirect_url": {
                  "type": "boolean",
                  "description": "Whether to return the redirect url without shortening"
                },
                "webhook_signature": {
                  "type": "string"
                },
                "borneo_dashboard_url": {
                  "type": "string"
                }
              },
              "additionalProperties": {
                "nullable": true
              }
            },
            "authScheme": {
              "enum": [
                "OAUTH2"
              ],
              "type": "string"
            },
            "toolkitSlug": {
              "type": "string"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "authScheme",
            "toolkitSlug",
            "val"
          ],
          "properties": {
            "val": {
              "type": "object",
              "required": [
                "client_id",
                "access_token"
              ],
              "properties": {
                "dc": {
                  "type": "string"
                },
                "shop": {
                  "type": "string"
                },
                "scope": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    {
                      "nullable": true
                    }
                  ]
                },
                "domain": {
                  "type": "string"
                },
                "region": {
                  "type": "string"
                },
                "api_url": {
                  "type": "string"
                },
                "version": {
                  "type": "string"
                },
                "base_url": {
                  "type": "string"
                },
                "id_token": {
                  "type": "string"
                },
                "client_id": {
                  "type": "string",
                  "description": "Dynamically registered client ID"
                },
                "extension": {
                  "type": "string"
                },
                "site_name": {
                  "type": "string"
                },
                "subdomain": {
                  "type": "string"
                },
                "account_id": {
                  "type": "string"
                },
                "expires_in": {
                  "anyOf": [
                    {
                      "type": "number"
                    },
                    {
                      "type": "string"
                    },
                    {
                      "nullable": true
                    }
                  ]
                },
                "token_type": {
                  "type": "string"
                },
                "account_url": {
                  "type": "string"
                },
                "your-domain": {
                  "type": "string"
                },
                "your_server": {
                  "type": "string"
                },
                "access_token": {
                  "type": "string"
                },
                "instanceName": {
                  "type": "string"
                },
                "state_prefix": {
                  "type": "string",
                  "maxLength": 40,
                  "description": "The oauth2 state prefix for the connection"
                },
                "COMPANYDOMAIN": {
                  "type": "string"
                },
                "client_secret": {
                  "type": "string",
                  "description": "Dynamically registered client secret"
                },
                "refresh_token": {
                  "type": "string",
                  "nullable": true
                },
                "proxy_password": {
                  "type": "string"
                },
                "proxy_username": {
                  "type": "string"
                },
                "server_location": {
                  "type": "string"
                },
                "instanceEndpoint": {
                  "type": "string"
                },
                "form_api_base_url": {
                  "type": "string"
                },
                "long_redirect_url": {
                  "type": "boolean",
                  "description": "Whether to return the redirect url without shortening"
                },
                "client_id_issued_at": {
                  "type": "number"
                },
                "borneo_dashboard_url": {
                  "type": "string"
                },
                "client_secret_expires_at": {
                  "type": "number"
                }
              },
              "additionalProperties": {
                "nullable": true
              }
            },
            "authScheme": {
              "enum": [
                "DCR_OAUTH"
              ],
              "type": "string"
            },
            "toolkitSlug": {
              "type": "string"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "authScheme",
            "toolkitSlug",
            "val"
          ],
          "properties": {
            "val": {
              "type": "object",
              "properties": {
                "dc": {
                  "type": "string"
                },
                "shop": {
                  "type": "string"
                },
                "domain": {
                  "type": "string"
                },
                "region": {
                  "type": "string"
                },
                "api_key": {
                  "type": "string"
                },
                "api_url": {
                  "type": "string"
                },
                "version": {
                  "type": "string"
                },
                "base_url": {
                  "type": "string"
                },
                "extension": {
                  "type": "string"
                },
                "site_name": {
                  "type": "string"
                },
                "subdomain": {
                  "type": "string"
                },
                "account_id": {
                  "type": "string"
                },
                "account_url": {
                  "type": "string"
                },
                "your-domain": {
                  "type": "string"
                },
                "your_server": {
                  "type": "string"
                },
                "bearer_token": {
                  "type": "string"
                },
                "instanceName": {
                  "type": "string"
                },
                "COMPANYDOMAIN": {
                  "type": "string"
                },
                "basic_encoded": {
                  "type": "string"
                },
                "proxy_password": {
                  "type": "string"
                },
                "proxy_username": {
                  "type": "string"
                },
                "generic_api_key": {
                  "type": "string"
                },
                "server_location": {
                  "type": "string"
                },
                "instanceEndpoint": {
                  "type": "string"
                },
                "form_api_base_url": {
                  "type": "string"
                },
                "borneo_dashboard_url": {
                  "type": "string"
                }
              },
              "additionalProperties": {
                "nullable": true
              }
            },
            "authScheme": {
              "enum": [
                "API_KEY"
              ],
              "type": "string"
            },
            "toolkitSlug": {
              "type": "string"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "authScheme",
            "toolkitSlug",
            "val"
          ],
          "properties": {
            "val": {
              "type": "object",
              "required": [
                "username",
                "password"
              ],
              "properties": {
                "dc": {
                  "type": "string"
                },
                "shop": {
                  "type": "string"
                },
                "domain": {
                  "type": "string"
                },
                "region": {
                  "type": "string"
                },
                "api_url": {
                  "type": "string"
                },
                "version": {
                  "type": "string"
                },
                "base_url": {
                  "type": "string"
                },
                "password": {
                  "type": "string"
                },
                "username": {
                  "type": "string"
                },
                "extension": {
                  "type": "string"
                },
                "site_name": {
                  "type": "string"
                },
                "subdomain": {
                  "type": "string"
                },
                "account_id": {
                  "type": "string"
                },
                "account_url": {
                  "type": "string"
                },
                "your-domain": {
                  "type": "string"
                },
                "your_server": {
                  "type": "string"
                },
                "instanceName": {
                  "type": "string"
                },
                "COMPANYDOMAIN": {
                  "type": "string"
                },
                "proxy_password": {
                  "type": "string"
                },
                "proxy_username": {
                  "type": "string"
                },
                "server_location": {
                  "type": "string"
                },
                "instanceEndpoint": {
                  "type": "string"
                },
                "form_api_base_url": {
                  "type": "string"
                },
                "borneo_dashboard_url": {
                  "type": "string"
                }
              },
              "additionalProperties": {
                "nullable": true
              }
            },
            "authScheme": {
              "enum": [
                "BASIC_WITH_JWT"
              ],
              "type": "string"
            },
            "toolkitSlug": {
              "type": "string"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "authScheme",
            "toolkitSlug",
            "val"
          ],
          "properties": {
            "val": {
              "type": "object",
              "required": [
                "username"
              ],
              "properties": {
                "dc": {
                  "type": "string"
                },
                "shop": {
                  "type": "string"
                },
                "domain": {
                  "type": "string"
                },
                "region": {
                  "type": "string"
                },
                "api_url": {
                  "type": "string"
                },
                "version": {
                  "type": "string"
                },
                "base_url": {
                  "type": "string"
                },
                "password": {
                  "type": "string"
                },
                "username": {
                  "type": "string"
                },
                "extension": {
                  "type": "string"
                },
                "site_name": {
                  "type": "string"
                },
                "subdomain": {
                  "type": "string"
                },
                "account_id": {
                  "type": "string"
                },
                "account_url": {
                  "type": "string"
                },
                "your-domain": {
                  "type": "string"
                },
                "your_server": {
                  "type": "string"
                },
                "instanceName": {
                  "type": "string"
                },
                "COMPANYDOMAIN": {
                  "type": "string"
                },
                "proxy_password": {
                  "type": "string"
                },
                "proxy_username": {
                  "type": "string"
                },
                "server_location": {
                  "type": "string"
                },
                "instanceEndpoint": {
                  "type": "string"
                },
                "form_api_base_url": {
                  "type": "string"
                },
                "borneo_dashboard_url": {
                  "type": "string"
                }
              },
              "additionalProperties": {
                "nullable": true
              }
            },
            "authScheme": {
              "enum": [
                "BASIC"
              ],
              "type": "string"
            },
            "toolkitSlug": {
              "type": "string"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "authScheme",
            "toolkitSlug",
            "val"
          ],
          "properties": {
            "val": {
              "type": "object",
              "required": [
                "token"
              ],
              "properties": {
                "dc": {
                  "type": "string"
                },
                "shop": {
                  "type": "string"
                },
                "token": {
                  "type": "string"
                },
                "domain": {
                  "type": "string"
                },
                "region": {
                  "type": "string"
                },
                "api_url": {
                  "type": "string"
                },
                "version": {
                  "type": "string"
                },
                "base_url": {
                  "type": "string"
                },
                "extension": {
                  "type": "string"
                },
                "site_name": {
                  "type": "string"
                },
                "subdomain": {
                  "type": "string"
                },
                "account_id": {
                  "type": "string"
                },
                "account_url": {
                  "type": "string"
                },
                "your-domain": {
                  "type": "string"
                },
                "your_server": {
                  "type": "string"
                },
                "instanceName": {
                  "type": "string"
                },
                "COMPANYDOMAIN": {
                  "type": "string"
                },
                "proxy_password": {
                  "type": "string"
                },
                "proxy_username": {
                  "type": "string"
                },
                "server_location": {
                  "type": "string"
                },
                "instanceEndpoint": {
                  "type": "string"
                },
                "form_api_base_url": {
                  "type": "string"
                },
                "borneo_dashboard_url": {
                  "type": "string"
                }
              },
              "additionalProperties": {
                "nullable": true
              }
            },
            "authScheme": {
              "enum": [
                "BEARER_TOKEN"
              ],
              "type": "string"
            },
            "toolkitSlug": {
              "type": "string"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "authScheme",
            "toolkitSlug",
            "val"
          ],
          "properties": {
            "val": {
              "type": "object",
              "required": [
                "oauth_token",
                "oauth_token_secret"
              ],
              "properties": {
                "dc": {
                  "type": "string"
                },
                "shop": {
                  "type": "string"
                },
                "domain": {
                  "type": "string"
                },
                "region": {
                  "type": "string"
                },
                "api_url": {
                  "type": "string"
                },
                "version": {
                  "type": "string"
                },
                "base_url": {
                  "type": "string"
                },
                "extension": {
                  "type": "string"
                },
                "site_name": {
                  "type": "string"
                },
                "subdomain": {
                  "type": "string"
                },
                "account_id": {
                  "type": "string"
                },
                "account_url": {
                  "type": "string"
                },
                "oauth_token": {
                  "type": "string"
                },
                "redirectUrl": {
                  "type": "string"
                },
                "your-domain": {
                  "type": "string"
                },
                "your_server": {
                  "type": "string"
                },
                "callback_url": {
                  "type": "string"
                },
                "consumer_key": {
                  "type": "string"
                },
                "instanceName": {
                  "type": "string"
                },
                "COMPANYDOMAIN": {
                  "type": "string"
                },
                "oauth_verifier": {
                  "type": "string"
                },
                "proxy_password": {
                  "type": "string"
                },
                "proxy_username": {
                  "type": "string"
                },
                "server_location": {
                  "type": "string"
                },
                "instanceEndpoint": {
                  "type": "string"
                },
                "form_api_base_url": {
                  "type": "string"
                },
                "oauth_token_secret": {
                  "type": "string"
                },
                "borneo_dashboard_url": {
                  "type": "string"
                }
              },
              "additionalProperties": {
                "nullable": true
              }
            },
            "authScheme": {
              "enum": [
                "OAUTH1"
              ],
              "type": "string"
            },
            "toolkitSlug": {
              "type": "string"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "authScheme",
            "toolkitSlug",
            "val"
          ],
          "properties": {
            "val": {
              "type": "object",
              "properties": {
                "dc": {
                  "type": "string"
                },
                "shop": {
                  "type": "string"
                },
                "domain": {
                  "type": "string"
                },
                "region": {
                  "type": "string"
                },
                "api_url": {
                  "type": "string"
                },
                "version": {
                  "type": "string"
                },
                "base_url": {
                  "type": "string"
                },
                "extension": {
                  "type": "string"
                },
                "site_name": {
                  "type": "string"
                },
                "subdomain": {
                  "type": "string"
                },
                "account_id": {
                  "type": "string"
                },
                "account_url": {
                  "type": "string"
                },
                "your-domain": {
                  "type": "string"
                },
                "your_server": {
                  "type": "string"
                },
                "instanceName": {
                  "type": "string"
                },
                "COMPANYDOMAIN": {
                  "type": "string"
                },
                "proxy_password": {
                  "type": "string"
                },
                "proxy_username": {
                  "type": "string"
                },
                "server_location": {
                  "type": "string"
                },
                "instanceEndpoint": {
                  "type": "string"
                },
                "form_api_base_url": {
                  "type": "string"
                },
                "borneo_dashboard_url": {
                  "type": "string"
                }
              },
              "additionalProperties": {
                "nullable": true
              }
            },
            "authScheme": {
              "enum": [
                "NO_AUTH"
              ],
              "type": "string"
            },
            "toolkitSlug": {
              "type": "string"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "authScheme",
            "toolkitSlug",
            "val"
          ],
          "properties": {
            "val": {
              "type": "object",
              "required": [
                "application_id",
                "installation_id",
                "private_key"
              ],
              "properties": {
                "dc": {
                  "type": "string"
                },
                "shop": {
                  "type": "string"
                },
                "domain": {
                  "type": "string"
                },
                "region": {
                  "type": "string"
                },
                "api_url": {
                  "type": "string"
                },
                "version": {
                  "type": "string"
                },
                "base_url": {
                  "type": "string"
                },
                "extension": {
                  "type": "string"
                },
                "site_name": {
                  "type": "string"
                },
                "subdomain": {
                  "type": "string"
                },
                "account_id": {
                  "type": "string"
                },
                "account_url": {
                  "type": "string"
                },
                "private_key": {
                  "type": "string"
                },
                "your-domain": {
                  "type": "string"
                },
                "your_server": {
                  "type": "string"
                },
                "instanceName": {
                  "type": "string"
                },
                "COMPANYDOMAIN": {
                  "type": "string"
                },
                "application_id": {
                  "type": "string"
                },
                "proxy_password": {
                  "type": "string"
                },
                "proxy_username": {
                  "type": "string"
                },
                "installation_id": {
                  "type": "string"
                },
                "server_location": {
                  "type": "string"
                },
                "instanceEndpoint": {
                  "type": "string"
                },
                "form_api_base_url": {
                  "type": "string"
                },
                "borneo_dashboard_url": {
                  "type": "string"
                }
              },
              "additionalProperties": {
                "nullable": true
              }
            },
            "authScheme": {
              "enum": [
                "SERVICE_ACCOUNT"
              ],
              "type": "string"
            },
            "toolkitSlug": {
              "type": "string"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "authScheme",
            "toolkitSlug",
            "val"
          ],
          "properties": {
            "val": {
              "type": "object",
              "required": [
                "credentials_json"
              ],
              "properties": {
                "dc": {
                  "type": "string"
                },
                "shop": {
                  "type": "string"
                },
                "domain": {
                  "type": "string"
                },
                "region": {
                  "type": "string"
                },
                "api_url": {
                  "type": "string"
                },
                "version": {
                  "type": "string"
                },
                "base_url": {
                  "type": "string"
                },
                "extension": {
                  "type": "string"
                },
                "site_name": {
                  "type": "string"
                },
                "subdomain": {
                  "type": "string"
                },
                "account_id": {
                  "type": "string"
                },
                "account_url": {
                  "type": "string"
                },
                "your-domain": {
                  "type": "string"
                },
                "your_server": {
                  "type": "string"
                },
                "instanceName": {
                  "type": "string"
                },
                "COMPANYDOMAIN": {
                  "type": "string"
                },
                "proxy_password": {
                  "type": "string"
                },
                "proxy_username": {
                  "type": "string"
                },
                "server_location": {
                  "type": "string"
                },
                "credentials_json": {
                  "type": "string"
                },
                "instanceEndpoint": {
                  "type": "string"
                },
                "form_api_base_url": {
                  "type": "string"
                },
                "borneo_dashboard_url": {
                  "type": "string"
                }
              },
              "additionalProperties": {
                "nullable": true
              }
            },
            "authScheme": {
              "enum": [
                "GOOGLE_SERVICE_ACCOUNT"
              ],
              "type": "string"
            },
            "toolkitSlug": {
              "type": "string"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "authScheme",
            "toolkitSlug",
            "val"
          ],
          "properties": {
            "val": {
              "type": "object",
              "required": [
                "access_token",
                "client_id",
                "client_secret"
              ],
              "properties": {
                "dc": {
                  "type": "string"
                },
                "shop": {
                  "type": "string"
                },
                "scope": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    {
                      "nullable": true
                    }
                  ]
                },
                "domain": {
                  "type": "string"
                },
                "region": {
                  "type": "string"
                },
                "api_url": {
                  "type": "string"
                },
                "version": {
                  "type": "string"
                },
                "base_url": {
                  "type": "string"
                },
                "client_id": {
                  "type": "string"
                },
                "extension": {
                  "type": "string"
                },
                "site_name": {
                  "type": "string"
                },
                "subdomain": {
                  "type": "string"
                },
                "account_id": {
                  "type": "string"
                },
                "expires_at": {
                  "type": "string"
                },
                "expires_in": {
                  "anyOf": [
                    {
                      "type": "number"
                    },
                    {
                      "type": "string"
                    },
                    {
                      "nullable": true
                    }
                  ]
                },
                "token_type": {
                  "type": "string"
                },
                "account_url": {
                  "type": "string"
                },
                "your-domain": {
                  "type": "string"
                },
                "your_server": {
                  "type": "string"
                },
                "access_token": {
                  "type": "string"
                },
                "instanceName": {
                  "type": "string"
                },
                "COMPANYDOMAIN": {
                  "type": "string"
                },
                "client_secret": {
                  "type": "string"
                },
                "proxy_password": {
                  "type": "string"
                },
                "proxy_username": {
                  "type": "string"
                },
                "server_location": {
                  "type": "string"
                },
                "instanceEndpoint": {
                  "type": "string"
                },
                "form_api_base_url": {
                  "type": "string"
                },
                "borneo_dashboard_url": {
                  "type": "string"
                }
              },
              "additionalProperties": {
                "nullable": true
              }
            },
            "authScheme": {
              "enum": [
                "S2S_OAUTH2"
              ],
              "type": "string"
            },
            "toolkitSlug": {
              "type": "string"
            }
          }
        }
      ],
      "deprecated": true,
      "description": "body parameter"
    }
  }
}