Hoppa till innehåll

Hantera din AI Agents AI Actions via API:et.

  • Förhandsgranska JSONPath-träffar. Kontrollera rot-, fält-, arrayindex- och jokerteckensökvägar i angiven JSON. Ingen Action körs och konversationsminnet ändras inte.

  • Kontrollera en MCP-exempelanslutning. Initiera och lista verktyg endast på slutpunkten för Cloudflare-dokumentationen eller Microsoft Learn. Ingen inloggning eller verktygskörning sker.

I en kompatibel webbläsare finns dessa kontroller också som webbplatsverktyg. Länkarna öppnar de vanliga formulären.

AI Actions utökar din AI Agents förmågor utöver att besvara frågor från Knowledge Base. De låter dig definiera utlösta beteenden — saker som AI:n ska göra när den upptäcker specifika situationer i en konversation.

Vad AI Actions gör:

  • HTTP Request Actions — Anropa externa API:er när de utlöses. Till exempel kontrollera orderstatus i din backend, skapa ett supportärende eller slå upp kontoinformation — allt under konversationens gång.
  • MCP‑åtgärder: Anslut till Model Context Protocol-servrar för avancerade verktygsintegrationer (t.ex. Shopify-produktuppslagningar, anpassade databasfrågor).

Typiska användningsfall:

  • Slå upp information i realtid (orderstatus, kontouppgifter, lagersaldo) från dina backend-system under konversationer
  • Skapa ärenden, uppdatera CRM-poster eller utlösa workflows i externa system baserat på konversationskontext
  • Ge personliga rekommendationer genom att fråga din produktkatalog

Varje action har ett name, en description (för HTTP Request Actions talar beskrivningen om för AI:n när den ska utlösas) och en typspecifik konfiguration. Actions kan aktiveras/inaktiveras individuellt via API:et. Actions skapas och konfigureras fullständigt i Quickchat Dashboard — API:et tillhandahåller list-, uppdaterings- (aktivera/inaktivera) och borttagningsoperationer, samt dedikerade endpoints för att skapa och konfigurera MCP‑åtgärder.

Behörighetsomfång: read_all

GET https://app.quickchat.ai/v1/api/ai_actions

Terminal window
curl https://app.quickchat.ai/v1/api/ai_actions \
-H 'Authorization: Bearer <API_TOKEN>'

Response 200 OK

[
{
"id": 1,
"name": "Check Order Status",
"description": "Look up order status when customer asks about their order.",
"is_active": true,
"type": "http_request",
"icon": null,
"icon_color": null,
"is_valid": true
}
]
FieldDescription
id
integer
AI Action-identifierare
name
string
Visningsnamn
description
string
När aktionen utlöses
is_active
boolean
Om den är aktiverad
type
string
"http_request", "remote_mcp", "shopify_remote_mcp" eller "knowledge_base"
icon
string or null
Ikonidentifierare
icon_color
string or null
Ikonfärg
is_valid
boolean
Om den är korrekt konfigurerad
Behörighetsomfång: write_all

PATCH https://app.quickchat.ai/v1/api/ai_actions/{action_id}

Request Body

ParameterDescription
is_active
boolean
Aktivera/inaktivera aktionen
icon
string
Ikonidentifierare (max 200 tecken)
icon_color
string
Ikonfärg (max 50 tecken)
Terminal window
curl -X PATCH https://app.quickchat.ai/v1/api/ai_actions/1 \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{"is_active": false}'

Response 200 OK — Returnerar den uppdaterade AI Action-ögonblicksbilden.

Behörighetsomfång: write_all

DELETE https://app.quickchat.ai/v1/api/ai_actions/{action_id}

Terminal window
curl -X DELETE https://app.quickchat.ai/v1/api/ai_actions/1 \
-H 'Authorization: Bearer <API_TOKEN>'

Response 200 OK (tom body)

Behörighetsomfång: write_all

POST https://app.quickchat.ai/v1/api/ai_actions/remote_mcp

Ansluter en fjärr-MCP-server till din AI Agent som en MCP‑åtgärd. Kräver ett API-token med scope write_all (API-tokens kräver Business-planen eller högre).

Request Body

ParameterDescription
remote_mcp_url
string, required
MCP-serverns URL. Måste använda https://; URL:er som pekar på privata eller interna nätverksadresser avvisas
headers
array, required
Anslutningsheaders som skickas till servern, t.ex. ett statiskt Authorization-token. Varje post är {"id", "name", "value"} — välj valfri unik sträng som id. Skicka [] om servern inte behöver några
allowed_tools
array, required
Brytare per verktyg, var och en {"name", "is_active"}. Skicka [] för att låta default_tool_is_active styra verktygens tillgänglighet
name
string
Visningsnamn i åtgärdslistan (max 100 tecken). Standard är en etikett härledd från serverns värdnamn
description
string
Beskrivning som visas i åtgärdslistan (max 2500 tecken)
icon
string
Ikonidentifierare (max 200 tecken)
icon_color
string
Ikonfärg (max 50 tecken)

