Agent Disable API

Bir agent'ı programatik olarak etkinleştirin veya devre dışı bırakın

Workspace'inizdeki bir agent'ı etkinleştirir veya devre dışı bırakır. Devre dışı bırakılan agent'lar yeniden etkinleştirilene kadar workspace üyeleri tarafından kullanılamaz.

Başlamadan önce

Legacy Assistants API: Bu, yerel Vercel AI SDK uyumluluğuna sahip yeni Agents API'dir. Eski Assistants API kullanıyorsanız migration guide sayfasına bakın.
Admin action: Bu bir yönetim eylemidir. Yalnızca workspace admin'leri veya uygun izinlere sahip kullanıcılar agent'ları disable/enable edebilir.

Base URL

https://api.ajan.io/agent/v1/disable

Dedicated deployments Tüm isteklerde api.ajan.com'u /api/public ile değiştirin.

Kullanım senaryoları

Bakım veya güncelleme gerektiren bir agent'ı geçici olarak disable etme
Daha önce disable edilmiş bir agent'ı yeniden enable etme
Rollout veya test sırasında agent kullanılabilirliğini kontrol etme

Parameters

Parameter	Type	Required	Description
`agentId`	string	Yes	Enable/disable edilecek agent'ın UUID'si
`disabled`	boolean	Yes	Disable için `true`, enable için `false`

Example

javascript

const axios = require("axios");

async function toggleAgentStatus(agentId, disabled) {
  const response = await axios.patch(
    "https://api.ajan.io/agent/v1/disable",
    {
      agentId: agentId,
      disabled: disabled
    },
    {
      headers: {
        Authorization: "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
      }
    }
  );

  console.log(`Agent ${disabled ? 'disabled' : 'enabled'}:`, response.data);
}

// Disable an agent
toggleAgentStatus("550e8400-e29b-41d4-a716-446655440000", true);

// Re-enable an agent
toggleAgentStatus("550e8400-e29b-41d4-a716-446655440000", false);

Response Format

Success Response (200 OK)

typescript

{
  status: "success";
  message: "Agent disabled successfully" | "Agent enabled successfully";
}

Error Handling

Status Code	Description
400	Geçersiz parametreler (eksik agentId veya disabled)
401	Geçersiz veya eksik API anahtarı
403	Agent'ları disable etmek için yetersiz izin
404	Agent bulunamadı veya API anahtarının erişimi yok
429	Rate limit aşıldı

Behavior

Bir agent disable edildiğinde:

Kullanıcılar agent ile yeni konuşmalar başlatamaz
Agent, normal kullanıcılar için agent library'de görünmez
Mevcut konuşmalar hâlâ görüntülenebilir ancak agent yanıt veremez
Admin'ler agent'ı hâlâ görüntüleyebilir ve yönetebilir
Agent istediğiniz zaman yeniden enable edilebilir

ajan, API anahtarınızı korumak ve uygulamalarınızın güvenliğini sağlamak için tarayıcı kaynaklı istekleri bilinçli olarak engeller. Daha fazla bilgi için API Key Best Practices kılavuzuna bakın.