Authentication

All VisoWork API requests require authentication via API keys.

API Keys

API keys use the sk_sf_ prefix and are scoped to individual projects. Each key authenticates requests for a specific project's resources.

Generating Keys

  1. Navigate to your project settings
  2. Open the API Keys tab
  3. Click Create Key
  4. Name your key (e.g., "Production", "Development")
  5. Copy the key — it's only shown once

You can also manage keys from your profile API keys page.

Key Format

text
sk_sf_<random-base64url>

Keys are generated from 32 random bytes, prefixed with sk_sf_, and bcrypt-hashed in the database. Only a sk_sf_...xxxx hint (last 4 chars) is stored for identification — the full key is shown once at creation time.

Using Keys

REST API

Include the key in the Authorization header:

bash
curl -X POST https://api.visowork.com/v1/vision/describe \
  -H "Authorization: Bearer sk_sf_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"image": "https://example.com/photo.jpg"}'

MCP

Pass the key in the connection header:

bash
claude mcp add visowork \
  --transport sse \
  --url https://api.visowork.com/mcp \
  --header "Authorization: Bearer sk_sf_YOUR_API_KEY"

Environment Variables

For local development, set credentials as environment variables:

bash
export VISOWORK_API_URL=https://api.visowork.com
export VISOWORK_API_KEY=sk_sf_YOUR_API_KEY

Security Best Practices

  • Never commit keys to version control
  • Rotate keys periodically — disable old keys and create new ones
  • Use separate keys for development and production
  • Monitor usage in your project billing settings to detect anomalies