API-referencia

Hozz létre egyéni integrációkat az Asyntai REST API segítségével

Fizetős csomag szükséges: Az API-hozzáférés elérhető a Starter, Standard és Pro csomagokban. Árak megtekintése

Áttekintés

The Asyntai API allows you to integrate AI-powered customer support into any application. Send messages and receive intelligent responses grounded in your website content and knowledge base.

Hitelesítés

Minden API-kérés hitelesítést igényel az API-kulcsod használatával. Az API-kulcsodat az API-beállítások oldalon szerezheted meg.

Add meg az API-kulcsot a kérésekben az alábbi módszerek egyikével:

Authorization fejléc (ajánlott): Authorization: Bearer YOUR_API_KEY
X-API-Key fejléc: X-API-Key: YOUR_API_KEY

Tartsd titokban az API-kulcsodat. Bárki, aki rendelkezik a kulcsoddal, hozzáférhet a fiókodhoz az API-n keresztül. Soha ne tedd közzé kliensoldali kódban.

Alap URL

https://asyntai.com/api/v1/

Végpontok

POST /chat/

Küldj üzenetet és fogadj AI által generált választ.

Kérés törzse

{
  "message": "What are your business hours?",
  "session_id": "user_123",      // optional
  "website_id": 1                 // optional
}

Paraméter	Típus	Kötelező	Leírás
`message`	string	Igen	A felhasználó AI-nak küldött üzenete
`session_id`	string	Nem	A beszélgetés egyedi azonosítója. Ugyanazt a session_id értéket használd a beszélgetési előzmények megőrzéséhez.
`website_id`	integer	Nem	Konkrét weboldal-azonosító. Ha nincs megadva, az elsődleges weboldalt használja.

Válasz

{
  "success": true,
  "response": "Our business hours are Monday-Friday, 9 AM to 5 PM EST.",
  "session_id": "user_123"
}

Példa (cURL)

curl -X POST https://asyntai.com/api/v1/chat/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "What are your business hours?", "session_id": "user_123"}'

Példa (Python)

import requests

response = requests.post(
    "https://asyntai.com/api/v1/chat/",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
        "message": "What are your business hours?",
        "session_id": "user_123"
    }
)

data = response.json()
print(data["response"])

Példa (JavaScript)

const response = await fetch("https://asyntai.com/api/v1/chat/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    message: "What are your business hours?",
    session_id: "user_123"
  })
});

const data = await response.json();
console.log(data.response);

GET /websites/

Az összes weboldal listázása, amely a fiókodhoz kapcsolódik.

Válasz

{
  "success": true,
  "websites": [
    {
      "id": 1,
      "name": "My Website",
      "domain": "example.com",
      "is_primary": true
    }
  ]
}

Példa (cURL)

curl https://asyntai.com/api/v1/websites/ \
  -H "Authorization: Bearer YOUR_API_KEY"

POST /websites/

Create a new AI agent. This does the same thing as adding a website in your dashboard: it makes the agent, reads your site, and writes the first draft of the AI instructions.

Use this to set up customers from your own software. You get back the widget ID and the code to put on the website.

Kérés törzse

Mező	Típus	Leírás
`domain`	string	Required. The website address, for example example.com
`name`	string	Optional. A display name for the agent. Useful when one website has several agents.
`crawl`	boolean	Optional, true by default. Set it to false to create the agent without reading the website. Nothing is crawled and no instructions are written.
`force`	boolean	Optional, false by default. Set it to true to add a website you already have. The copy is stored with a number after it.

Válasz

{
  "success": true,
  "website": {
    "id": 42,
    "domain": "example.com",
    "name": "Support agent",
    "widget_id": "asyntai_ab12cd34ef56",
    "is_primary": true,
    "crawl_started": true,
    "instructions_status": "generating",
    "job_id": "8f2c1e90-..."
  },
  "embed_code": "<script>...</script>"
}

Példa (cURL)

curl -X POST https://asyntai.com/api/v1/websites/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain": "example.com", "name": "Support agent"}'

Reading a website takes a few minutes, so this call answers straight away. Check when the agent is ready with the next endpoint.

Errors

Code	Meaning
`403`	You have reached the number of websites your plan allows. The answer tells you the limit.
`409`	Your account already has this website. Send force as true to add it again.

GET /websites/{id}/

Get one website and see whether it is ready. Use this after you create an agent, to wait until the website has been read and the AI instructions are written.

Válasz

