API Integration Guide

Creating API Keys

To use the AI Assess API, you need an API key. Create one from the Developer Portal:

  1. Sign in to your AI Assess account.
  2. Navigate to Developer > API Keys.
  3. Click "Create API Key".
  4. Enter a name for the key (e.g., "Production Integration").
  5. Select the scopes you need.
  6. Click "Create".

The API key is displayed only once at creation time. Copy and store it securely. If you lose it, you will need to create a new key.

Scopes

API keys have scopes that control what data they can access:

  • read:public — Access the public vendor registry. Retrieve vendor listings, scores, assessments, and evidence summaries.
  • read:org — Access your organization's vendor data including policy decisions. Requires the API key to be created with an organization scope.

Authentication

Include your API key in every request using one of these methods:

Option 1: Authorization header (recommended)

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://ai-assess.voltanetworks.jp/api/v1/dev/public/products

Option 2: X-API-Key header

curl -H "X-API-Key: YOUR_API_KEY" \
  https://ai-assess.voltanetworks.jp/api/v1/dev/public/products

Example Requests

List all vendors:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://ai-assess.voltanetworks.jp/api/v1/dev/public/products?limit=20&offset=0"

Get a specific vendor by slug:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://ai-assess.voltanetworks.jp/api/v1/dev/public/products/anthropic"

All responses follow this format:

{
  "ok": true,
  "data": { ... },
  "meta": { "request_id": "uuid", "timestamp": "..." }
}

Rate Limits

API requests are rate-limited per API key:

  • Default: 60 requests per minute per API key.
  • When rate-limited, the API returns HTTP 429 Too Many Requests.
  • The response includes a Retry-After header indicating when you can retry.

If you need higher limits, contact us to discuss your use case.

API Integration Guide — AI Assess