API

Exercícios

Consultar o catálogo de exercícios disponíveis.

Exercícios

Consulte o catálogo completo de exercícios disponíveis para montar programas de treino. A API retorna exercícios específicos da sua academia combinados com o catálogo global do OctaGym.

Listar Exercícios

GET /api/v1/exercises

Retorna a lista de exercícios filtrados por diversos critérios, ordenados por nome.

Parâmetros de Query

ParâmetroTipoDescrição
searchstringBusca por nome (name) ou nome em inglês (name_en)
muscle_groupstringFiltra por grupo muscular principal
equipmentstringFiltra por equipamento necessário
difficultystringFiltra por dificuldade: beginner, intermediate ou advanced
exercise_typestringFiltra por tipo de exercício
pageintNúmero da página (padrão: 1)
limitintItens por página (padrão: 20, máximo: 100)

Exemplo de Requisição

curl -X GET "https://dashboard.octagym.ai/api/v1/exercises?muscle_group=chest&difficulty=intermediate&limit=10" \
  -H "Authorization: Bearer og_live_sua_chave_aqui" \
  -H "Content-Type: application/json"
const response = await fetch(
  'https://dashboard.octagym.ai/api/v1/exercises?muscle_group=chest&difficulty=intermediate&limit=10',
  {
    headers: {
      'Authorization': 'Bearer og_live_sua_chave_aqui',
      'Content-Type': 'application/json'
    }
  }
);

const data = await response.json();

Exemplo de Resposta

{
  "success": true,
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Supino Reto com Barra",
      "name_en": "Barbell Bench Press",
      "description": "Exercício composto para desenvolvimento do peitoral.",
      "instructions": "Deite no banco, segure a barra na largura dos ombros, desça até o peito e empurre para cima.",
      "muscle_groups": ["chest"],
      "secondary_muscle_groups": ["triceps", "shoulders"],
      "equipment": ["barbell", "bench"],
      "difficulty": "intermediate",
      "exercise_type": "strength",
      "movement_pattern": "horizontal_push",
      "video_url": "https://cdn.octagym.ai/exercises/bench-press.mp4",
      "thumbnail_url": "https://cdn.octagym.ai/exercises/bench-press.jpg"
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Crucifixo com Halteres",
      "name_en": "Dumbbell Fly",
      "description": "Exercício de isolamento para o peitoral.",
      "instructions": "Deite no banco segurando halteres com os braços estendidos. Abra os braços em arco e retorne.",
      "muscle_groups": ["chest"],
      "secondary_muscle_groups": ["shoulders"],
      "equipment": ["dumbbells", "bench"],
      "difficulty": "intermediate",
      "exercise_type": "strength",
      "movement_pattern": "horizontal_push",
      "video_url": null,
      "thumbnail_url": null
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 24,
    "pages": 3
  }
}

Campos do Exercício

CampoTipoDescrição
iduuidIdentificador único
namestringNome em português
name_enstringNome em inglês
descriptionstringDescrição do exercício
instructionsstringInstruções de execução
muscle_groupsstring[]Grupos musculares principais
secondary_muscle_groupsstring[]Grupos musculares secundários
equipmentstring[]Equipamentos necessários
difficultystringbeginner, intermediate ou advanced
exercise_typestringTipo do exercício (ex: strength, cardio)
movement_patternstringPadrão de movimento (ex: horizontal_push, pull)
video_urlstringURL do vídeo demonstrativo (pode ser null)
thumbnail_urlstringURL da imagem thumbnail (pode ser null)

Os exercícios retornados incluem tanto os cadastrados pela sua academia quanto o catálogo global do OctaGym, ordenados por nome.

Grupos Musculares

Valores comuns para o parâmetro muscle_group:

ValorDescrição
chestPeitoral
backCostas
shouldersOmbros
bicepsBíceps
tricepsTríceps
quadricepsQuadríceps
hamstringsPosteriores
glutesGlúteos
calvesPanturrilhas
absAbdominais
forearmsAntebraços

Suporte

On this page