Hızlı başlangıç
Bir RunAPI yönetim anahtarıyla standart API anahtarları ve koruyucu önlemler oluşturun ve yönetin.
Platform Yönetimi, hesap yöneticilerinin her değişiklik için gösterge panosunu kullanmak zorunda kalmadan standart API anahtarları ve güvenlik duvarları oluşturmasına, incelemesine, güncellemesine ve iptal etmesine olanak tanır.
Bir yönetim anahtarı oluşturun
Oturum açmak için Kimlik Doğrulama Kılavuzu‘nu takip edin, ardından Yönetim Anahtarları sayfasını açın ve bir yönetim anahtarı oluşturun. Bunu standart uygulama anahtarlarından ayrı saklayın. Yalnızca Platform Yönetimi uç noktalarına bearer token olarak gönderin.
Authorization: Bearer YOUR_MANAGEMENT_KEY
Standart bir API anahtarı, anahtar veya koruma kuralı yönetim uç noktalarını çağıramaz. Geçerli bir yönetim anahtarı, sahibi artık gerekli hesap rolüne sahip değilse 403 Forbidden yanıtı alabilir.
Standart API anahtarlarını listele
Yönetim anahtarının hesabına görünen anahtarları incelemek için GET /api/v1/keys kullanın:
curl "https://runapi.ai/api/v1/keys" \
-H "Authorization: Bearer YOUR_MANAGEMENT_KEY"
Sonraki alma, güncelleme, iptal etme veya koruma kuralı atama istekleri için döndürülen genel tanımlayıcıları kullanın. Erişimi hiçbir zaman bir anahtar adından veya maskelenmiş bir token’dan çıkarmayın.
Anahtar oluşturma ve döndürme
POST /api/v1/keys ile bir uygulama anahtarı oluşturun. Tam sır yalnızca oluşturma yanıtında döndürülür; bu nedenle yanıtı silmeden önce sır yöneticinize kaydedin. Rotasyon; bir yedek oluşturmalı, uygulamaya dağıtmalı, trafiği doğrulamalı ve ardından eski anahtarı iptal etmelidir.
curl -X POST "https://runapi.ai/api/v1/keys" \
-H "Authorization: Bearer YOUR_MANAGEMENT_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Production worker","tags":["env:production","dept:ml","project:chatbot"]}'
credit_limit_windows, 1h, 1d ve 7d‘nin herhangi bir kombinasyonunu
kabul eder. Yapılandırılmış herhangi bir pencere tükenirse, bu anahtara sahip
çağrılar, kullanım pencereden çıkana kadar 429 Too Many Requests döndürür.
Bir anahtarı güncellerken tüm dönen limitleri temizlemek için boş bir nesne gönderin.
Bir oluşturma isteği tüm harcama limiti alanlarını ve guardrail_id alanını atladığında yeni anahtar, çalışma alanının varsayılan yönetişim ayarlarını kullanır. Açıkça belirtilen limitler, kayan zaman aralıkları veya bir guardrail bu varsayılan seçimin yerini alır. Sınırsız bir yerel limit oluşturmak için credit_limit_cents: null gönderin. Sıfırlama aralığı olmadan belirtilen tutar, ömür boyu limit olarak kalır. Güncellemeler çalışma alanının varsayılanlarını yeniden uygulamaz ve varsayılanların değiştirilmesi mevcut anahtarları değiştirmez.
Oluşturma ve güncelleme, tam key:value dizelerinden oluşan tags dizisini kabul eder. Listeleme, getirme, oluşturma ve güncelleme yanıtları dizinin tamamını döndürür. PATCH diziyi değiştirir; tags alanının atlanması diziyi korur. Anahtar 1–32, değer 1–64 karakter olmalı; tam bir iki nokta üst üste içermeli ve boşluk karakteri içermemelidir. Hazır etiketler dahil en fazla 20 farklı etiket kabul edilir. Geçersiz biçimler veya çakışan hazır etiketler, etiket doğrulama hatalarıyla 422; dizi olmayan değer veya dize olmayan öğe 400 döndürür.
Tam olarak bir amaç etiketi gerekir: usage:developer veya usage:service. Management API ile oluşturma, amaç belirtilmezse tags: [] dahil usage:service ekler. Dashboard ile oluşturma ve amaç içermeyen etiket güncellemeleri usage:developer kullanır. Mevcut anahtarlar Developer olarak taşınır. Ortam isteğe bağlıdır ve env:production, env:staging veya env:dev seçeneklerinden en fazla birini kabul eder (env:prod kabul edilmez).
Dashboard oluşturma/düzenleme, amaç ve ortam kısayolları, özel etiketler ve yalnızca mevcut çalışma alanındaki silinmemiş standart anahtarlardan öneriler sunar. Listeler değerleri, üzerine gelindiğinde tam etiketi gösterir. Etiketler anahtarın sahipliğini, görünürlüğünü veya izinlerini değiştirmez. Bir anahtarı paylaşılan bir etiket bütçesine bağlayabilirler.
Çalışma alanı yöneticileri, üyenin zorunlu etiketlerini Ekip bölümündeki üye bütçesi formundan ayarlar. Zorunlu etiketler, team:growth gibi büyük/küçük harfe duyarlı özel etiketlerdir. usage: ve env: ad alanları ayrılmıştır. Bir üyenin en fazla 19 zorunlu etiketi olabilir; her anahtarın toplam etiket sınırı yine 20’dir.
Her yeni standart anahtar, sahibinin o çalışma alanındaki zorunlu etiketlerini otomatik olarak içerir. Oluşturma sırasında gönderilen etiketler doğrulamadan önce zorunlu etiketlerle birleştirilir. Örneğin üye team:growth gerektiriyorsa, tags:
["project:chatbot"] içeren bir Management API oluşturma isteği project:chatbot, team:growth ve varsayılan usage:service etiketini döndürür.
Bir PATCH isteği tags içeriyorsa tüm zorunlu etiketleri korumalıdır. Zorunlu bir etiket kaldırılırsa çağrıyı yapan yönetici olsa bile eksik etiketleri belirten bir doğrulama hatasıyla 422 döner. tags gönderilmezse anahtarın etiketleri korunur. Üyeler sıradan etiketleri ekleyip kaldırmaya devam edebilir.
Zorunlu bir etiketi kaldırmak için yönetici, Ekip bölümünde üyenin yapılandırmasını değiştirir. Yapılandırma kaydedildiğinde yeni zorunlu etiketler üyenin mevcut tüm standart anahtarlarına eklenir ve artık zorunlu olmayan etiketler kaldırılır. Diğer etiketler değişmez. Devre dışı ve süresi dolmuş anahtarlar dahildir; silinmiş anahtarlar hariçtir. Herhangi bir anahtar son etiket kümesini kabul edemezse kaydetme işleminin tamamı başarısız olur ve form düzeltilmesi gereken anahtarı belirtir.
Etiket bütçeleri her anahtarın mevcut etiketlerini kullanır. Zorunlu etiketlerin değiştirilmesi, geçerli dönemdeki mevcut harcamaların bütçelere dağılımını da değiştirir. Zorunlu bir etiket eklemek o etiketin bütçesini hemen tüketebilir. Mevcut üyeler zorunlu etiket olmadan başlar ve bir yönetici yapılandırmayı kaydedene kadar anahtarları değişmez.
Koruma kuralları uygulayın
Guardrail’ler; model, sağlayıcı ve harcama denetimleri için yeniden kullanılabilir hesap politikalarıdır. Politikaları /api/v1/guardrails üzerinden yönetin, ardından bunları eklemek veya kaldırmak için /api/v1/guardrail_assignments kullanın. Reddedilen bir atamayı, guardrail olmadan sessizce devam etmek yerine bir politika veya sahiplik hatası olarak değerlendirin.
Yönetim hatalarını işle
401 Unauthorized, kimlik bilgisinin eksik, hatalı biçimlendirilmiş, iptal edilmiş veya geçersiz olduğu anlamına gelir.403 Forbidden, kimlik bilgisi sınıfının veya hesap rolünün işlemi gerçekleştiremeyeceği anlamına gelir.404 Not Found, istenen kaynağın kimliği doğrulanmış hesap tarafından görünür olmadığı anlamına gelir.422 Unprocessable Content, gönderilen bir veya daha fazla değerin kaynak kuralını ihlal ettiği anlamına gelir.
Pozitif sınırlı block modunda bir koruma kuralı oluşturun, sonra guardrail_id ve dept:ml gibi büyük/küçük harfe duyarlı bir tag atayın. Tam olarak bir hedef seçin, api_token_id, account_user_id veya tag. Etiket bütçeleri yönetici gerektirir. Devre dışı bütçeler sınır uygulamaz. Yönetim istekleri bütçe tüketmez.
Bütçeler standart anahtarların mevcut etiketlerini toplar; silinmiş, devre dışı ve süresi dolmuş anahtarların harcamaları da dahildir. Etiket eklemek veya kaldırmak anahtarın geçerli dönem harcamasını taşır. Bütçe oluşturmak veya yeniden oluşturmak harcamayı asla sıfırlamaz. Anahtar sayısı silinmiş anahtarları içermez. Eşleşen tüm bütçeler isteğe izin vermelidir; ret 403 ve etiket adını döndürür.
credit_limit_reset_interval null ise sınır ömür boyudur. Diğer dönemler UTC kullanır. Uyarı eşiği varsayılan olarak 80’dir ve 1 ile 100 arasını kabul eder. Doğrudan güncellemeler tüm atamaları etkiler; panel etiket bütçesini düzenlemeden önce politikayı kopyalar.
Kabul sırasında rezervasyonlar kontrol edilir. Kesin ücret bunları aşabilir, kullanım %100’ün üzerine çıkabilir ve sonraki ücretli istekler engellenebilir. Günlükler kendi oluşturulma zamanını, bekleyen görevler ve toplu işler kendi oluşturulma zamanını kullanır. Önceki dönemde kabul edilen görev sonraki dönemde kesinleşebilir.