Перейти до основного вмісту

Launch API

Launch ендпоінт надає єдиний виклик для створення Playspec — та, опціонально, одразу запущеного Playground — з Docker Compose YAML.

Ендпоінт

МетодШляхСкоупОпис
POST/api/launchlaunch:writeСтворити Playspec (та опціонально Playground) з Compose YAML

Створення через Launch

POST /api/launch

Тіло запиту:

{
"name": "my-environment",
"compose_yaml": "services:\n web:\n image: nginx:latest\n ports:\n - \"80:80\"\n db:\n image: postgres:16\n environment:\n POSTGRES_PASSWORD: secret",
"playroom_id": 1,
"create_playground": true,
"persist_volumes": false,
"persist_volumes": false,
"agent": "custom-assistant"
}

Параметри:

ПараметрТипОбовʼязковийОпис
namestringТакНазва для створеного Playspec (та Playground)
compose_yamlstringТакDocker Compose YAML визначення
playroom_idintegerНіPlayroom для розгортання (обовʼязковий, якщо create_playground true)
create_playgroundbooleanНіЧи створити та запустити Playground одразу (за замовчуванням: false)
persist_volumesbooleanНіУвімкнути збереження томів на Playspec (за замовчуванням: false)
agentstringНіПровайдер AI-агента (напр., custom-assistant)

Відповідь (201 Created):

{
"playspecs_created": 42,
"playground_id": 15,
"playzones_created": [1, 2]
}
ПолеОпис
playspecs_createdID новоствореного Playspec
playground_idID Playground (присутній тільки якщо create_playground було true)
playzones_createdID автоматично створених Playzone з Compose визначення

Як це працює

Launch ендпоінт оркеструє кілька операцій одним викликом:

  1. Парсить Docker Compose YAML
  2. Автоматично створює Playzone для build-сервісів, що посилаються на локальні Dockerfile (якщо репозиторій можна визначити)
  3. Створює Playspec з наданим Compose YAML та автокласифікованими сервісами
  4. Опціонально створює Playground на вказаному Playroom

Це ідеально для:

  • CI/CD пайплайнів — Створюйте ефемерні середовища для превʼю pull request
  • CLI-інструментів — Запускайте середовища з командного рядка одним API-викликом
  • Автоматизації — Скриптуйте створення середовищ для демо, тестування або онбордингу

Приклад: CI/CD превʼю середовище

curl -X POST https://fibe.gg/api/launch \
-H "Authorization: Bearer $PLAYGROUNDS_API_KEY" \
-H "Content-Type: application/json" \
-d "{
\"name\": \"pr-$PR_NUMBER\",
\"compose_yaml\": \"$(cat docker-compose.yml)\",
\"playroom_id\": $PLAYROOM_ID,
\"create_playground\": true
}"