{
  "success": true,
  "website": {
    "id": 42,
    "domain": "example.com",
    "name": "Support agent",
    "widget_id": "asyntai_ab12cd34ef56",
    "is_primary": true,
    "created_at": "2026-08-11T09:12:00+00:00",
    "ready": true,
    "instructions": {
      "status": "completed",
      "has_instructions": true,
      "characters": 3421
    },
    "crawl": {
      "job_id": "8f2c1e90-...",
      "status": "completed",
      "pages_crawled": 47,
      "pages_found": 50,
      "max_pages": 50,
      "completed_at": "2026-08-11T09:15:31+00:00",
      "error": ""
    },
    "knowledge_items": 47
  },
  "embed_code": "<script>...</script>"
}

The ready field is true when nothing is still running. A crawl that failed also counts as ready, because it has finished. Look at the crawl status to see what happened.

Példa (cURL)

curl https://asyntai.com/api/v1/websites/42/ \
  -H "Authorization: Bearer YOUR_API_KEY"

GET PATCH /websites/{id}/settings/

Read or change the chat widget settings for one website. These are the same settings you see on the Customize page: colours, the name of the assistant, the first message, lead capture, and everything else.

Reading the settings

A GET request returns every setting with its current value, plus a locked list. Locked shows the settings your plan cannot change, and which plans they need.

{
  "success": true,
  "settings": {
    "ai_support_name": "AI Assistant",
    "widget_color": "#6366f1",
    "initial_message": "Hi, how can I help you?",
    "hide_branding": false,
    "...": "..."
  },
  "locked": {
    "hide_branding": ["pro", "enterprise"],
    "widget_style": ["pro", "enterprise"]
  }
}

Changing the settings

A PATCH request changes only the settings you send. Everything you leave out stays as it is.

curl -X PATCH https://asyntai.com/api/v1/websites/42/settings/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ai_support_name": "Ava", "widget_color": "#0f172a", "use_emoji": true}'

{
  "success": true,
  "updated": ["ai_support_name", "use_emoji", "widget_color"],
  "settings": { "...": "..." },
  "locked": { "...": "..." }
}

Plans

Each setting needs its own plan, the same as in the dashboard. For example, hiding the Asyntai branding needs the Pro plan, and voice input needs Standard.

Plan needed	Beállítások	Examples
Any paid plan	25	`widget_color`, `ai_support_name`, `initial_message`
Starter és magasabb	22	`profile_picture`, `conversation_starters_enabled`
Standard és magasabb	25	`speech_to_text_enabled`, `image_vision_enabled`, `escalation_enabled`
Pro	6	`hide_branding`, `widget_style`

If you send a setting your plan does not allow, the whole request is refused with code 403 and nothing is saved. The same happens if any value is wrong, for example a colour that is not a hex code. Your settings never end up half changed.

GET PUT /websites/{id}/instructions/

Read or replace the AI instructions for one website. These are the rules that tell the assistant who it is, what it may say, and what it must not say. They are the same instructions you edit in the dashboard.

Reading

{
  "success": true,
  "instructions": "You are the support agent for Acme Tools...",
  "characters": 1979,
  "version": 7,
  "mode": "instructions",
  "ask_questions": true,
  "generation_status": "completed",
  "being_edited_by": null
}

Replacing

A PUT request replaces the whole text, the same as saving in the dashboard. There is no append mode. To add a paragraph, read the instructions, add your text, then write it back.

curl -X PUT https://asyntai.com/api/v1/websites/42/instructions/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"instructions": "You are the support agent for Acme Tools...", "version": 7}'

Kérés törzse

Mező	Típus	Leírás
`instructions`	string	Required. The complete new text. It replaces everything that was there.
`version`	number	Optional but recommended. The version you read. If somebody changed the instructions since then, your write is refused instead of overwriting their work.
`mode`	string	Optional. Either instructions or general.
`ask_questions`	boolean	Optional. Whether the assistant asks a follow-up question at the end of its answers.
`force`	boolean	Optional, false by default. Needed only when your new text is less than half the length of the current text.

How your instructions are protected

Instructions can take hours to write, so a write can be refused to protect them:

Code	Meaning
`400`	Your new text is less than half the length of the current text. This catches a script that sends empty or cut-off text over instructions somebody spent hours on. Send force as true if you meant it.
`409`	The instructions changed after you read them. Read them again, apply your change, then write.
`423`	Somebody is editing the instructions in the dashboard right now. The answer tells you who. Try again in a couple of minutes.

