Composio

Composio Proxy API

The Proxy API from Composio — 1 operation(s) for proxy.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.composio.dev/reference
📖
Documentation
https://docs.composio.dev/reference/api-reference/tools
📖
Documentation
https://docs.composio.dev/reference/api-reference/connected-accounts
📖
Documentation
https://docs.composio.dev/reference/api-reference/auth-configs
📖
Documentation
https://docs.composio.dev/reference/api-reference/triggers
📖
Documentation
https://docs.composio.dev/reference/api-reference/toolkits

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/composio/refs/heads/main/openapi/composio-proxy-api-openapi.yml

Other Resources

🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/composio/refs/heads/main/rules/composio-rules.yml

OpenAPI Specification

composio-proxy-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  version: 3.0.0
  title: Composio Platform Account Management Proxy API
  description: ''
  contact:
    name: Composio Support
    url: https://composio.dev/support
    email: support@composio.dev
  license:
    name: Proprietary
    url: https://composio.dev/terms
servers:
- url: https://backend.composio.dev
  description: PRODUCTION API
tags:
- name: Proxy
paths:
  /api/v3/tools/execute/proxy:
    post:
      summary: Execute proxy request
      description: 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.
      tags:
      - Proxy
      operationId: postToolsExecuteProxy
      security:
      - ApiKeyAuth: []
      - UserApiKeyAuth: []
      - CookieAuth: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                connected_account_id:
                  type: string
                  format: connectedAccountId
                  description: The ID of the connected account to use for authentication (if not provided, will use the default account for the project)
                  example: ca_1a2b3c4d5e6f
                endpoint:
                  type: string
                  description: The API endpoint to call (absolute URL or path relative to base URL of the connected account)
                  example: /api/v1/resources
                method:
                  type: string
                  enum:
                  - GET
                  - POST
                  - PUT
                  - DELETE
                  - PATCH
                  - HEAD
                  description: The HTTP method to use for the request
                  example: GET
                body:
                  nullable: true
                  description: The request body (for POST, PUT, and PATCH requests)
                  example:
                    name: New Resource
                    description: This is a new resource
                binary_body:
                  anyOf:
                  - type: object
                    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
                    required:
                    - url
                  - type: object
                    properties:
                      base64:
                        type: string
                        minLength: 1
                        description: Base64-encoded binary data
                      content_type:
                        type: string
                        description: Content-Type header to use for the request
                    required:
                    - base64
                  description: 'Binary body to send. For binary upload via URL: use {url: "https://...", content_type?: "..."}. For binary upload via base64: use {base64: "...", content_type?: "..."}.'
                parameters:
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                        description: Parameter name
                        example: x-api-key
                      value:
                        type: string
                        description: Parameter value
                        example: abc123def456
                      type:
                        type: string
                        enum:
                        - header
                        - query
                        description: Parameter type (header or query)
                        example: header
                    required:
                    - name
                    - value
                    - type
                  description: Additional HTTP headers or query parameters to include in the request
                  example:
                  - name: x-api-key
                    value: abc123def456
                    type: header
                  - name: filter
                    value: active
                    type: query
                custom_connection_data:
                  oneOf:
                  - type: object
                    properties:
                      authScheme:
                        type: string
                        enum:
                        - OAUTH2
                      toolkitSlug:
                        type: string
                      val:
                        type: object
                        properties:
                          subdomain:
                            type: string
                          your-domain:
                            type: string
                          region:
                            type: string
                          shop:
                            type: string
                          account_url:
                            type: string
                          COMPANYDOMAIN:
                            type: string
                          extension:
                            type: string
                          form_api_base_url:
                            type: string
                          instanceEndpoint:
                            type: string
                          api_url:
                            type: string
                          borneo_dashboard_url:
                            type: string
                          proxy_username:
                            type: string
                          proxy_password:
                            type: string
                          domain:
                            type: string
                          version:
                            type: string
                          dc:
                            type: string
                          site_name:
                            type: string
                          instanceName:
                            type: string
                          account_id:
                            type: string
                          your_server:
                            type: string
                          server_location:
                            type: string
                          base_url:
                            type: string
                          state_prefix:
                            type: string
                            maxLength: 40
                            description: The oauth2 state prefix for the connection
                          long_redirect_url:
                            type: boolean
                            description: Whether to return the redirect url without shortening
                          access_token:
                            type: string
                          id_token:
                            type: string
                          token_type:
                            type: string
                          refresh_token:
                            type: string
                            nullable: true
                          expires_in:
                            anyOf:
                            - type: number
                            - type: string
                            - nullable: true
                          scope:
                            anyOf:
                            - type: string
                            - type: array
                              items:
                                type: string
                            - nullable: true
                          webhook_signature:
                            type: string
                          authed_user:
                            type: object
                            properties:
                              access_token:
                                type: string
                              scope:
                                type: string
                            description: for slack user scopes
                          extra_token_data:
                            type: object
                            additionalProperties:
                              nullable: true
                        required:
                        - access_token
                        additionalProperties:
                          nullable: true
                    required:
                    - authScheme
                    - toolkitSlug
                    - val
                  - type: object
                    properties:
                      authScheme:
                        type: string
                        enum:
                        - DCR_OAUTH
                      toolkitSlug:
                        type: string
                      val:
                        type: object
                        properties:
                          subdomain:
                            type: string
                          your-domain:
                            type: string
                          region:
                            type: string
                          shop:
                            type: string
                          account_url:
                            type: string
                          COMPANYDOMAIN:
                            type: string
                          extension:
                            type: string
                          form_api_base_url:
                            type: string
                          instanceEndpoint:
                            type: string
                          api_url:
                            type: string
                          borneo_dashboard_url:
                            type: string
                          proxy_username:
                            type: string
                          proxy_password:
                            type: string
                          domain:
                            type: string
                          version:
                            type: string
                          dc:
                            type: string
                          site_name:
                            type: string
                          instanceName:
                            type: string
                          account_id:
                            type: string
                          your_server:
                            type: string
                          server_location:
                            type: string
                          base_url:
                            type: string
                          state_prefix:
                            type: string
                            maxLength: 40
                            description: The oauth2 state prefix for the connection
                          long_redirect_url:
                            type: boolean
                            description: Whether to return the redirect url without shortening
                          client_id:
                            type: string
                            description: Dynamically registered client ID
                          client_secret:
                            type: string
                            description: Dynamically registered client secret
                          access_token:
                            type: string
                          id_token:
                            type: string
                          token_type:
                            type: string
                          refresh_token:
                            type: string
                            nullable: true
                          expires_in:
                            anyOf:
                            - type: number
                            - type: string
                            - nullable: true
                          scope:
                            anyOf:
                            - type: string
                            - type: array
                              items:
                                type: string
                            - nullable: true
                          client_id_issued_at:
                            type: number
                          client_secret_expires_at:
                            type: number
                        required:
                        - client_id
                        - access_token
                        additionalProperties:
                          nullable: true
                    required:
                    - authScheme
                    - toolkitSlug
                    - val
                  - type: object
                    properties:
                      authScheme:
                        type: string
                        enum:
                        - API_KEY
                      toolkitSlug:
                        type: string
                      val:
                        type: object
                        properties:
                          subdomain:
                            type: string
                          your-domain:
                            type: string
                          region:
                            type: string
                          shop:
                            type: string
                          account_url:
                            type: string
                          COMPANYDOMAIN:
                            type: string
                          extension:
                            type: string
                          form_api_base_url:
                            type: string
                          instanceEndpoint:
                            type: string
                          api_url:
                            type: string
                          borneo_dashboard_url:
                            type: string
                          proxy_username:
                            type: string
                          proxy_password:
                            type: string
                          domain:
                            type: string
                          version:
                            type: string
                          dc:
                            type: string
                          site_name:
                            type: string
                          instanceName:
                            type: string
                          account_id:
                            type: string
                          your_server:
                            type: string
                          server_location:
                            type: string
                          base_url:
                            type: string
                          generic_api_key:
                            type: string
                          api_key:
                            type: string
                          bearer_token:
                            type: string
                          basic_encoded:
                            type: string
                        additionalProperties:
                          nullable: true
                    required:
                    - authScheme
                    - toolkitSlug
                    - val
                  - type: object
                    properties:
                      authScheme:
                        type: string
                        enum:
                        - BASIC_WITH_JWT
                      toolkitSlug:
                        type: string
                      val:
                        type: object
                        properties:
                          subdomain:
                            type: string
                          your-domain:
                            type: string
                          region:
                            type: string
                          shop:
                            type: string
                          account_url:
                            type: string
                          COMPANYDOMAIN:
                            type: string
                          extension:
                            type: string
                          form_api_base_url:
                            type: string
                          instanceEndpoint:
                            type: string
                          api_url:
                            type: string
                          borneo_dashboard_url:
                            type: string
                          proxy_username:
                            type: string
                          proxy_password:
                            type: string
                          domain:
                            type: string
                          version:
                            type: string
                          dc:
                            type: string
                          site_name:
                            type: string
                          instanceName:
                            type: string
                          account_id:
                            type: string
                          your_server:
                            type: string
                          server_location:
                            type: string
                          base_url:
                            type: string
                          username:
                            type: string
                          password:
                            type: string
                        required:
                        - username
                        - password
                        additionalProperties:
                          nullable: true
                    required:
                    - authScheme
                    - toolkitSlug
                    - val
                  - type: object
                    properties:
                      authScheme:
                        type: string
                        enum:
                        - BASIC
                      toolkitSlug:
                        type: string
                      val:
                        type: object
                        properties:
                          subdomain:
                            type: string
                          your-domain:
                            type: string
                          region:
                            type: string
                          shop:
                            type: string
                          account_url:
                            type: string
                          COMPANYDOMAIN:
                            type: string
                          extension:
                            type: string
                          form_api_base_url:
                            type: string
                          instanceEndpoint:
                            type: string
                          api_url:
                            type: string
                          borneo_dashboard_url:
                            type: string
                          proxy_username:
                            type: string
                          proxy_password:
                            type: string
                          domain:
                            type: string
                          version:
                            type: string
                          dc:
                            type: string
                          site_name:
                            type: string
                          instanceName:
                            type: string
                          account_id:
                            type: string
                          your_server:
                            type: string
                          server_location:
                            type: string
                          base_url:
                            type: string
                          username:
                            type: string
                          password:
                            type: string
                        required:
                        - username
                        additionalProperties:
                          nullable: true
                    required:
                    - authScheme
                    - toolkitSlug
                    - val
                  - type: object
                    properties:
                      authScheme:
                        type: string
                        enum:
                        - BEARER_TOKEN
                      toolkitSlug:
                        type: string
                      val:
                        type: object
                        properties:
                          subdomain:
                            type: string
                          your-domain:
                            type: string
                          region:
                            type: string
                          shop:
                            type: string
                          account_url:
                            type: string
                          COMPANYDOMAIN:
                            type: string
                          extension:
                            type: string
                          form_api_base_url:
                            type: string
                          instanceEndpoint:
                            type: string
                          api_url:
                            type: string
                          borneo_dashboard_url:
                            type: string
                          proxy_username:
                            type: string
                          proxy_password:
                            type: string
                          domain:
                            type: string
                          version:
                            type: string
                          dc:
                            type: string
                          site_name:
                            type: string
                          instanceName:
                            type: string
                          account_id:
                            type: string
                          your_server:
                            type: string
                          server_location:
                            type: string
                          base_url:
                            type: string
                          token:
                            type: string
                        required:
                        - token
                        additionalProperties:
                          nullable: true
                    required:
                    - authScheme
                    - toolkitSlug
                    - val
                  - type: object
                    properties:
                      authScheme:
                        type: string
                        enum:
                        - OAUTH1
                      toolkitSlug:
                        type: string
                      val:
                        type: object
                        properties:
                          subdomain:
                            type: string
                          your-domain:
                            type: string
                          region:
                            type: string
                          shop:
                            type: string
                          account_url:
                            type: string
                          COMPANYDOMAIN:
                            type: string
                          extension:
                            type: string
                          form_api_base_url:
                            type: string
                          instanceEndpoint:
                            type: string
                          api_url:
                            type: string
                          borneo_dashboard_url:
                            type: string
                          proxy_username:
                            type: string
                          proxy_password:
                            type: string
                          domain:
                            type: string
                          version:
                            type: string
                          dc:
                            type: string
                          site_name:
                            type: string
                          instanceName:
                            type: string
                          account_id:
                            type: string
                          your_server:
                            type: string
                          server_location:
                            type: string
                          base_url:
                            type: string
                          oauth_token:
                            type: string
                          oauth_token_secret:
                            type: string
                          oauth_verifier:
                            type: string
                          consumer_key:
                            type: string
                          redirectUrl:
                            type: string
                          callback_url:
                            type: string
                        required:
                        - oauth_token
                        - oauth_token_secret
                        additionalProperties:
                          nullable: true
                    required:
                    - authScheme
                    - toolkitSlug
                    - val
                  - type: object
                    properties:
                      authScheme:
                        type: string
                        enum:
                        - NO_AUTH
                      toolkitSlug:
                        type: string
                      val:
                        type: object
                        properties:
                          subdomain:
                            type: string
                          your-domain:
                            type: string
                          region:
                            type: string
                          shop:
                            type: string
                          account_url:
                            type: string
                          COMPANYDOMAIN:
                            type: string
                          extension:
                            type: string
                          form_api_base_url:
                            type: string
                          instanceEndpoint:
                            type: string
                          api_url:
                            type: string
                          borneo_dashboard_url:
                            type: string
                          proxy_username:
                            type: string
                          proxy_password:
                            type: string
                          domain:
                            type: string
                          version:
                            type: string
                          dc:
                            type: string
                          site_name:
                            type: string
                          instanceName:
                            type: string
                          account_id:
                            type: string
                          your_server:
                            type: string
                          server_location:
                            type: string
                          base_url:
                            type: string
                        additionalProperties:
                          nullable: true
                    required:
                    - authScheme
                    - toolkitSlug
                    - val
                  - type: object
                    properties:
                      authScheme:
                        type: string
                        enum:
                        - SERVICE_ACCOUNT
                      toolkitSlug:
                        type: string
                      val:
                        type: object
                        properties:
                          subdomain:
                            type: string
                          your-domain:
                            type: string
                          region:
                            type: string
                          shop:
                            type: string
                          account_url:
                            type: string
                          COMPANYDOMAIN:
                            type: string
                          extension:
                            type: string
                          form_api_base_url:
                            type: string
                          instanceEndpoint:
                            type: string
                          api_url:
                            type: string
                          borneo_dashboard_url:
                            type: string
                          proxy_username:
                            type: string
                          proxy_password:
                            type: string
                          domain:
                            type: string
                          version:
                            type: string
                          dc:
                            type: string
                          site_name:
                            type: string
                          instanceName:
                            type: string
                          account_id:
                            type: string
                          your_server:
                            type: string
                          server_location:
                            type: string
                          base_url:
                            type: string
                          application_id:
                            type: string
                          installation_id:
                            type: string
                          private_key:
                            type: string
                        required:
                        - application_id
                        - installation_id
                        - private_key
                        additionalProperties:
                          nullable: true
                    required:
                    - authScheme
                    - toolkitSlug
                    - val
                  - type: object
                    properties:
                      authScheme:
                        type: string
                        enum:
                        - GOOGLE_SERVICE_ACCOUNT
                      toolkitSlug:
                        type: string
                      val:
                        type: object
                        properties:
                          subdomain:
                            type: string
                          your-domain:
                            type: string
                          region:
                            type: string
                          shop:
                            type: string
                          account_url:
                            type: string
                          COMPANYDOMAIN:
                            type: string
                          extension:
                            type: string
                          form_api_base_url:
                            type: string
                          instanceEndpoint:
                            type: string
                          api_url:
                            type: string
                          borneo_dashboard_url:
                            type: string
                          proxy_username:
                            type: string
                          proxy_password:
                            type: string
                          domain:
                            type: string
                          vers

# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/composio/refs/heads/main/openapi/composio-proxy-api-openapi.yml