---
title: "Get Setup Guide"
method: GET
path: "/api/v1/integrations/setup/{framework}"
tags: ["integrations"]
---

# Get Setup Guide

`GET /api/v1/integrations/setup/{framework}`

## Request

- Base URL: `https://api.badgeia.com`
- URL: `https://api.badgeia.com/api/v1/integrations/setup/{framework}`
- Auth: none declared

Get the complete setup guide for a specific framework.

## Path parameters

- `framework` string, required

## Response `200`

Successful Response

- FrameworkSetup: Complete setup guide for a framework.
  - `framework` string, required
  - `name` string, required
  - `description` string, required
  - `icon_hint` string, required
  - `requirements` string[], required
  - `steps` SetupStep[], required
    - `title` string, required
    - `description` string, required
    - `code_snippet` string, required
    - `language` string

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/badgeia/apis/badge.md) · [All operations](https://skmtc.dev/badgeia/apis/badge/llms.txt) · [OpenAPI document](https://skmtc.dev/badgeia/apis/badge/revisions/7e7f7fee8b77?raw)