Clomni

Scope-lar və endpoint-lər: workspace, operatorlar, komandalar

Son yeniləmə: 11 noyabr 2026 · 10 dəq oxunur

Workspace məlumatı, AI krediti, audit jurnalı, operatorlar və komandalar üçün scope-lar. Hər scope-un nə icazə verdiyi, riski, yoxlaması və açdığı endpoint-lər aşağıdadır.

Addımlar

  1. 1

    Bu məqaləni necə oxumaq

    • Yollar https://api.clomni.ai/v1-dən sonra yazılır: GET /v1/agents tam ünvanda https://api.clomni.ai/v1/agents deməkdir. Yolda workspace ID yoxdur, çünki token bir workspace-ə bağlıdır.
    • Hər sorğuda Authorization: Bearer clomni_pat_xxx başlığı olur. Tokeni necə almaq: Developer API-də tokenlər və autentifikasiya.
    • Risk: aşağı (şəxsi məlumat yoxdur), orta (müştəri məlumatını oxuyur və ya daxili məlumatı dəyişir), yüksək (müştəriyə göndərir, silir, toplu çıxarır, canlı ayarı dəyişir).
    • Hər scope review-dan keçir, public app-da da. Ətraflı: Review: scope-ların yoxlanması və rədd səbəbləri.
    • «Əlavə verir»: write və manage eyni resursun read-ini də verir. send, delete, publish, assign, run heç nə vermir.
    • Endpoint bir neçə scope ilə açılırsa, onlardan biri kifayətdir. Scope çatmasa, API 403 insufficient_scope və cavabda required_scopes qaytarır.
    • Hər POST Idempotency-Key başlığı qəbul edir: təkrar sorğu ikinci dəfə icra olunmur.
  2. 2

    Workspace məlumatını oxumaq (workspace:read)

    Workspace-in adını, dilini, ayarlarını (məsələn avtomatik bağlama) və paket məlumatını oxuyur. İnteqrasiya hansı workspace-ə qoşulduğunu yoxlamaq üçün adətən bundan başlayır.

    • Risk: aşağı.
    • Yoxlama: review-dan keçir, aşağı riskli scope-lara tez baxılır.
    • Əlavə verir: başqa scope vermir.

    Endpoint-lər:

    • GET /v1/workspace: Workspace məlumatını oxumaq

    Nümunə:

    curl "https://api.clomni.ai/v1/workspace" \
  -H "Authorization: Bearer clomni_pat_xxx"
  3. 3

    Workspace ayarlarını dəyişmək (workspace:write)

    Workspace-in adını, dilini və avtomatik bağlama ayarını dəyişir. Ödəniş, paket və workspace-in silinməsi API ilə mümkün deyil. Inbox-un iş saatları bu scope ilə yox, inboxes:write ilə dəyişir.

    • Risk: orta.
    • Yoxlama: review-dan keçir. Bu icazə ilə hansı məlumatı, nə vaxt və nə üçün işlədəcəyinizi konkret yazın.
    • Əlavə verir: workspace:read də verir.

    Endpoint-lər:

    • PATCH /v1/workspace: Workspace ayarlarını dəyişmək

    Nümunə:

    curl -X PATCH "https://api.clomni.ai/v1/workspace" \
  -H "Authorization: Bearer clomni_pat_xxx" \
  -H "Content-Type: application/json" \
  -d '{"auto_resolve_after": 1440}'
  4. 4

    Paket və istifadəni oxumaq (billing:read)

    Workspace-in AI kredit balansını oxuyur: aylıq kredit, işlənən və qalan məbləğ, funksiyalar üzrə xərc. Kataloqda paket, istifadə və fakturalar da adlanır, amma hazırda bu scope-un yeganə endpoint-i AI kreditini göstərir.

    • Risk: orta.
    • Yoxlama: review-dan keçir. Bu icazə ilə hansı məlumatı, nə vaxt və nə üçün işlədəcəyinizi konkret yazın.
    • Əlavə verir: başqa scope vermir.

    Endpoint-lər:

    • GET /v1/ai_credits: AI kredit balansı

    Nümunə:

    curl "https://api.clomni.ai/v1/ai_credits" \
  -H "Authorization: Bearer clomni_pat_xxx"
  5. 5

    Audit jurnalını oxumaq (audit_logs:read)

    Audit jurnalını oxuyur: kim, nə vaxt, nəyi dəyişib. Ən yenisi əvvəl gəlir, səhifədə 15 yazı. Təhlükəsizlik və ya uyğunluq sisteminə köçürmək üçün işlədilir.

    • Risk: orta.
    • Yoxlama: review-dan keçir. Bu icazə ilə hansı məlumatı, nə vaxt və nə üçün işlədəcəyinizi konkret yazın.
    • Əlavə verir: başqa scope vermir.

    Endpoint-lər:

    • GET /v1/audit_logs: Audit jurnalı

    Nümunə:

    curl "https://api.clomni.ai/v1/audit_logs?page=1" \
  -H "Authorization: Bearer clomni_pat_xxx"
  6. 6

    Operatorları görmək (agents:read)

    Operator siyahısını, rollarını (administrator, agent) və onlayn statusunu oxuyur. Söhbəti kimə təyin edəcəyinizi seçmək və hesabatda adları göstərmək üçün lazımdır.

    • Risk: aşağı.
    • Yoxlama: review-dan keçir, aşağı riskli scope-lara tez baxılır.
    • Əlavə verir: başqa scope vermir.

    Endpoint-lər:

    • GET /v1/agents: Operator siyahısı
    • GET /v1/assignable_agents: Təyin oluna bilən operatorlar

    Nümunə:

    curl "https://api.clomni.ai/v1/agents" \
  -H "Authorization: Bearer clomni_pat_xxx"
  7. 7

    Operatorları idarə etmək (agents:manage)

    Operatoru dəvət edir (ona dəvət məktubu gedir), rolunu və statusunu dəyişir, workspace-dən çıxarır. Kadr sistemi ilə operator siyahısını avtomatik saxlamaq üçündür. Səhv sorğu operatorun girişini bağlaya bilər, ona görə yüksək riskdir.

    • Risk: yüksək.
    • Yoxlama: review-dan keçir və daha diqqətlə yoxlanır. Ətraflı izah və funksiyanı göstərən qısa video lazımdır, hədəf müddət 2 iş günüdür.
    • Əlavə verir: agents:read də verir.

    Endpoint-lər:

    • POST /v1/agents: Operator dəvət etmək
    • PATCH /v1/agents/{agent_id}: Operatorun rolunu və ya statusunu dəyişmək
    • DELETE /v1/agents/{agent_id}: Operatoru workspace-dən çıxarmaq

    Nümunə:

    curl -X POST "https://api.clomni.ai/v1/agents" \
  -H "Authorization: Bearer clomni_pat_xxx" \
  -H "Content-Type: application/json" \
  -d '{"name": "Kamran Əliyev", "email": "[email protected]", "role": "agent"}'
  8. 8

    Komandaları görmək (teams:read)

    Komandaları və onların üzvlərini oxuyur.

    • Risk: aşağı.
    • Yoxlama: review-dan keçir, aşağı riskli scope-lara tez baxılır.
    • Əlavə verir: başqa scope vermir.

    Endpoint-lər:

    • GET /v1/teams: Komanda siyahısı
    • GET /v1/teams/{team_id}: Komandanı oxumaq
    • GET /v1/teams/{team_id}/team_members: Komanda üzvləri

    Nümunə:

    curl "https://api.clomni.ai/v1/teams" \
  -H "Authorization: Bearer clomni_pat_xxx"
    curl "https://api.clomni.ai/v1/teams/3/team_members" \
  -H "Authorization: Bearer clomni_pat_xxx"
  9. 9

    Komandaları dəyişmək (teams:write)

    Komanda yaradır, dəyişir və silir, komandaya operator əlavə edir və çıxarır. PATCH /v1/teams/{team_id}/team_members üzvləri tam əvəz edir: komandada yalnız göndərilən istifadəçilər qalır.

    • Risk: orta.
    • Yoxlama: review-dan keçir. Bu icazə ilə hansı məlumatı, nə vaxt və nə üçün işlədəcəyinizi konkret yazın.
    • Əlavə verir: teams:read də verir.

    Endpoint-lər:

    • POST /v1/teams: Komanda yaratmaq
    • PATCH /v1/teams/{team_id}: Komandanı yeniləmək
    • DELETE /v1/teams/{team_id}: Komandanı silmək
    • POST /v1/teams/{team_id}/team_members: Komandaya operator əlavə etmək
    • PATCH /v1/teams/{team_id}/team_members: Komanda üzvlərini əvəz etmək
    • DELETE /v1/teams/{team_id}/team_members: Komandadan operator çıxarmaq

    Nümunə:

    curl -X POST "https://api.clomni.ai/v1/teams/3/team_members" \
  -H "Authorization: Bearer clomni_pat_xxx" \
  -H "Content-Type: application/json" \
  -d '{"user_ids": [12]}'
  10. 10

    Əlaqəli məqalələr

Sənəd

Developer platforması: bələdçi v1.0 · 41 səhifə Aç Endir