API Keys

​

Creating an API Key

1. Log into the Gumnut Dashboard
2. Navigate to API Keys
3. Click Create API Key
4. Name your key descriptively (e.g., “Production Server”, “Development”)
5. Choose what the key is allowed to do:
   • View only
   • View, add, and edit
   • View, add, edit, and move to trash (the default)
   • Full access — also permits permanent deletion
6. Choose which libraries it can reach — All current and future libraries, or Selected libraries (only the ones you pick; new libraries aren’t added automatically)
7. Copy and securely store the key

​

Using API Keys

curl -X GET https://api.gumnut.ai/api/assets \
  -H "Authorization: Bearer apikey_your_api_key_here"

​

TypeScript SDK

import Gumnut from 'gumnut-sdk';

const client = new Gumnut({
  apiKey: process.env.GUMNUT_API_KEY
});

​

Python SDK

import os
from gumnut import Gumnut

client = Gumnut(
    api_key=os.environ.get("GUMNUT_API_KEY")
)

​

Node.js with axios

import axios from 'axios';

const gumnutApi = axios.create({
  baseURL: 'https://api.gumnut.ai',
  headers: {
    Authorization: `Bearer ${process.env.GUMNUT_API_KEY}`,
  },
});

const { data } = await gumnutApi.get('/api/assets');
console.log(data);

​

Managing Keys

• See creation date and last used time
• Track usage statistics
• Revoke keys instantly

​

Error Handling

{
  "error": "unauthorized",
  "message": "Invalid or expired token"
}

• Verify the key is copied correctly (should start with apikey_)
• Check it hasn’t been revoked in the dashboard
• Ensure you’re using the correct environment’s key

{
  "error": "forbidden",
  "message": "Insufficient permissions for this operation"
}