> ## Documentation Index > Fetch the complete documentation index at: https://docs.playflowcloud.com/llms.txt > Use this file to discover all available pages before exploring further. # Get presigned upload URL > Generates a presigned upload URL for uploading your game server as a ZIP file. Upload flow: 1. **Call this endpoint** to get a `build_id` and `upload_url` 2. **PUT your ZIP** directly to the `upload_url` (expires in 5 minutes) 3. **Done!** Processing starts automatically when the upload completes 4. **Poll GET /builds/{build_id}** until status is `ready` Versions auto-increment per build name: first "default" build is version 1, next is version 2, etc. ## OpenAPI ````yaml https://api.computeflow.cloud/api/doc post /api/v3/builds/upload-url openapi: 3.1.0 info: title: PlayFlow API version: 3.0.0 description: > PlayFlow is a game server hosting and orchestration platform. Deploy, manage, and scale multiplayer game servers globally with built-in matchmaking, lobby management, and billing. ## Authentication All API endpoints (except Health) require the `api-key` header: ``` api-key: pf_your_project_api_key ``` Find your API key in the PlayFlow dashboard under **Project Settings**. Each project has two keys, both sent in the `api-key` header: - **Server key** (`pf_...`) — full access. Keep it secret (server-side only). - **Client key** (`pfclient_...`) — safe to embed in shipped game clients. It has access to all player-facing lobby, matchmaking, and read endpoints, but is **rejected with `403`** from admin/privileged routes: admin lobby get/force-delete (`GET`/`DELETE /v3/lobbies/{config}/{id}`), build deletion (`DELETE /v3/builds/{id}`), and project settings (`POST /v3/projects/settings`). Server lifecycle mutations (start/stop/restart/update) are allowed for client keys by default but can be locked to server-key-only per project via the `client_key_server_control` setting. ## Quick Start 1. **Upload a build**: `POST /v3/builds/upload-url` → get presigned URL → `PUT` your ZIP → processing starts automatically 2. **Start a server**: `POST /v3/servers/start` → get connection info in `network_ports` 3. **Connect your game client**: Use `host:external_port` from the response ## Key Concepts - **Builds**: Your game server binary packaged as a ZIP or Docker image. Versioned per name per project. - **Servers**: Running game server instances. Each gets dedicated compute and network ports with automatic health monitoring. - **Pool Servers**: Pre-provisioned servers for instant startup (~5s vs ~30s cold start). - **Regions**: 13 global regions (us-east, us-south, us-west, eu-north, eu-west, eu-uk, ap-south, sea, ap-north, ap-southeast, south-africa, south-america-brazil, south-america-chile). - **Compute Sizes**: From micro (512MB) to dedicated-xlarge (16GB dedicated CPU). ## Server Lifecycle `launching` → `running` (game ports open) → `stopped` (game exits, TTL expires, or manual stop) ## Build Lifecycle `uploading` → `processing` (build pipeline creates deployable image) → `ready` | `failed` ## Rate Limits - General reads: 100 req/sec per API key - Write operations (start server, upload build): 10 req/sec per API key - Player-facing lobby writes (join, matchmaking, start): 10 req/sec **per player** (keyed by `x-player-id`), so a game's whole player base doesn't share one bucket - Headers: `X-RateLimit-Limit`, `X-RateLimit-Remaining` ## Plan Limits - **Free**: 1 server max, forced 1hr TTL, small size only - **Pro**: Unlimited servers, all sizes, custom TTL, pool servers ## Error Format All errors return: `{ "error": "message", "detail": "context", "status": 404 }` servers: - url: https://api.computeflow.cloud security: - ApiKeyAuth: [] tags: - name: Servers description: >- Create, manage, and monitor game server instances. Each server gets dedicated compute, network ports, and automatic health monitoring with TTL enforcement. Servers start in `launching` status and transition to `running` when the game opens its ports. - name: Builds description: >- Upload and manage game server builds. Supports ZIP uploads (automatically processed into deployable images) and direct Docker image references. Builds are versioned per name per project — uploading a new build with the same name auto-increments the version. Servers always use the latest `ready` build unless a specific version is pinned. - name: Projects description: >- Configure project-level settings including network ports, player authentication, environment variables, server pooling, and lobby/matchmaking rules. Settings apply as defaults to all servers in the project and can be overridden per-server at start time. - name: Lobbies description: >- Player-centric lobby and matchmaking system. Every request identifies the player via the `x-player-id` header. Use `/me` endpoints to interact with your current lobby — the API resolves which lobby you're in automatically. **Quick start:** `POST /v3/lobbies/default` creates a lobby with sensible defaults (no dashboard config needed). Share the invite `code` with friends, or use `POST /v3/lobbies/default/me/matchmaking` to find opponents automatically. **Matchmaking** supports symmetric teams (2v2, 5v5), asymmetric roles (1 monster vs 5 hunters), FFA, battle royale duos, and skill-based matching with auto-expanding MMR buckets. paths: /api/v3/builds/upload-url: post: tags: - Builds summary: Get presigned upload URL description: >- Generates a presigned upload URL for uploading your game server as a ZIP file. Upload flow: 1. **Call this endpoint** to get a `build_id` and `upload_url` 2. **PUT your ZIP** directly to the `upload_url` (expires in 5 minutes) 3. **Done!** Processing starts automatically when the upload completes 4. **Poll GET /builds/{build_id}** until status is `ready` Versions auto-increment per build name: first "default" build is version 1, next is version 2, etc. operationId: createUploadUrl parameters: - schema: type: string default: default description: >- Build name (e.g., "default", "beta", "staging"). Versions auto-increment per name per project. Most projects use "default". required: false description: >- Build name (e.g., "default", "beta", "staging"). Versions auto-increment per name per project. Most projects use "default". name: name in: query - schema: type: string description: >- Path to your game executable inside the ZIP archive. Defaults to "Server.x86_64" if not specified. Examples: "MyGame.x86_64", "bin/DedicatedServer". required: false description: >- Path to your game executable inside the ZIP archive. Defaults to "Server.x86_64" if not specified. Examples: "MyGame.x86_64", "bin/DedicatedServer". name: executable_path in: query responses: '201': description: >- Presigned upload URL generated. Upload your ZIP with a PUT request to the `upload_url` within 5 minutes. content: application/json: schema: type: object properties: build_id: type: string description: >- Unique identifier for the newly created build. Use this ID in subsequent API calls (process, get, delete). name: type: string description: Build name as provided in the request. upload_url: type: string description: >- Presigned R2 URL for uploading your ZIP file. Send a PUT request with your ZIP as the body. This URL expires in 5 minutes. message: type: string description: Confirmation message. required: - build_id - name - upload_url - message description: >- Presigned upload URL and build metadata. Upload your ZIP file to the upload_url with a PUT request. components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: api-key ````