Prompt Library API genel bakış

ajan workspace'inizde prompt'ları ve prompt klasörlerini programatik olarak oluşturun ve yönetin

Prompt Library API, prompt'ları ve prompt klasörlerini programatik olarak yönetmenizi sağlar. Bir depodan prompt senkronize etmek, şablonları toplu güncellemek ve klasör paylaşımını içerik iş akışınızla uyumlu tutmak için kullanın.

Base URL

https://api.ajan.io

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

API Key Scope

Tüm Prompt Library API endpoint'leri PROMPT_API kapsamına sahip bir API anahtarı gerektirir.

Workspace settings içinde PROMPT_API kapsamına sahip bir API anahtarı oluşturun. API, anahtarı oluşturan kullanıcı gibi davranır; Prompt Library erişimi ve paylaşım izinleri dahildir.

Kullanılabilir endpoint'ler

Method	Endpoint	Description
`GET`	`/prompts/v1`	List prompts
`POST`	`/prompts/v1`	Create a prompt
`GET`	`/prompts/v1/{promptId}`	Get a prompt
`PATCH`	`/prompts/v1/{promptId}`	Update a prompt
`DELETE`	`/prompts/v1/{promptId}`	Delete a prompt
`GET`	`/prompts/v1/folders`	List prompt folders
`POST`	`/prompts/v1/folders`	Create a prompt folder
`GET`	`/prompts/v1/folders/{folderId}`	Get a prompt folder
`PATCH`	`/prompts/v1/folders/{folderId}`	Update a prompt folder
`DELETE`	`/prompts/v1/folders/{folderId}`	Delete a prompt folder

Prompt Object

Prompt endpoint'leri aynı prompt nesnesini döndürür:

typescript

{
  id: string;
  title: string;
  prompt: string;
  createdBy: string | null;
  promptFolderId: string | null;
  sharedWithWorkspace: boolean;
  createdAt: string | null;
  updatedAt: string | null;
}

Folder Object

Folder endpoint'leri aynı folder nesnesini döndürür:

typescript

{
  id: string;
  name: string;
  createdBy: string;
  sharedWithWorkspace: boolean;
  sharedWithGroupId: string | null;
  createdAt: string;
  updatedAt: string;
}

Permissions

İstekler, izin ve erişim için API anahtarını oluşturan kullanıcıyı kullanır:

Action	Required access
List or get prompts	Sahiplik, workspace paylaşımı veya paylaşılan klasör üzerinden erişim
Create prompts	Aktif workspace üyeliği
Update or delete prompts	Oluşturan, workspace editor veya prompt klasörünün group editor'ü
Share a prompt with the workspace	`sharePrompts` izni
List or get folders	Sahiplik, workspace paylaşımı veya group paylaşımı üzerinden erişim
Create folders	Aktif workspace üyeliği
Update folders	Oluşturan, workspace editor, workspace-paylaşımlı klasörler için `sharePrompts` veya group editor
Delete folders	Oluşturan, workspace editor veya group editor

Bir prompt aynı anda hem workspace ile paylaşılamaz hem de bir klasöre atanamaz. Bir klasör aynı anda hem workspace hem de bir group ile paylaşılamaz. Bir klasörü silmek içindeki prompt'ları da siler.

Private klasörler yalnızca oluşturana aittir. Klasörlerin workspace paylaşımı sharePrompts iznini veya workspace editor erişimini kullanır.

Rate Limits

Prompt Library API standart API rate limit'lerini izler. Limiti aşarsanız 429 yanıtı alırsınız. Bekleyin ve exponential backoff ile yeniden deneyin.

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.