nniback / README.md
Kyrlos11's picture
Upload 842 files
22087d0 verified
|
Raw History Blame Contribute Delete
4.9 kB
metadata
title: Kortix Backend API
emoji: ๐Ÿค–
colorFrom: blue
colorTo: purple
sdk: docker
pinned: false
license: apache-2.0

Kortix Backend API ๐Ÿš€

Backend API ู„ู…ู†ุตุฉ Kortix - ู…ู†ุตุฉ ู…ุชูƒุงู…ู„ุฉ ู„ุจู†ุงุก ูˆุฅุฏุงุฑุฉ AI Agents ุงู„ู…ุณุชู‚ู„ุฉ.

๐ŸŒŸ ุงู„ู…ู…ูŠุฒุงุช

  • โœ… FastAPI Backend - API ุณุฑูŠุน ูˆูุนุงู„
  • โœ… Multi-LLM Support - ุฏุนู… Anthropic Claude, OpenAI, ูˆุบูŠุฑู‡ุง
  • โœ… Agent Management - ุฅุฏุงุฑุฉ ู…ุชู‚ุฏู…ุฉ ู„ู„ู€ AI Agents
  • โœ… Thread Management - ุฅุฏุงุฑุฉ ุงู„ู…ุญุงุฏุซุงุช ูˆุงู„ู€ sessions
  • โœ… Supabase Integration - ู‚ุงุนุฏุฉ ุจูŠุงู†ุงุช ูˆุชูˆุซูŠู‚ ู…ุชูƒุงู…ู„
  • โœ… Background Tasks - ู…ุนุงู„ุฌุฉ ุงู„ู…ู‡ุงู… ููŠ ุงู„ุฎู„ููŠุฉ
  • โœ… Tool Integration - ุฏุนู… ุฃุฏูˆุงุช ู…ุชุนุฏุฏุฉ ู„ู„ู€ agents

๐Ÿ”ง Environment Variables ุงู„ู…ุทู„ูˆุจุฉ

ู‚ุจู„ ุชุดุบูŠู„ ุงู„ู€ SpaceุŒ ุฃุถู ู‡ุฐู‡ ุงู„ู…ุชุบูŠุฑุงุช ููŠ Settings โ†’ Secrets:

Required (ู…ุทู„ูˆุจ):

# LLM Provider (ูˆุงุญุฏ ุนู„ู‰ ุงู„ุฃู‚ู„)
ANTHROPIC_API_KEY=sk-ant-xxxxx

# Supabase Configuration
SUPABASE_URL=https://xxxxx.supabase.co
SUPABASE_ANON_KEY=eyJhbGciOiJIUzI1NiIs...
SUPABASE_SERVICE_KEY=eyJhbGciOiJIUzI1NiIs...

# Environment
ENVIRONMENT=production

Optional (ุงุฎุชูŠุงุฑูŠ):

# Additional LLM Providers
OPENAI_API_KEY=sk-xxxxx

# Redis for Caching
REDIS_URL=redis://your-redis-url:6379

# Search APIs
TAVILY_API_KEY=tvly-xxxxx
FIRECRAWL_API_KEY=fc-xxxxx

# Logging
LOG_LEVEL=INFO

๐Ÿš€ ูƒูŠููŠุฉ ุงู„ุงุณุชุฎุฏุงู…

1. ุงู„ูˆุตูˆู„ ู„ู„ู€ API

ุจุนุฏ ุชุดุบูŠู„ ุงู„ู€ SpaceุŒ ุณูŠูƒูˆู† ุงู„ู€ API ู…ุชุงุญ ุนู„ู‰:

https://YOUR_USERNAME-kortix-backend.hf.space

2. ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ุตุญุฉ (Health Check)

curl https://YOUR_USERNAME-kortix-backend.hf.space/health

ุงู„ุฑุฏ ุงู„ู…ุชูˆู‚ุน:

{
  "status": "healthy",
  "version": "1.0.0"
}

3. API Documentation

FastAPI ุชูˆูุฑ documentation ุชูุงุนู„ูŠุฉ ุชู„ู‚ุงุฆูŠุฉ:

  • Swagger UI: https://YOUR_USERNAME-kortix-backend.hf.space/docs
  • ReDoc: https://YOUR_USERNAME-kortix-backend.hf.space/redoc

๐Ÿ“š API Endpoints

