Skip to main content
POST
/
v1
/
beacon
/
audits
Create a beacon audit
curl --request POST \
  --url https://api.alpic.ai/v1/beacon/audits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "targetUrl": "<string>",
  "teamId": "<string>",
  "projectId": "<string>",
  "excludeCategories": [
    "connectivity"
  ]
}
'
{
  "id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.alpic.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.

Body

application/json
​
targetUrl
string<uri>
required

The HTTPS URL of the MCP server to audit

​
teamId
string

The team ID to associate the audit with

​
projectId
string

The project ID to associate the audit with

​
excludeCategories
enum<string>[]

Check categories to exclude from the audit

Available options:
connectivity,
tool-metadata,
resource-metadata,
performance,
e2e

Response

The audit has been created

​
id
string
required