Get the configuration schema

GET

/api/v1/settings/schema

const url = 'https://api.inside.chat/api/v1/settings/schema?website_id=example&path=%2Fai%2Ffeatures';
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/settings/schema?website_id=example&path=%2Fai%2Ffeatures' \
  --header 'Authorization: Bearer <token>'

Required scopes: config_read
Data access: –
MCP tool: config_schema

Read the closed metadata schema for /ai/features and separately scoped dry-run preview fields. Current configuration remains read-only; this grants no approval or native apply authority.

Authorizations

installation_token
oauth_client_credentials
config_read

Parameters

Query Parameters

website_id

required

string

/^web_[0-9]{1,20}_[1-9][0-9]{0,18}$/

An explicitly granted website.

path

required

string

Allowed values: /ai/features

Responses

200

Authorized result. Projection depends on current scopes and data policy.

application/json

Metadata schema for the AI feature configuration area.

object

data

required

object

path

required

Allowed value: /ai/features

type

required

Allowed value: collection

read_only

required

plan_available

required

boolean

preview_fields

required

Array<string>

Allowed values: name enabled

apply_available

required

item_schema

required

JSON Schema for one AI feature item.

object

Example

{
  "data": {
    "path": "/ai/features",
    "type": "collection",
    "read_only": true,
    "preview_fields": [
      "name"
    ],
    "apply_available": false
  }
}

400

Invalid, duplicate or unsupported request parameters.

401

Missing, expired or revoked installation credential.

404

Resource not found or not permitted by current authority.

422

The requested capability is not available for application installations.

429

Per-app quota exceeded.

Headers

Retry-After

integer

>= 1

503

Enrollment, native service or required authority is unavailable.