Core Endpoints:

  • GET /health - ุงู„ุชุญู‚ู‚ ู…ู† ุตุญุฉ ุงู„ู€ API
  • POST /api/v1/agents - ุฅู†ุดุงุก agent ุฌุฏูŠุฏ
  • GET /api/v1/agents - ุนุฑุถ ุฌู…ูŠุน ุงู„ู€ agents
  • POST /api/v1/threads - ุฅู†ุดุงุก thread ู…ุญุงุฏุซุฉ ุฌุฏูŠุฏ
  • POST /api/v1/messages - ุฅุฑุณุงู„ ุฑุณุงู„ุฉ

Authentication:

ู…ุนุธู… endpoints ุชุญุชุงุฌ ู„ู€ JWT token ู…ู† Supabase:

curl -H "Authorization: Bearer YOUR_JWT_TOKEN" \
     https://YOUR_USERNAME-kortix-backend.hf.space/api/v1/agents

๐Ÿ—๏ธ ุงู„ุจู†ูŠุฉ ุงู„ุชู‚ู†ูŠุฉ

kortix-backend/
โ”œโ”€โ”€ api.py              # Entry point
โ”œโ”€โ”€ auth/               # Authentication & authorization
โ”œโ”€โ”€ core/               # Core business logic
โ”œโ”€โ”€ evals/              # Evaluation & testing
โ”œโ”€โ”€ scripts/            # Utility scripts
โ”œโ”€โ”€ supabase/           # Database migrations & functions
โ””โ”€โ”€ tests/              # Unit & integration tests

๐Ÿ”’ ุงู„ุฃู…ุงู†

  • โœ… JWT Authentication ุนุจุฑ Supabase
  • โœ… Rate limiting ู„ู„ู€ API requests
  • โœ… Input validation ู…ุน Pydantic
  • โœ… Environment variables ู„ู„ู€ secrets
  • โœ… CORS configuration

๐Ÿ“Š ุงู„ู…ุฑุงู‚ุจุฉ ูˆุงู„ู€ Logs

ุงู„ู€ Space ูŠูˆูุฑ logs ู…ุจุงุดุฑุฉ ููŠ ุงู„ูˆุงุฌู‡ุฉ:

  • Application logs
  • Error tracking
  • Performance metrics

โš ๏ธ ู…ู„ุงุญุธุงุช ู…ู‡ู…ุฉ

  1. Hugging Face Free Tier:

    • ู…ูˆุงุฑุฏ ู…ุญุฏูˆุฏุฉ (CPU)
    • ู‚ุฏ ุชุญุชุงุฌ ู„ู€ upgrade ู„ู„ุฃุฏุงุก ุงู„ุฃูุถู„
  2. Cold Start:

    • ุฃูˆู„ request ู‚ุฏ ูŠุฃุฎุฐ ูˆู‚ุช ุฃุทูˆู„
    • ุจุนุฏ ุฐู„ูƒ ุงู„ุณุฑุนุฉ ุชุชุญุณู†
  3. Persistence:

    • ุงู„ุจูŠุงู†ุงุช ู…ุฎุฒู†ุฉ ููŠ Supabase
    • ุงู„ู…ู„ูุงุช ุงู„ู…ุคู‚ุชุฉ ู‚ุฏ ุชูุญุฐู ุนู†ุฏ ุฅุนุงุฏุฉ ุงู„ุชุดุบูŠู„

๐Ÿ”— ุฑูˆุงุจุท ู…ููŠุฏุฉ

๐Ÿค ุงู„ู…ุณุงู‡ู…ุฉ

ู‡ุฐุง ุงู„ู€ Space ู‡ูˆ deployment ู„ู„ู…ุดุฑูˆุน ุงู„ุฃุตู„ูŠ Kortix Suna.

ู„ู„ู…ุณุงู‡ู…ุฉ ููŠ ุงู„ู…ุดุฑูˆุน:

  1. Fork ุงู„ู€ repository ุงู„ุฃุตู„ูŠ
  2. ุฅู†ุดุงุก branch ุฌุฏูŠุฏ
  3. ุนู…ู„ Pull Request

๐Ÿ“„ License

Apache License 2.0 - See LICENSE


๐Ÿ†˜ ุงู„ุฏุนู…

ูˆุงุฌู‡ุช ู…ุดูƒู„ุฉุŸ

  1. ุชุญู‚ู‚ ู…ู† ุงู„ู€ logs ููŠ ุงู„ู€ Space
  2. ุชุฃูƒุฏ ู…ู† ุฅุถุงูุฉ ูƒู„ ุงู„ู€ Environment Variables
  3. ุงู†ุถู… ู„ู€ Discord Server ู„ู„ู…ุณุงุนุฏุฉ

Built with โค๏ธ by the Kortix Team Deployed on ๐Ÿค— Hugging Face Spaces