Skip to main content

SDK para criar APIs auto-descritivas compatíveis com agentes IA

Project description

APIBrain SDK 🧠

Torne qualquer API auto-descritiva e compatível com agentes IA em segundos.

O APIBrain SDK é uma ferramenta poderosa que permite transformar APIs FastAPI em endpoints auto-descritivos, facilitando a integração com agentes de IA. Com apenas algumas linhas de código, sua API se torna descobrível e compreensível por sistemas autônomos.

💫 Por que APIBrain?

  • Redução de 90% no Tempo de Integração: Agentes IA descobrem e compreendem sua API automaticamente
  • Zero Configuração Manual: Schemas e documentação gerados automaticamente
  • Pronto para o Futuro: Prepare suas APIs para a era dos agentes autônomos
  • Compatibilidade Universal: Funciona com qualquer API FastAPI existente

🔄 Como Funciona

graph LR
    A[Sua API] --> B[APIBrain SDK]
    B --> C[Auto-Descoberta]
    B --> D[Schemas]
    C --> E[Agentes IA]
    D --> E
    E --> A

⚡ Instalação

pip install apibrain-sdk

🚀 Exemplo Básico

from fastapi import FastAPI
from pydantic import BaseModel
from apibrain import APIBrain, capability

# Modelos
class CalculationResponse(BaseModel):
    result: float
    operation: str

# API
app = FastAPI()
apibrain = APIBrain()

@capability(
    name="calculate",
    description="Realiza operações matemáticas",
    apibrain=apibrain
)
@app.post("/calculate")
async def calculate(a: float, b: float) -> CalculationResponse:
    return CalculationResponse(
        result=a + b,
        operation="sum"
    )

# Habilita APIBrain
apibrain.enable(app)

🔥 Exemplo Avançado

from typing import Optional
from pydantic import BaseModel

class WeatherResponse(BaseModel):
    temperature: float
    condition: str
    humidity: Optional[float] = None

@capability(
    name="get_weather",
    description="Previsão do tempo por cidade",
    apibrain=apibrain
)
@app.get("/weather/{city}")
async def get_weather(
    city: str, 
    detailed: bool = False
) -> WeatherResponse:
    """
    Retorna previsão do tempo para uma cidade.
    - city: Nome da cidade
    - detailed: Se True, inclui umidade
    """
    return WeatherResponse(
        temperature=22.5,
        condition="Ensolarado",
        humidity=65.0 if detailed else None
    )

🎯 Casos de Uso

💰 Finanças

  • Trading Automatizado: API que permite agentes IA executarem operações de compra/venda baseadas em análise em tempo real
@capability(
    name="execute_trade",
    description="Executa operação de trading",
    apibrain=apibrain
)
async def execute_trade(symbol: str, amount: float, operation: str):
    return {"status": "executed", "price": 100.50}

🆔 Identidade Digital

  • Verificação Multimodal: Sistema que combina verificação de documentos, biometria e prova de vida
@capability(
    name="verify_identity",
    description="Verifica identidade usando múltiplos fatores",
    apibrain=apibrain
)
async def verify_identity(document: bytes, selfie: bytes, liveness: bytes):
    return {"verified": True, "score": 0.98}

🎨 Multimodalidade

  • Assistente Virtual Completo: API que processa texto, imagem e áudio para criar experiências interativas
@capability(
    name="process_input",
    description="Processa entrada multimodal",
    apibrain=apibrain
)
async def process_input(text: str = None, image: bytes = None, audio: bytes = None):
    return {"response": "Entendi sua mensagem!", "confidence": 0.95}

🌟 Recursos

  • ✨ Auto-descoberta de endpoints
  • 📝 Schemas automáticos
  • 🚀 Compatível com FastAPI
  • 🔧 Suporte a Pydantic
  • 📚 Documentação OpenAPI

🚀 Começando

  1. Instale o SDK
pip install apibrain-sdk
  1. Decore seus endpoints
@capability(name="endpoint", description="...")
  1. Habilite o APIBrain
apibrain.enable(app)
  1. Pronto! Sua API agora é auto-descritiva

🤝 Contribuição

Contribuições são bem-vindas! Por favor, visite nosso repositório no GitHub para:

  1. Reportar bugs
  2. Sugerir novas features
  3. Enviar pull requests

📄 Licença

Este projeto está licenciado sob a licença MIT - veja o arquivo LICENSE para detalhes.

🔗 Links Úteis


Desenvolvido com ❤️ pela APIBrain Team

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apibrain_sdk-0.1.0.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apibrain_sdk-0.1.0-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file apibrain_sdk-0.1.0.tar.gz.

File metadata

  • Download URL: apibrain_sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for apibrain_sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 aff6a287cb3f68e941919ad5862fdf5357ac53403459869091dee63eec6f32a8
MD5 9edec58b304f24c339e62fff5b351e31
BLAKE2b-256 4b55015f571e8e2e9fb97fe9cad7ce4f4fcae713ce7e01ed3c100b018864b6f1

See more details on using hashes here.

File details

Details for the file apibrain_sdk-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: apibrain_sdk-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for apibrain_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1f62b8538f72d08c937cb0895c3831ad5667cd86a8f84e0a603f01412357683b
MD5 9638d068bddf319f9792d3f5ff6077b4
BLAKE2b-256 40146c2127fdadb5ba0eb97451f0eec48f6b1d0c3e56b3283b85b43b179ea890

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page