Who is this API for?
Alpic’s REST API is designed for developers who want to programmatically manage their Alpic resources. Currently, the API supports:- Project creation
- Environment creation
- Deployment triggers
View Complete API Reference
Browse all available API endpoints, request/response schemas, and try out API
calls in our interactive API Reference documentation.
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.
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.
Authentication
All API requests require authentication using your API key. Include it in theAuthorization header as a Bearer token:
Base URL
All API requests should be made to:API Versioning
The API uses versioning in the URL path. The current version isv1, so all endpoints are prefixed with /v1/.
Example:
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.Next Steps
View API Reference
Explore all available endpoints with interactive documentation.