Skip to main content

​
Who is this API for?

Alpic’s REST API is designed for developers who want to automate deployment workflows and manage MCP server projects programmatically. The API supports:
  • Teams — list teams available to the authenticated user
  • Projects — create, list, retrieve, update, and delete MCP server projects
  • Environments — create and retrieve environments, deploy them, and fetch runtime logs
  • Environment Variables — list, add, update, and delete environment variables per environment
  • Deployments — upload artifacts, list deployments, inspect deployment details, and retrieve deployment logs
  • Analytics and Tunnels — fetch project analytics and generate tunnel tickets
  • Distribution — publish to the MCP Registry (Publishing docs)
  • Beacon — check a MCP server readiness for chatGPT and Claude
Use the API to integrate Alpic into your development workflow, automate deployments, and operate your MCP servers end to end.

​
Getting Started

​
Get Your API Key

To use the REST API, you’ll need an API key. Here’s how to get one:
1

Sign in to your Alpic dashboard

Navigate to https://app.alpic.ai and sign in to your account.
2

Navigate to API Keys section

Click on your team name in the top left corner of the screen, then select the API Keys tab on the left sidebar.
3

Generate a new API key

Click New API key and give it a name (e.g., “CI/CD Pipeline”).
4

Copy and store your API key

Copy the API key immediately—you won’t be able to see it again. Store it securely in your environment variables or secrets manager.
Keep your API keys secure and never commit them to version control. Treat them like passwords—if exposed, revoke them immediately and generate new ones.

​
Alpic teams structure

Understanding the hierarchy of Alpic’s resources is important when working with the API:
  • API Key: Each API key is associated with a specific team. The API key grants access to resources within that team.
  • Team: A team can contain multiple projects and is the top-level organizational unit.
  • Project: Each project represents an MCP server and can have multiple environments.
  • Environment: Environments represent different deployment environments (e.g., production, staging, development) for your MCP server, linked to a specific branch of your git repository. Learn more about environments here.
When making API requests, you’ll work with resources at the project and environment levels, all scoped to the team associated with your API key.

​
Authentication

All API requests require authentication using your API key. Include it in the Authorization header as a Bearer token: 
Authorization: Bearer YOUR_API_KEY

​
Base URL

All API requests should be made to: 
https://api.alpic.ai

​
API Versioning

The API uses versioning in the URL path. The current version is v1, so all endpoints are prefixed with /v1/. Example: 
https://api.alpic.ai/v1/projects

​
Response Format

All API responses are returned in JSON format. Successful responses use standard HTTP status codes (200, 201, etc.), while errors return appropriate error codes (400, 401, 404, 500, etc.) with error details in the response body.