Every change also saves a copy of the previous text, so an earlier version can always be restored from the dashboard.

GET /conversations/

Egy adott munkamenet beszélgetési előzményeinek lekérése.

Lekérdezési paraméterek

Paraméter	Típus	Kötelező	Leírás
`session_id`	string	Igen	A munkamenet-azonosító, amelyhez az előzményeket le kell kérni
`limit`	integer	Nem	Visszaadandó üzenetek maximuma (alapértelmezett: 50, maximum: 100)

Válasz

{
  "success": true,
  "session_id": "user_123",
  "messages": [
    {
      "role": "user",
      "content": "What are your business hours?",
      "timestamp": "2024-01-15T10:30:00Z"
    },
    {
      "role": "assistant",
      "content": "Our business hours are Monday-Friday, 9 AM to 5 PM EST.",
      "timestamp": "2024-01-15T10:30:01Z",
      "sender_type": "ai",
      "agent_name": null,
      "response_time_ms": 1840.5
    }
  ]
}

A kérdés és a válasza egyetlen rekordban tárolódik, ezért mindkettő ugyanazt a timestamp értéket viseli. Ne vonja ki egyiket a másikból a válaszsebesség méréséhez, mert az eredmény mindig nulla. Használja a response_time_ms mezőt, amely a válasz tényleges ideje ezredmásodpercben.

A sender_type értéke ai, ha a chatbot válaszolt, és human, ha az egyik ügyintézője vette át a beszélgetést. Az agent_name az adott ügyintéző megjelenített nevét tartalmazza.

Példa (cURL)

curl "https://asyntai.com/api/v1/conversations/?session_id=user_123&limit=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

GET /sessions/

Listázd a legutóbbi chat-munkameneteidet. Ezzel felfedezheted a munkamenet-azonosítókat, amelyeket átadhatsz a /conversations/ végpontnak a teljes üzenettörténet lekéréséhez.

Lekérdezési paraméterek

Paraméter	Típus	Kötelező	Leírás
`limit`	integer	Nem	Visszaadandó munkamenetek száma (alapértelmezett: 20, maximum: 100)
`website_id`	string	Nem	Munkamenetek szűrése adott weboldal-azonosító alapján
`source`	string	Nem	Szűrés munkamenet forrás szerint: `widget`, `api`, `whatsapp`, `instagram`, `messenger`, `gorgias`, `freshchat`, `zapier`

Válasz

{
  "success": true,
  "sessions": [
    {
      "session_id": "session_abc123def",
      "source": "widget",
      "message_count": 5,
      "first_message": "What are your business hours?",
      "first_message_at": "2024-01-15T10:30:00Z",
      "last_message_at": "2024-01-15T10:35:00Z",
      "first_response_time_ms": 1840.5,
      "first_human_response_at": null,
      "started_at": "2024-01-15T10:29:58Z",
      "ended_at": "2024-01-15T10:41:12Z",
      "taken_over_at": null,
      "website_domain": "example.com"
    }
  ]
}

Időbélyeg mezők jelentésekhez

Mező	Leírás
`started_at`	Mikor nyitotta meg a látogató a beszélgetést. Csak widget munkamenetekhez érhető el, mert az API-n keresztül létrehozott munkamenetek soha nem nyitnak widgetet.
`first_message_at`	Mikor mentettük el a beszélgetés első üzenetét.
`first_response_time_ms`	Mennyi ideig tartott az első válasz, ezredmásodpercben. Ezt használja az első válaszidőhöz.
`first_human_response_at`	Mikor küldte az egyik ügyintézője az első választ. Az érték `null`, ha a chatbot kezelte a teljes beszélgetést.
`taken_over_at`	Mikor vette át egy ügyintéző a beszélgetést a chatbottól.
`last_message_at`	Mikor mentettük el a beszélgetés utolsó üzenetét.
`ended_at`	Mikor hagyta el a látogató a beszélgetést. A beszélgetésnek nincs megoldott vagy lezárt állapota, mert a látogató bármikor visszatérhet és újabb kérdést tehet fel.

Minden időbélyeg UTC szerinti, és ISO 8601 formátumot használ. Az időzónát nem lehet módosítani. Váltsa át az értékeket a saját jelentéskészítő eszközében.

Példa (cURL)

curl "https://asyntai.com/api/v1/sessions/?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

GET /leads/

