Discover Fin's capabilities

Request

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.

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.

Security

bearerAuth

Intercom-Versionstring(intercom_version)

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

Default:"2.14"

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:2.14

Bodyapplication/jsonrequired

userobject(Fin Agent User)required

A user object representing the user in a Fin Agent conversation.

curl -i -X POST \
  https://api.intercom.io/fin/capabilities \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.14' \
  -d '{
    "user": {
      "id": "123456"
    }
  }'

Responses

Capabilities returned successfully

Bodyapplication/json

versionstring

The API version the capabilities document was generated for.

Example:"2.14"

capabilitiesArray of objects

The list of capabilities available to this user.

Response

{
  "version": "2.14",
  "capabilities": [
    { … },
    { … },
    { … }
  ]
}