Open API REST v1

One for business systems.REST Call Noodle.

Base /api/open/v1/Bearer Rights, covering questions and answers, the knowledge base, tickets, customers and support. Do not run console Cookie or /api/admin Open to three. Code Neo programming tool for Code Neo please use a stand-alone tool MCP Integration。

Testing in browser To issue the key. OpenAPI JSON

This page does not display or generate production keys. Paste the application to the interface to this station only and do not write to browser storage.

Functional indications. RET access

Issue Bearer KeySystem Settings Zoom Open Applications, expressly shown only once

Bring Authorization Call/api/open/v1/ _ Do not bring Origin

Questions and answers by site / SyncDon't open the console, Cookie.

Access three steps.

The key is issued in the system setting and the site is separately open. Visitor attachments and Admin Console paths remain unchanged. Agent, I'll see you on the connection. MCP Integration。

STEP 01 Open Channel

In the operations console, open Sites and tick Open API. It is off by default; while off, Q&A returns channel_disabled. MCP is a separate channel, switched on the MCP page in System Settings.

STEP 02 Issue application

System settings open application. Runtime questions and answers, ops synchronized worksheets, angent to MCP. Expressly only once.

STEP 03 Bring Bearer Call

Service does not bring Origin. Every time a multiple key is passed siteWrite Operations Add Idempotency-Key。

Apply type default range:

Type	scene	Defaults
`runtime`	Questions and answers for back-end visitors	`chat` `live.write` `kb.read`
`ops`	ERP / Electric Sync	`crm.` `work.` `ticket.read`
`agent`	Codeneo code layout tool / Internal Agent, see MCP Integration	`chat` `kb.read` `ticket.read` `crm.read`

Jurisdiction

Key Format aics_<live|test>_<12_hex>.<secret>You can use your head. X-AICS-Token。

HTTP

Authorization: Bearer aics_live_REPLACE.REPLACE
Content-Type: application/json
Idempotency-Key: erp-order-20260907-001

Successful Response Unified Belt request_idThe reconciliation was wrong to carry it:

JSON

{
  "code": 200,
  "success": true,
  "message": "success",
  "request_id": "req_…",
  "data": {}
}

Rate limits count per key per minute (default 60), separately from widget visitor limits. Monthly volume follows the plan: Pro 10,000 calls, Enterprise 100,000, Basic has no open API; above that you get 402 api_quota_exceeded, with upgrade_url in the response. Responses never include channel secrets, model keys,ticket_token or internal remarks.

RET Call

Base In the example YOUR_SITE Switch to site ID. And when it succeeds, the outer layer remains. code / success / request_id / data, each article below gives a complete response.

Methodology	Path	scope	Do what?
GET	`/meta`	Any Key	Sites, Channel Switches, Currentscopes
POST	`/chat`	chat	Sync Questions and Answers
GET	`/chat/sessions/{id}`	chat	Session Summary
GET	`/kb/search`	kb.read	`q` `top_k`
GET / POST	`/kb/faq`	kb.read / kb.write	List / Add FAQ
GET	`/tickets`	ticket.read	`status` `limit` `include=last_message`
GET	`/tickets/{id}`	ticket.read	Public information, no internal comment
POST	`/tickets`	live.write	Queue or leave messages `offline:true`
POST	`/tickets/{id}/messages`	live.write	Visitor chases.
POST	`/tickets/{id}/reply`	agent.reply	Robotic response (visitor visible)
POST	`/tickets/{id}/close`	ticket.write	Turn it off. `note`
GET / POST	`/contacts`	crm.read / crm.write	List / Press Cell
GET / PATCH	`/contacts/{id}`	Idem; complete phone	Details / Change Status
POST	`/contacts/{id}/follows`	crm.write	`kind=phone\|chat\|note`
GET / POST	`/work`	work.read / work.write	After Sold List / New
GET / POST	`/work/{id}`	Ibid.	Details / Change `status`
POST	`/work/{id}/follows`	work.write	After sale.
GET / POST	`/webhooks`	hooks.write	Sign key returns only once
GET	`/analytics/overview`	analytics.read	Count in line
GET	`/logs/chats`	logs.read	Dialogue log break
GET	`/openapi.json`	No key required	Path List

Test Call

The key that you copied in Open Applications is pasted. This page is not issued, does not recall, does not write to localStorage. Writing changes the data for real. Use the test key.

Key

Site ID

Actions

Resource ID

Problem / Searchword

The site must have opened the API channel, otherwise the tab/ bill is 403. The key range will not be sufficient.

Results will appear here.

Error code and border

HTTP	error	Meaning
400	`bad_request`	Missing Parameters
401	`unauthorized`	Missing key, misformatted, revoked
403	`forbidden_scope`	Missing scope
403	`wrong_site`	Key not bound to station
403	`channel_disabled`	Site not open api channel
403	`forbidden_ip`	Not IP White List
404	`not_found`	Non-existent or cross-site
402	`plan_required`	The site's plan does not include the open API (Pro required)
402	`api_quota_exceeded`	Monthly call volume used up; upgrade to continue
429	`rate_limited`	The key is exceeded every minute
409	`conflict`	FAQ/ Document ID already exists

Not open: model Key, member and TOTP, channel AppSecret, text message/voice, original database. A key reading B station list is 404/403. Client phone default mask.

Issue key Open channel switch Download Path List MCP Integration