---
title: "Describe the scope"
method: GET
path: "/api/v0/project"
tags: ["Meta"]
---

# Describe the scope

`GET /api/v0/project`

## Request

- Base URL: `https://app.vibeflow.tools`
- URL: `https://app.vibeflow.tools/api/v0/project`
- Auth: HTTP bearer

Local { kind: local, name, branch }; cloud { kind: board, ... }. /api/github-url folds into this description.

## Response `200`

Describe the scope — success

- Project: Scope description: local { kind: local, name, branch }; cloud { kind: board, ... }
  - `kind` 'local' | 'board', required
  - `name` string
  - `branch` string, nullable
  - `boardId` string
  - `workspaceId` string

## Other responses

- `401`: Missing or invalid principal
- `403`: Lacking scope or membership
- `429`: Rate limited — cloud per-token quota exceeded (reads 300/min, writes 60/min, token creation 10/hour); counters are per-replica, so the effective limit is the configured value × replicas. The response carries Retry-After.

---

[API](https://skmtc.dev/vibeflow/apis/vibeflow-api-v0.md) · [All operations](https://skmtc.dev/vibeflow/apis/vibeflow-api-v0/llms.txt) · [OpenAPI document](https://skmtc.dev/vibeflow/apis/vibeflow-api-v0/revisions/efd4ba944b0b?raw)