Ugrás a fő tartalomhoz

Áttekintés

Alap URL​

Minden API kérés a következő címre érkezik:

https://your-IntraCord-instance/api/v1

Ha a tárolt verziót használja, az alap URL a https://app.IntraCord.com/api/v1.

Verziószámítás​

Az API jelenlegi verziója a v1. A verzió szerepel az URL-útvonalban.

Kérelem formátuma​

Minden kéréstörzset JSON-ként kell elküldeni a Content-Type: application/json fejléccel.

curl -X POST https://your-IntraCord-instance/api/v1/workflow/create/definition \
  -H "Content-Type: application/json" \
  -H "X-API-Key: dg_your_api_key" \
  -d '{"name": "My Agent", "workflow_definition": {}}'

Válasz formátum​

Minden válasz JSON. A sikeres válaszok visszaküldik a megfelelő erőforrás-objektumot. A hibaválaszok következetes formát követnek:

{
  "detail": "Error message describing what went wrong"
}

Az érvényesítési hibák (422) esetében a részlet lehet egy lista:

{
  "detail": [
    {
      "loc": ["body", "name"],
      "msg": "field required",
      "type": "value_error.missing"
    }
  ]
}

Egészségügyi ellenőrzés​

Az API-hívások megkezdése előtt ellenőrizze, hogy a példány elérhető-e.

curl https://your-IntraCord-instance/api/v1/health
{
  "status": "ok",
  "version": "1.0.0",
  "backend_api_endpoint": "https://your-IntraCord-instance",
  "deployment_mode": "oss",
  "auth_provider": "local"
}