Skip to navigation

Developer quickstart

Authenticate, list your vaults, and run a scoped knowledge search.
View as Markdown

Alpha’s REST API is available at https://mcp.openantares.com/v1. Use a personal API key for server-side scripts and service integrations.

1

Create an API key

Open Profile > API keys in Alpha and name the key for the service that will use it. Copy the value once and store it in your secret manager. The key inherits your current organization and vault access. It does not have a separate role selector.

2

List accessible vaults

curl https://mcp.openantares.com/v1/vaults \
-H "Authorization: Bearer $ALPHA_API_KEY"
3

Search one vault

curl https://mcp.openantares.com/v1/tools/search_knowledge \
-H "Authorization: Bearer $ALPHA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"vault": "Northstar Fulfillment",
"query": "pilot blockers"
}'
4

Keep the request ID

Store the X-Request-Id response header with your application logs. Alpha records the same ID in its API and MCP request ledger.

Discover available tools

GET /v1/tools returns the reviewed public tool catalog. The OpenAPI document is available at GET /v1/openapi.json.

Internal administration, migration, seed, reset, maintenance, and test functions are not part of the public catalog.

Understand access before you ship

One key can list every vault its owner can access, but each content or action request must name one vault. Reads inherit the owner’s access to that vault. Writes require the owner to be a vault manager or organization admin at request time. Role changes and removals take effect immediately without rotating the key.