Submitting AI Skills for Scanning

Submit your AI agent skill archives to the OASIS service to initiate a Software Composition Analysis (SCA) scan and generate an AI-BOM report.

This feature is in Limited Availability. If you want to enable this feature in your tenant, contact your sales team.

Prerequisites

Before submitting your skills, ensure you have:

• An active API authentication token with appropriate tenant permissions.
• Your AI agent skill files packaged into a password-protected .zip archive (containing SKILL.md, Python scripts, and configuration manifests).

API Endpoint Details

The Submit API receives the archive asynchronously and queues it for analysis.

• Method: POST
• Path: /api/v2/aibom/scans
• Content-Type: multipart/form-data

Request Headers

• Authorization (Required): Bearer <your_api_token>

Request Parameters

• file (Required): The .zip archive containing the AI agent skill package.

Submitting an Archive for Scanning

To submit your skill archive:

1. Compress your AI agent skill files into a .zip archive.
2. Send an HTTP POST request to /api/v2/aibom/scans with the archive attached in the form data.
3. Verify that the response returns an HTTP 202 Accepted status code.
4. Save the returned taskId from the response to query the report status.

Example Request

curl -X POST "https://<tenant-url>/api/v2/aibom/scans" \
  -H "Authorization: Bearer <your_api_token>" \
  -F "file=@agent_skill_package.zip"

Example Response (HTTP 202 Accepted)

{
  "status": "dispatched",
  "taskId": "task-80cf4f58-5a6e-4788-b6ce-1ee72a2c9fe7"
}

Submitting a Git Repository for Scanning

Submit a Git repository URL directly to scan remote skill repositories without uploading local files.

API Endpoint Details

• Method: POST
• Path: /api/v2/aibom/scans/repo
• Content-Type: application/json

Request Headers

• Authorization (Required): Bearer <your_api_token>

Request Parameters

• repo_url (Required): The URL of the Git repository to scan.
• branch (Optional): The repository branch to inspect. Defaults to the primary branch.

Procedure

To submit a repository:

1. Identify the URL of the target Git repository.
2. Send an HTTP POST request to /api/v2/aibom/scans/repo with the repository payload.
3. Verify that the response returns an HTTP 202 Accepted status code.
4. Save the returned taskId to query the report status.

Example Request

curl -X POST "https://<tenant-url>/api/v2/aibom/scans/repo" \
  -H "Authorization: Bearer <your_api_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "repo_url": "https://github.com/example-org/ai-agent-skills.git",
    "branch": "main"
  }'

Example Response (HTTP 202 Accepted)

{
"status": "dispatched",
"taskId": "task-99df2b15-c1f9-4b2f-8fa8-fbbfe6d4ae11"
}

Error Codes

The Submit API returns the following error responses:

• 400 Bad Request: The request is missing the required file parameter or the payload is malformed.
• 413 Payload Too Large: The uploaded file exceeds the maximum allowed file size.
• 415 Unsupported Media Type: The uploaded file format is not a supported .zip archive.
• 422 Unprocessable Content: The archive is corrupted or unreadable.

Next Steps

To learn more: Retrieving AI-BOM Reports.