Tools

Get required scopes for tools (DEPRECATED)

Changed on

DEPRECATED: Use POST /api/v3.1/toolkits/{toolkit_slug}/scopes/recommended instead, discovering its grant_context options with GET /api/v3.1/toolkits/{toolkit_slug}/scopes/grant_context. Resolves required scopes for the specified tools at a given toolkit version. All requested tools must belong to the same toolkit. Returns the flat scope union plus per-tool structured scope requirements when available.

post/api/v3.1/tools/scopes/required

Request

  • Base URL
    https://backend.composio.dev
  • URL
    https://backend.composio.dev/api/v3.1/tools/scopes/required
  • Auth
    API key in header x-api-key

Request body

toolsstring[] required

Tool slugs to resolve scopes for. All tools must belong to the same toolkit.

versionstring

Toolkit version to resolve scopes against for the requested toolkit. Defaults to the latest published version ("latest") when omitted.

Example request

{
  "tools": [
    "GMAIL_FETCH_EMAILS",
    "GMAIL_SEND_EMAIL"
  ],
  "version": "latest"
}

Response

Successfully retrieved scopes for the specified tools

scopes_requiredstring[] required

A combined list of all unique scopes required by the specified tools

Example response

{
  "scopes_required": [
    "channels:read",
    "chat:write",
    "https://www.googleapis.com/auth/gmail.modify",
    "repo",
    "user:email"
  ]
}

Changes

  • 98956f31abf3Revision changes
    • info

      api operation id postV3_1ToolsScopesRequired removed and replaced with postToolsScopesRequired

    • info

      endpoint deprecated

  • c039e97e7f14Revision changes
    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property /// to the response with the status