Create project

Create a project to organize related services and environments.

POST /api/projects HTTPS

Request & response examples

Request example Server-side

curl --fail-with-body --request POST \
  'https://app.helicarrier.xyz/api/projects' \
  -H "Authorization: Bearer $HELI_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "name": "my-service"
}'

const response = await fetch(
  "https://app.helicarrier.xyz/api/projects",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.HELI_API_KEY}`,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "my-service"
    })
  }
);
const data = await response.json();
if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${data.error}`);
}
// Inspect data; avoid logging secret responses.

import os
import requests

response = requests.request(
    "POST",
    "https://app.helicarrier.xyz/api/projects",
    headers={
        "Authorization": f"Bearer {os.environ['HELI_API_KEY']}"
    },
    json={
      "name": "my-service"
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
# Inspect data; avoid logging secret responses.

Response example 201

{
  "id": "prj_example",
  "name": "My project",
  "slug": "my-project",
  "description": ""
}

Illustrative values · selected fields

Response details ↓ OpenAPI ↗

Authorization

An account key with access to the resource. Project and service keys do not authorize this operation.

Authorization: Bearer <key> Key setup ↗

Request body application/json

name string required

Project name.

description string optional

Optional description.

Response 201

Returns the newly created project. Store its id and slug; subsequent project reads use the slug.

Examples show selected response fields with illustrative values. Your response can contain additional fields.

id string

Unique identifier of this resource.

name string

Human-readable resource name.

slug string

URL-safe resource identifier.

description string

Description of the resource or capability.

Errors

400

Invalid parameters. Check the required fields, types, and resource configuration.

401

The API key is missing, invalid, or revoked.

403

The caller or key scope does not permit this operation.

409

The current resource state prevents the operation. Inspect it before retrying.

500

The operation could not be completed. Check resource state before retrying a write.

Error handling and safe retries

ALSO AVAILABLE VIA MCP

`create_project`

Required MCP arguments: name. Send path, query, and body fields together as tool arguments.

Connect your agent ↗

curl --fail-with-body --request POST \ 'https://app.helicarrier.xyz/api/projects' \ -H "Authorization: Bearer $HELI_API_KEY" \ -H 'Content-Type: application/json' \ --data '{ "name": "my-service" }'

import os import requests response = requests.request( "POST", "https://app.helicarrier.xyz/api/projects", headers={ "Authorization": f"Bearer {os.environ['HELI_API_KEY']}" }, json={ "name": "my-service" }, timeout=30, ) response.raise_for_status() data = response.json() # Inspect data; avoid logging secret responses.