agentHub
API

Referência da API

Documentação REST API completa para integrar a AILoft.

URL base
Autenticação
Respostas JSON

Autenticação

Todos os pedidos requerem chave API no cabeçalho Authorization como Bearer token.

// Header
Authorization: Bearer your-api-token

Mantenha a chave API secreta. Nunca a exponha em código cliente.

Endpoints

GET/api/agentsLista todos os agentes com metadados, avaliações e preços.

Parâmetros

categorystringFilter by category (Development, Analytics, Legal, ...)
searchstringSearch in name, description and tags
backendstringFilter by compatible backend (e.g. openai, claude, ollama)
pricingstringFilter: "free" or "paid"
sortstringSort: popular, newest, rating (default: newest)
pagenumberPage number (default: 1)
limitnumberResults per page (1–50, default: 12)
Resposta: { agents: Agent[], total: number, page: number }
GET/api/agents/:slugInformação detalhada sobre um agente específico.

Parâmetros

slugstringUnique agent slug (URL param)
Resposta: { ...AgentDetail, author: { id, name, username }, reviews: Review[] }
GET/api/agents/:slug/reviewsAvaliações paginadas de um agente.

Parâmetros

slugstringAgent slug (URL param)
pagenumberPage number (default: 1)
limitnumberResults per page (1–50, default: 10)
Resposta: { reviews: Review[], total: number, page: number }
GET/api/agents/:slug/similarGet similar agents from the same category.

Parâmetros

slugstringAgent slug (URL param)
Resposta: { agents: Agent[] }
POST/api/agents/:slug/installInstalar agente pago. Debita da carteira.

Parâmetros

slugstringAgent slug (URL param)
backendstringTarget backend (default: "openai")
Resposta: { success: boolean, message: string, config: InstallConfig }
POST/api/agents/install-freeInstalar agente gratuito. Autenticação necessária.

Parâmetros

agentSlugstringAgent slug (body)
emailstringEmail for delivery (body)
Resposta: { ok: boolean }
POST/api/agents/:slug/reviews🔒Submeter avaliação para um agente instalado.

Parâmetros

ratingnumberRating 1–5 (required)
commentstringReview text (optional)
Resposta: { id, rating, comment, agentId, userId, createdAt }
GET/api/payments/wallet🔒Saldo da carteira e histórico de transações.
Resposta: { balance, totalEarned, totalWithdrawn, available, stripeAccountStatus }

Tipos de dados

Agent

  id: string
  slug: string
  name: string
  description: string
  icon: string | null
  category: string
  agentType: "prompt_based" | "app_ui"
  compatible: string[]
  tags: string[]
  pricing: { type: "one_time", amount?: number }
  rating: number
  installs: number
  isFeatured: boolean
  createdAt: string (ISO 8601)
  author: { id: string, name: string }

Review

  id: string
  rating: number (1–5)
  comment: string | null
  agentId: string
  userId: string
  user: { name, username, avatarUrl }
  createdAt: string (ISO 8601)
Voltar à documentaçãoComeçar a desenvolver →