Gyűjtött érdeklődők lekérése — a látogatók által a chat-beszélgetések során megadott e-mail-címek és telefonszámok.

Lekérdezési paraméterek

Paraméter	Típus	Kötelező	Leírás
`limit`	integer	Nem	Visszaadandó érdeklődők száma (alapértelmezett: 50, max: 100)
`website_id`	string	Nem	Érdeklődők szűrése adott weboldal-azonosító alapján

Válasz

{
  "success": true,
  "leads": [
    {
      "session_id": "session_abc123def",
      "email": "[email protected]",
      "phone": "+1234567890",
      "page_url": "https://example.com/pricing",
      "started_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Mező	Típus	Leírás
`session_id`	string	A chat munkamenet azonosítója. Adja át a `/conversations/`-nak a teljes chat előzmények megtekintéséhez.
`email`	karakterlánc vagy null	A látogató által megadott e-mail-cím, vagy null ha nem lett gyűjtve
`phone`	karakterlánc vagy null	A látogató által megadott telefonszám, vagy null ha nem lett gyűjtve
`page_url`	karakterlánc vagy null	Az oldal URL-je, ahol a látogató csevegett
`started_at`	string	ISO 8601 időbélyeg a chat munkamenet kezdetéről

Példa (cURL)

curl "https://asyntai.com/api/v1/leads/?limit=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

Példa (Python)

import requests

response = requests.get(
    "https://asyntai.com/api/v1/leads/",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"limit": 20}
)

leads = response.json()["leads"]
for lead in leads:
    print(f"{lead['email'] or ''} | {lead['phone'] or ''}")

GET /account/

Fiókadataid és használati statisztikáid lekérése.

Válasz

{
  "success": true,
  "account": {
    "email": "[email protected]",
    "plan": "starter",
    "messages_used": 150,
    "messages_limit": 2500
  }
}

Példa (cURL)

curl https://asyntai.com/api/v1/account/ \
  -H "Authorization: Bearer YOUR_API_KEY"

Több weboldal? A tudásbázis-végpontok alapértelmezés szerint az elsődleges weboldaladat használják. Ha több weboldallal rendelkezel, add át a következőt: website_id egy adott kiválasztásához. A weboldal-azonosítókat megtalálhatod a GET /websites/.

Napi feltöltési korlátok: A tudásbázis-feltöltések (szöveg, URL, táblázat) napi karakterkorlátnak vannak alávetve a csomagtól függően. Ez az összes tudásbázis-végponton naponta feltöltött teljes tartalomra vonatkozik.

Csomag	Karakter/nap
Starter	300 000
Standard	1 500 000
Pro	6 000 000

GET /knowledge/

A tudásbázis-bejegyzések listázása. Ezek azok a tartalomforrások, amelyeket az AI chatbot a kérdések megválaszolásához használ.

Lekérdezési paraméterek

Paraméter	Típus	Kötelező	Leírás
`limit`	integer	Nem	Visszaadandó bejegyzések száma (alapértelmezett: 50, maximum: 100)
`website_id`	string	Nem	Szűrés weboldal-azonosító alapján (alapértelmezett: az elsődleges weboldal)

Válasz

{
  "success": true,
  "entries": [
    {
      "id": "abc-123-def",
      "type": "text",
      "title": "Business Hours",
      "description": "Manual text content (150 words)",
      "created_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": "ghi-456-jkl",
      "type": "url",
      "title": "About Us - Example",
      "description": "Content from https://example.com/about",
      "created_at": "2024-01-14T09:00:00Z"
    }
  ]
}

Példa (cURL)

curl "https://asyntai.com/api/v1/knowledge/?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

POST /knowledge/text/

Adj hozzá egyéni szöveges tartalmat a tudásbázisodhoz. Az AI ezt fogja felhasználni a látogatói kérdések megválaszolásához.

Kérés törzse

{
  "title": "Return Policy",
  "content": "We offer a 30-day return policy on all items. Items must be unused and in original packaging. Refunds are processed within 5-7 business days.",
  "website_id": "123"
}

Paraméter	Típus	Kötelező	Leírás
`title`	string	Igen	Cím ehhez a tudásbázis-bejegyzéshez
`content`	string	Igen	A szöveges tartalom (minimum 10 karakter)
`website_id`	string	Nem	Célweboldal (alapértelmezett: az elsődleges weboldal)

Válasz

{
  "success": true,
  "id": "abc-123-def",
  "title": "Return Policy",
  "chunks_created": 1
}

Példa (cURL)

curl -X POST "https://asyntai.com/api/v1/knowledge/text/" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "Return Policy", "content": "We offer a 30-day return policy..."}'

POST /knowledge/url/

Adj hozzá egy weboldalt a tudásbázisodhoz. A tartalmat automatikusan lekéri és kinyeri a rendszer.

Kérés törzse

{
  "url": "https://example.com/faq",
  "website_id": "123"
}

Paraméter	Típus	Kötelező	Leírás
`url`	string	Igen	Az URL, amelyről a tartalmat le kell kérni
`website_id`	string	Nem	Célweboldal (alapértelmezett: az elsődleges weboldal)

Válasz

{
  "success": true,
  "id": "abc-123-def",
  "title": "FAQ - Example",
  "url": "https://example.com/faq",
  "chunks_created": 5
}

Példa (cURL)

curl -X POST "https://asyntai.com/api/v1/knowledge/url/" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/faq"}'

POST /knowledge/spreadsheet/

Tölts fel egy CSV vagy Excel (.xlsx) táblázatot a tudásbázisodhoz. Minden sor külön tudásbázis-bejegyzés lesz, ami ideális termékkatalógusokhoz, GYIK-listákhoz, ártáblázatokhoz és könyvtárakhoz.

Kérés

Küldje multipart/form-data formátumban (fájlfeltöltés), ne JSON-ként.

Paraméter	Típus	Kötelező	Leírás
`file`	fájl	Igen	Egy .csv vagy .xlsx fájl. Az első sornak oszlopfejléceknek kell lennie. Feltöltésenkénti maximális sorok: Starter 500, Standard 2 000, Pro 10 000. A felesleges sorokat a rendszer levágja.
`website_id`	string	Nem	Célweboldal (alapértelmezett: az elsődleges weboldal)

Válasz

{
  "success": true,
  "id": "abc-123-def",
  "title": "products.csv",
  "rows_processed": 15,
  "chunks_created": 15
}

Példa (cURL)

curl -X POST "https://asyntai.com/api/v1/knowledge/spreadsheet/" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "[email protected]"

GET /knowledge/{id}/

Olvasson be egy tudásbázis-bejegyzést a hozzá tárolt szöveggel együtt. Az id érték a GET /knowledge/ válaszából származik.

A tartalom azoknál a bejegyzéseknél kerül visszaadásra, amelyeket Ön adott hozzá: szöveg, fájlok, táblázatok, egyedi URL-ek és videók. A webhely-bejárás szerepel a listán, de az oldalai nem kerülnek visszaadásra, mert a forrás az Ön saját nyilvános webhelye. Ilyenkor a content értéke null, és a reason mező adja meg az okát.

Válasz

{
  "success": true,
  "id": "abc-123-def",
  "type": "text",
  "title": "Business Hours",
  "description": "Manual text content (150 words)",
  "created_at": "2024-01-15T10:30:00Z",
  "chunks_count": 3,
  "content": "We are open Monday to Friday, 9am to 5pm...",
  "content_available": true,
  "char_count": 43
}

Példa (cURL)

curl "https://asyntai.com/api/v1/knowledge/abc-123-def/" \
  -H "Authorization: Bearer YOUR_API_KEY"

DELETE /knowledge/{id}/

Tudásbázis-bejegyzés törlése. Az id a GET /knowledge/ válaszban található.

Válasz

{
  "success": true,
  "message": "Knowledge base entry deleted"
}

Példa (cURL)

curl -X DELETE "https://asyntai.com/api/v1/knowledge/abc-123-def/" \
  -H "Authorization: Bearer YOUR_API_KEY"

Tipp: A webhookokat a következő helyről is kezelheted: API-beállítások oldal kód írása nélkül.

GET /webhooks/

A regisztrált webhookjaid listázása.

Válasz

{
  "success": true,
  "webhooks": [
    {
      "id": "abc-123-def",
      "url": "https://example.com/webhook",
      "events": ["message.received", "escalation.requested"],
      "is_active": true,
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Példa (cURL)

curl "https://asyntai.com/api/v1/webhooks/" \
  -H "Authorization: Bearer YOUR_API_KEY"

POST /webhooks/

Regisztrálj egy új webhookot a valós idejű eseményértesítések fogadásához.

Elérhető események

Esemény	Leírás
`message.received`	Egy látogató üzenetet küldött és választ kapott
`conversation.started`	Új chat-munkamenet indult
`escalation.requested`	Az AI eszkalációt kezdeményezett egy emberi ügynökhöz
`takeover.started`	Egy emberi ügynök átvette a chat-munkamenetet

Kérés törzse

{
  "url": "https://example.com/webhook",
  "events": ["message.received", "escalation.requested"],
  "website_id": "123"
}

Paraméter	Típus	Kötelező	Leírás
`url`	string	Igen	A HTTPS URL a webhook POST kérések fogadásához
`events`	tömb	Igen	Az előfizetendő események listája (lásd a fenti táblázatot)
`website_id`	string	Nem	Célweboldal (alapértelmezett: az elsődleges weboldal)

Válasz

{
  "success": true,
  "webhook": {
    "id": "abc-123-def",
    "url": "https://example.com/webhook",
    "events": ["message.received", "escalation.requested"],
    "secret": "whsec_abc123...",
    "created_at": "2024-01-15T10:30:00Z"
  }
}

Webhookok ellenőrzése: Minden webhook tartalmaz egy secret (csak létrehozáskor látható). Minden URL-re küldött POST tartalmaz egy X-Webhook-Signature fejlécet – a kéréstörzs HMAC-SHA256 aláírása a titkos kulcsoddal.

Példa (cURL)

curl -X POST "https://asyntai.com/api/v1/webhooks/" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/webhook", "events": ["message.received"]}'

DELETE /webhooks/{id}/

Webhook törlése. Az id a GET /webhooks/ válaszban található.

Válasz

{
  "success": true,
  "message": "Webhook deleted"
}

Példa (cURL)

curl -X DELETE "https://asyntai.com/api/v1/webhooks/abc-123-def/" \
  -H "Authorization: Bearer YOUR_API_KEY"

Hibaválaszok

Minden hibaválasz ezt a formátumot követi:

{
  "success": false,
  "error": "Error message describing what went wrong"
}

Állapotkód	Leírás
`400`	Rossz kérés – Érvénytelen paraméterek vagy hiányzó kötelező mezők
`401`	Jogosulatlan – Érvénytelen vagy hiányzó API-kulcs
`429`	Túl sok kérés – Elérted a csomagod üzenetkorlátját
`503`	Szolgáltatás nem elérhető – Az AI-szolgáltatás átmenetileg nem elérhető

Forgalmi korlátok

Az API-használatot az előfizetési csomag korlátozza:

Free: 100 üzenet/hó
Starter (39$/hó): 2 500 üzenet/hó
Standard (139$/hó): 15 000 üzenet/hó
Pro (449$/hó): 50 000 üzenet/hó

Segítségre van szükséged?

Ha bármilyen kérdésed van vagy problémába ütközöl, lépj kapcsolatba velünk a [email protected] e-mail-címen.

Dokumentáció

API-referencia

Áttekintés

Hitelesítés

Alap URL

Végpontok

POST /chat/

Kérés törzse

Válasz

Példa (cURL)

Példa (Python)

Példa (JavaScript)

GET /websites/

Válasz

Példa (cURL)

POST /websites/

Kérés törzse

Válasz

Példa (cURL)

Errors

GET /websites/{id}/

Válasz

Példa (cURL)

GET PATCH /websites/{id}/settings/

Reading the settings

Changing the settings

Plans

GET PUT /websites/{id}/instructions/

Reading

Replacing

Kérés törzse

How your instructions are protected

GET /conversations/

Lekérdezési paraméterek

Válasz

Példa (cURL)

GET /sessions/

Lekérdezési paraméterek

Válasz

Időbélyeg mezők jelentésekhez

Példa (cURL)

GET /leads/

Lekérdezési paraméterek

Válasz

Példa (cURL)

Példa (Python)

GET /account/

Válasz

Példa (cURL)

GET /knowledge/

Lekérdezési paraméterek

Válasz

Példa (cURL)

POST /knowledge/text/

Kérés törzse

Válasz

Példa (cURL)

POST /knowledge/url/

Kérés törzse

Válasz

Példa (cURL)

POST /knowledge/spreadsheet/

Kérés

Válasz

Példa (cURL)

GET /knowledge/{id}/

Válasz

Példa (cURL)

DELETE /knowledge/{id}/

Válasz

Példa (cURL)

GET /webhooks/

Válasz

Példa (cURL)

POST /webhooks/

Elérhető események

Kérés törzse

Válasz

Példa (cURL)

DELETE /webhooks/{id}/