Beceri API'sine Genel Bakış

Ajan çalışma alanınızda Becerileri programlı olarak oluşturun, içe aktarın ve yönetin

Skills API, Skills'i programlı bir şekilde yönetmenize olanak sağlar. Bir depodaki Becerileri senkronize etmek, saklanan dosyaları incelemek, yeniden kullanılabilir talimat setleri oluşturmak, erişilebilir entegrasyonlar eklemek ve SKILL.md dosyalarını veya zip arşivlerini içe aktarmak için bunu kullanın.

Temel URL

https://api.ajan.io

Özel dağıtımlar Tüm isteklerde api.ajan.com'yi /api/public ile değiştirin. Skills API istekleri hâlâ anahtarı oluşturan kullanıcı gibi davrandığından, bir Skill'i bir çalışma alanı API anahtarıyla paylaşmak o anahtarın görebileceği şeyleri değiştirmez.

API Anahtar Kapsamı

Tüm Skills API uç noktaları, SKILL_API kapsamına sahip bir API anahtarı gerektirir.

workspace settings'nizde SKILL_API kapsamına sahip bir çalışma alanı API anahtarı oluşturun. Kişisel API anahtarları bu API'yi çağıramaz. İstekler, Beceri ürün erişimi ve Beceri izinleri için anahtar sahibini kullanır.

Mevcut Uç Noktalar

Yöntem	Uç nokta	Açıklama
`GET`	`/skills/v1`	List Skills
`POST`	`/skills/v1`	Create a Skill
`GET`	`/skills/v1/{skillId}`	Get a Skill
`GET`	`/skills/v1/{skillId}/files`	Get a Skill file
`PATCH`	`/skills/v1/{skillId}`	Update a Skill
`DELETE`	`/skills/v1/{skillId}`	Delete a Skill
`POST`	`/skills/v1/import`	Import a Skill

Beceri Nesnesi

Skills API yanıtları, uç noktalarda aynı Skill nesnesini kullanır:

typescript

{
  id: string;
  name: string;
  slug: string;
  description: string;
  instructions: string;
  integrationIds: string[];
  createdAt: string;
  updatedAt: string;
}

Get Skill ayrıca depolanan dosya meta verilerini içeren bir files dizisi döndürür. Listeleme, oluşturma ve güncelleme yanıtları files'i içermez.

Desteklenen Beceri Türleri

API yalnızca kullanıcıların çalışma alanında oluşturduğu Becerileri yönetir. Sistem Becerileri, şablonlar ve Beceri Paketleri bu uç noktalar aracılığıyla iade edilmez veya değiştirilmez.

Öğe uç noktaları için Beceriyi id kullanın. slug alanı bir liste filtresi olarak ve içe aktarmalar için yukarı anahtar olarak desteklenir, ancak okuma, güncelleme ve silme işlemleri için skillId kullanılır.

İzinler

İstekler, izinler ve erişim için anahtar sahibini kullanır:

Eylem	Gerekli erişim
Dosyalar da dahil olmak üzere Becerileri listeleyin veya edinin	Beceriye izleyici erişimi
Beceriler oluşturun veya içe aktarma yoluyla oluşturun	`createSkills` çalışma alanı izni
Becerileri Güncelleyin veya içe aktarma yoluyla yükseltin	Beceriye editör erişimi
Becerileri Sil	Beceriye sahip erişimi veya yönetici erişimi

integrationIds ile entegrasyonlar eklerseniz, her entegrasyonun çalışma alanınızda etkinleştirilmesi gerekir.

Beceri görünürlüğü

Bir çalışma alanı API anahtarı, oluşturduğu Becerileri, çalışma alanıyla paylaşılan Becerileri ve bir çalışma alanı yöneticisinin bu anahtarla paylaştığı Becerileri listeleyebilir ve alabilir. Paylaş'ta bu erişime bir çalışma alanı yöneticisi izin verir.

Hız Limitleri

Skills API, standart API hız sınırlarına uyar. Limiti aşarsanız 429 yanıtı alırsınız. Bekleyin ve üstel geri çekilmeyle yeniden deneyin.

ajan, API anahtarınızı korumak ve uygulamalarınızın güvende kalmasını sağlamak için tarayıcı kaynaklı istekleri kasıtlı olarak engeller. Daha fazla bilgi için lütfen API Key Best Practices hakkındaki kılavuzumuza bakın.