Skip to content

Show the Fin Agent API access request form on every Fin endpoint #690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rahulgdsouza merged 1 commit into from
Sep 29, 2026
Merged

Show the Fin Agent API access request form on every Fin endpoint #690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion descriptions/0/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26517,6 +26517,10 @@ paths:
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, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Capabilities returned successfully
Expand Down Expand Up @@ -26646,6 +26650,10 @@ paths:

Fin's answer is delivered asynchronously via the `fin_replied` event. The conversation
ends with a `complete` status — there is no `awaiting_user_reply` cycle.

{% admonition type="warning" %}
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Question accepted successfully
Expand Down Expand Up @@ -26825,6 +26833,10 @@ paths:
Send a follow-up message in an existing conversation. When Fin needs more information to
complete an action, it sets the conversation to `awaiting_user_reply` — send the user's
response so Fin can continue.

{% admonition type="warning" %}
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Reply sent successfully
Expand Down Expand Up @@ -27010,6 +27022,10 @@ paths:
Fin's progress is delivered asynchronously via events or Server-Sent Events. If the
procedure pauses for user input, the conversation status becomes `awaiting_user_reply` —
send the user's response with [`/fin/reply`](/docs/references/preview/rest-api/api.intercom.io/fin-agent/replytofin).

{% admonition type="warning" %}
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Procedure run started successfully
Expand Down Expand Up @@ -27244,6 +27260,10 @@ paths:
followed by `complete`. The `complete` status signals that Fin is done; it does not close
the conversation. On the Intercom Helpdesk, the new human conversation remains open; on
Fin for Platforms, the conversation remains open for whoever handles it on your platform.

{% admonition type="warning" %}
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Conversation escalated successfully
Expand Down Expand Up @@ -27378,6 +27398,10 @@ paths:
stored rating while the update window is still open, and a first remark can be added to
an already-rated survey. Once a remark has been recorded the rating is locked and can no
longer be changed.

{% admonition type="warning" %}
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Rating recorded successfully
Expand Down Expand Up @@ -27531,6 +27555,10 @@ paths:
During this workflow, the client should allow Fin to continue uninterrupted until a final *complete* status is returned, at which point control of the conversation passes back to the client.

Events can be received via webhooks or Server-Sent Events (SSE) using the `sse_subscription_url` in the response.

{% admonition type="warning" %}
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Fin conversation started successfully
Expand Down Expand Up @@ -44281,7 +44309,7 @@ tags:
 

{% admonition type="warning" %}
Please reach out to your accounts team to discuss access and tailored, hands-on support.
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}

 
Expand Down
24 changes: 20 additions & 4 deletions descriptions/2.14/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1825,7 +1825,7 @@ paths:
These additional pieces of context will be used by Fin to provide a better and more contextual answer to the user.

{% admonition type="warning" %}
Please reach out to your accounts team to discuss access.
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}

Once Fin is initialized, it progresses through a series of statuses such as *thinking*, *awaiting_user_reply*, or *resolved* before ending with a status of *complete*.
Expand Down Expand Up @@ -2025,7 +2025,7 @@ paths:
If a user replies, use this endpoint to send this response to Fin.

{% admonition type="warning" %}
Please reach out to your accounts team to discuss access.
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
Expand Down Expand Up @@ -2197,7 +2197,7 @@ paths:
longer be changed.

{% admonition type="warning" %}
Please reach out to your accounts team to discuss access.
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
Expand Down Expand Up @@ -2342,6 +2342,10 @@ paths:
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, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Capabilities returned successfully
Expand Down Expand Up @@ -2471,6 +2475,10 @@ paths:

Fin's answer is delivered asynchronously via the `fin_replied` event. The conversation
ends with a `complete` status — there is no `awaiting_user_reply` cycle.

{% admonition type="warning" %}
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Question accepted successfully
Expand Down Expand Up @@ -2660,6 +2668,10 @@ paths:
Fin's progress is delivered asynchronously via events or Server-Sent Events. If the
procedure pauses for user input, the conversation status becomes `awaiting_user_reply` —
send the user's response with [`/fin/reply`](/docs/references/2.14/rest-api/api.intercom.io/fin-agent/replytofin).

{% admonition type="warning" %}
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Procedure run started successfully
Expand Down Expand Up @@ -2882,6 +2894,10 @@ paths:
followed by `complete`. The `complete` status signals that Fin is done; it does not close
the conversation. On the Intercom Helpdesk, the new human conversation remains open; on
Fin for Platforms, the conversation remains open for whoever handles it on your platform.

{% admonition type="warning" %}
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Conversation escalated successfully
Expand Down Expand Up @@ -24327,7 +24343,7 @@ tags:
 

