Sign in

v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB
AI Content

Retrieve an external page

You can retrieve an external page.

get/ai/external_pages/{page_id}

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

Response

successful

type'external_page' required

Always external_page

idstring required

The unique identifier for the external page which is given by Intercom.

titlestring required

The title of the external page.

htmlstring required

The body of the external page in HTML.

urlstring

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.

ai_agent_availabilityboolean required

Whether the external page should be used to answer questions by AI Agent.

ai_copilot_availabilityboolean required

Whether the external page should be used to answer questions by AI Copilot.

ai_sales_agent_availabilityboolean

Whether the external page should be used to answer questions by AI Sales Agent.

fin_availabilityboolean

Deprecated. Use ai_agent_availability and ai_copilot_availability instead.

locale'en' required

Always en

source_idinteger required

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

external_idstring required

The identifier for the external page which was given by the source. Must be unique for the source.

created_atinteger required

The time when the external page was created.

updated_atinteger required

The time when the external page was last updated.

last_ingested_atinteger required

The time when the external page was last ingested.

Example response

{
  "type": "external_page",
  "id": "1234",
  "title": "Getting started with...",
  "html": "<p>Hello world!</p>",
  "url": "https://help.example.com/en/articles/1234-getting-started",
  "ai_agent_availability": true,
  "ai_copilot_availability": true,
  "ai_sales_agent_availability": true,
  "fin_availability": true,
  "locale": "en",
  "source_id": 1234,
  "external_id": "5678",
  "created_at": 1672928359,
  "updated_at": 1672928610,
  "last_ingested_at": 1672928610
}