INintercom
Fin Agent

Discover Fin's capabilities

Changed on

Return a machine-readable, per-user list of what Fin can do for a given end user, so an orchestrating agent can decide which endpoint to call.

The response is audience-matched to the supplied user: each live, API-triggerable procedure is checked against that user before being included, alongside the static reply and ask actions.

{% admonition type="warning" %} To request access to the Fin Agent API, go to Settings > Integrations > Fin Agent API in your workspace and tell us about your use case. Once access is granted, Fin Agent API appears under Fin AI Agent > Deploy. {% /admonition %}

post/fin/capabilities

Request

  • Base URL
    https://api.intercom.io
  • Auth
    HTTP bearer

Headers

Intercom-Version'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '2.13' | '2.14'

Intercom API version.</br>By default, it's equal to the version set in the app package.

Example:2.14

Request body

Example request

{
  "user": {
    "id": "123456",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "attributes": {
      "plan_type": "Pro",
      "subscription_status": "active"
    }
  }
}

Response

Capabilities returned successfully

versionstring

The API version the capabilities document was generated for.

Example response

{
  "version": "2.14",
  "capabilities": [
    {
      "type": "procedure",
      "id": "12345",
      "name": "Reset password",
      "description": "Walk the user through resetting their password.",
      "endpoint": "/fin/procedures/12345/run",
      "method": "POST"
    }
  ]
}

Changes