{% admonition type="warning" %}
Please reach out to your accounts team to discuss access and tailored, hands-on support.
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}

 
Expand Down
24 changes: 20 additions & 4 deletions descriptions/2.15/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1831,7 +1831,7 @@ paths:
These additional pieces of context will be used by Fin to provide a better and more contextual answer to the user.

{% admonition type="warning" %}
Please reach out to your accounts team to discuss access.
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}

Once Fin is initialized, it progresses through a series of statuses such as *thinking*, *awaiting_user_reply*, or *resolved* before ending with a status of *complete*.
Expand Down Expand Up @@ -2031,7 +2031,7 @@ paths:
If a user replies, use this endpoint to send this response to Fin.

{% admonition type="warning" %}
Please reach out to your accounts team to discuss access.
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
Expand Down Expand Up @@ -14993,7 +14993,7 @@ paths:
longer be changed.

{% admonition type="warning" %}
Please reach out to your accounts team to discuss access.
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
Expand Down Expand Up @@ -15138,6 +15138,10 @@ paths:
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, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Capabilities returned successfully
Expand Down Expand Up @@ -15267,6 +15271,10 @@ paths:

Fin's answer is delivered asynchronously via the `fin_replied` event. The conversation
ends with a `complete` status — there is no `awaiting_user_reply` cycle.

{% admonition type="warning" %}
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Question accepted successfully
Expand Down Expand Up @@ -15456,6 +15464,10 @@ paths:
Fin's progress is delivered asynchronously via events or Server-Sent Events. If the
procedure pauses for user input, the conversation status becomes `awaiting_user_reply` —
send the user's response with [`/fin/reply`](/docs/references/2.15/rest-api/api.intercom.io/fin-agent/replytofin).

{% admonition type="warning" %}
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Procedure run started successfully
Expand Down Expand Up @@ -15678,6 +15690,10 @@ paths:
followed by `complete`. The `complete` status signals that Fin is done; it does not close
the conversation. On the Intercom Helpdesk, the new human conversation remains open; on
Fin for Platforms, the conversation remains open for whoever handles it on your platform.

{% admonition type="warning" %}
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Conversation escalated successfully
Expand Down Expand Up @@ -25442,7 +25458,7 @@ tags:
 

{% admonition type="warning" %}
Please reach out to your accounts team to discuss access and tailored, hands-on support.
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}

 
Expand Down
24 changes: 20 additions & 4 deletions descriptions/2.16/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3970,7 +3970,7 @@ paths:
These additional pieces of context will be used by Fin to provide a better and more contextual answer to the user.

{% admonition type="warning" %}
Please reach out to your accounts team to discuss access.
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}

Once Fin is initialized, it progresses through a series of statuses such as *thinking*, *replying*, *awaiting_user_reply*, or *resolved* before ending with a status of *complete*.
Expand Down Expand Up @@ -4171,7 +4171,7 @@ paths:
If a user replies, use this endpoint to send this response to Fin.

{% admonition type="warning" %}
Please reach out to your accounts team to discuss access.
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
Expand Down Expand Up @@ -4344,7 +4344,7 @@ paths:
longer be changed.

{% admonition type="warning" %}
Please reach out to your accounts team to discuss access.
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
Expand Down Expand Up @@ -4489,6 +4489,10 @@ paths:
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, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Capabilities returned successfully
Expand Down Expand Up @@ -4618,6 +4622,10 @@ paths:

Fin's answer is delivered asynchronously via the `fin_replied` event. The conversation
ends with a `complete` status — there is no `awaiting_user_reply` cycle.

{% admonition type="warning" %}
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Question accepted successfully
Expand Down Expand Up @@ -4807,6 +4815,10 @@ paths:
Fin's progress is delivered asynchronously via events or Server-Sent Events. If the
procedure pauses for user input, the conversation status becomes `awaiting_user_reply` —
send the user's response with [`/fin/reply`](/docs/references/rest-api/api.intercom.io/fin-agent/replytofin).

{% admonition type="warning" %}
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Procedure run started successfully
Expand Down Expand Up @@ -5029,6 +5041,10 @@ paths:
followed by `complete`. The `complete` status signals that Fin is done; it does not close
the conversation. On the Intercom Helpdesk, the new human conversation remains open; on
Fin for Platforms, the conversation remains open for whoever handles it on your platform.

{% admonition type="warning" %}
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}
responses:
'200':
description: Conversation escalated successfully
Expand Down Expand Up @@ -36403,7 +36419,7 @@ tags:
 

{% admonition type="warning" %}
Please reach out to your accounts team to discuss access and tailored, hands-on support.
To request access to the Fin Agent API, please [fill out this form](https://forms.gle/osy4uyiqyomRCsL2A).
{% /admonition %}

 
Expand Down
Loading