Fin Agent
Access Fin programmatically via the Fin Agent API endpoints.
Operations
| Method | Endpoint | Description |
|---|---|---|
POST | /fin/start | Start a conversation with Fin |
POST | /fin/reply | Reply to Fin |
POST | /fin/csat | Submit a CSAT rating |
POST | /fin/capabilities | Discover Fin's capabilities |
POST | /fin/ask | Ask Fin |
POST | /fin/procedures/{procedure_id}/run | Run a Fin procedure |
POST | /fin/escalate | Escalate to a human |
Example
Start a conversation with Fin, with the TypeScript SDK:
ts
import { Intercom } from "@octridev/intercom";
const client = new Intercom({
// Optional: replaces the default server and any server an operation declares.
baseUrl: "https://api.intercom.io",
auth: { bearerAuth: process.env.API_TOKEN! },
});
const result = await client.finAgent.startFinConversation({
conversationId: "conversation-1",
message: {},
user: {},
});
console.log(result);Nine more languages
The same call exists in every SDK. See SDKs for the other nine.