Read a guide

GET

/api/v1/guides/{guide}

const url = 'https://api.inside.chat/api/v1/guides/overview';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.inside.chat/api/v1/guides/overview \
  --header 'Authorization: Bearer <token>'

Required scopes: –
Data access: –
MCP tool: guide_read

Read one guide permitted by current installation grants. Shared quotas and final current-authority checks apply. Guidance supplies no permission lease or native-read result. No query parameters.

Authorizations

installation_token
oauth_client_credentials

Parameters

Path Parameters

guide

required

string

Allowed values: overview investigation contacts reporting configuration agent_tasks event_recovery

Responses

200

Current grant metadata or permitted guidance; every subsequent action rechecks authority.

application/json

object

guide

required

string

Allowed values: overview investigation contacts reporting configuration agent_tasks event_recovery

mime_type

required

string

Allowed value: text/markdown

content

required

string

<= 65536 characters

coverage

required

string

Allowed value: current_installation_guidance

Example

{
  "guide": "overview",
  "mime_type": "text/markdown",
  "coverage": "current_installation_guidance"
}

400

Unsupported input.

401

Missing, expired or changed installation authority.

404

Guide unavailable under current grants.

429

Shared application quota exceeded.

Headers

Retry-After

integer

>= 1