name och description är etiketter för operatörer: de identifierar åtgärden i dashboarden, och AI:n läser dem aldrig. AI:n arbetar utifrån verktygsbeskrivningarna som MCP-servern själv publicerar.

Terminal window
curl -X POST https://app.quickchat.ai/v1/api/ai_actions/remote_mcp \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"remote_mcp_url": "https://mcp.example.com/mcp",
"headers": [
{"id": "h-1", "name": "Authorization", "value": "Bearer <SERVER_TOKEN>"}
],
"allowed_tools": [],
"name": "Example MCP"
}'

Response 201 Created

{
"id": 2,
"name": "Example MCP",
"description": "Connected MCP server",
"is_active": false,
"type": "remote_mcp",
"icon": "FaMixcloud",
"icon_color": "#EF4444",
"is_valid": true,
"validation_issues": [],
"remote_mcp_url": "https://mcp.example.com/mcp",
"remote_mcp_auth_token": "",
"default_tool_is_active": true,
"allowed_tools": [],
"headers": [
{"id": 10, "name": "Authorization", "value": "Bearer <SERVER_TOKEN>"}
],
"oauth": null,
"recommended_tools": []
}
FieldDescription
remote_mcp_url
string
Den anslutna MCP-serverns URL
default_tool_is_active
boolean
Om verktyg som inte listas i allowed_tools får användas
allowed_tools
array
Brytare per verktyg, {"name", "is_active"}
headers
array
Lagrade anslutningsheaders
remote_mcp_auth_token
string or null
Äldre fält för ett statiskt token. Det kan inte sättas via detta API — skicka autentiseringsuppgifter via headers i stället
oauth
object or null
Auktoriseringsstatus för servrar anslutna med OAuth-inloggning (annars null)
recommended_tools
array
Verktygsnamn som Quickchat rekommenderar för servrar med en av Quickchat justerad profil (skrivskyddat)
validation_issues
array
Namnen på de konfigurationskontroller som misslyckats; tomt när is_valid är true

Övriga fält motsvarar List All AI Actions.

Åtgärden skapas med is_active: false. För servrar utan en av Quickchat justerad profil startar den dessutom med default_tool_is_active: true, så varje verktyg som upptäcks vid svarstillfället är tillåtet tills du begränsar det. För att slå på åtgärden använder du endpointen Update AI Action ovan: PATCH /v1/api/ai_actions/{action_id} med {"is_active": true}.

Behörighetsomfång: read_all

GET https://app.quickchat.ai/v1/api/ai_actions/{action_id}/remote_mcp

Terminal window
curl https://app.quickchat.ai/v1/api/ai_actions/2/remote_mcp \
-H 'Authorization: Bearer <API_TOKEN>'

Response 200 OK — Returnerar den MCP-specifika konfigurationen, i samma form som skapandesvaret ovan.

Behörighetsomfång: write_all

PATCH https://app.quickchat.ai/v1/api/ai_actions/{action_id}/remote_mcp

Alla fält är valfria; endast fälten du skickar ändras.

Request Body

ParameterDescription
remote_mcp_url
string
Ny server-URL (valideras som vid skapandet). Att ändra URL:en för en server ansluten med OAuth rensar den lagrade auktoriseringen och stänger av åtgärden
headers
array
Ersätter anslutningsheaders
allowed_tools
array
Ersätter brytarna per verktyg, var och en {"name", "is_active"}
default_tool_is_active
boolean
Om verktyg som inte listas i allowed_tools får användas
name
string
Visningsnamn (max 100 tecken)
description
string
Beskrivning som visas i åtgärdslistan (max 2500 tecken)
Terminal window
curl -X PATCH https://app.quickchat.ai/v1/api/ai_actions/2/remote_mcp \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"allowed_tools": [
{"name": "search_docs", "is_active": true},
{"name": "delete_page", "is_active": false}
],
"default_tool_is_active": false
}'

Response 200 OK — Returnerar den uppdaterade MCP‑åtgärden, i samma form som skapandesvaret.

Anslutningstest och verktygsupptäckt — dashboardens Connect-kontroll — är inte tillgängliga i det publika API:et. Dashboarden kör kontrollen automatiskt när du ansluter eller återansluter en server, och servrar skyddade av OAuth måste slutföra sin auktorisering i dashboarden; fältet oauth i svaren ovan rapporterar den statusen.