Auth

POST /auth/register

Register a new user account

Creates a new user with the provided email and password. Returns the new user's API key.

Parameters

Name	Type	Required	Source	Description
email	string	✓	body	The user's email address
password	string	✓	body	The user's password (min 8 chars, must include uppercase, lowercase, and number)

Returns

object - User object with API key

Try It Out

Code Examples

JavaScript

const baseUrl = 'http://localhost:3010';
const path = '/auth/register';
const url = `${baseUrl}${path}`;

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
      "email": "[email protected]",
      "password": "TestPassword1"
    })
});
const data = await response.json();
console.log(data);

cURL

curl -X POST 'http://localhost:3010/auth/register' \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","password":"TestPassword1"}'

Python

import requests

base_url = 'http://localhost:3010'
path = '/auth/register'
url = f'{base_url}{path}'

response = requests.post(
    url,
    json={
      "email": "[email protected]",
      "password": "TestPassword1"
    }
)
data = response.json()
print(data)

TypeScript

import axios from 'axios';

(async () => {
  const baseUrl = 'http://localhost:3010';
  const path = '/auth/register';
  const url = `${baseUrl}${path}`;

  const response = await axios({
    method: 'post',
    headers: {
      'Content-Type': 'application/json'
    },
    url,
    data: {
        "email": "[email protected]",
        "password": "TestPassword1"
      }
  });
  const data = response.data;
  console.log(data);
})();

Emojicode

📦 sockets 🏠

💭 Emojicode HTTP Client
💭 Compile: emojicodec example.🍇 -o example
💭 Run: ./example

🏁 🍇
  💭 Connection settings
  🔤localhost🔤 ➡️ host
  3010 ➡️ port
  🔤/auth/register🔤 ➡️ path

  💭 Request body
  🔤{"email":"[email protected]","password":"TestPassword1"}🔤 ➡️ body

  💭 Build HTTP request
  🔤POST /auth/register HTTP/1.1❌r❌nHost: localhost:3010❌r❌nContent-Type: application/json❌r❌nContent-Length: 74❌r❌n❌r❌n{"email":"[email protected]","password":"TestPassword1"}🔤 ➡️ request

  💭 Connect and send
  🍺 🆕📞 host port❗ ➡️ socket
  🍺 💬 socket 📇 request❗❗
  
  💭 Read and print response
  🍺 👂 socket 4096❗ ➡️ data
  😀 🍺 🔡 data❗❗
  
  💭 Close socket
  🚪 socket❗
🍉

Response

Status: 201

{
  "apiKey": "your-api-key-here",
  "createdAt": "2026-04-20T04:05:55Z",
  "email": "[email protected]",
  "emailVerified": true,
  "id": 379,
  "sessionExpiresAt": "2026-05-20T04:05:55Z",
  "sessionToken": "your-api-key-here",
  "subscriptionStatus": "free"
}

---

POST /auth/login

Log in with email and password

Authenticates a user and returns their account details including API key.

Parameters

Name	Type	Required	Source	Description
email	string	✓	body	The user's email address
password	string	✓	body	The user's password

Returns

object - User object with API key

Try It Out

Code Examples

JavaScript

const baseUrl = 'http://localhost:3010';
const path = '/auth/login';
const url = `${baseUrl}${path}`;

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
      "email": "[email protected]",
      "password": "TestPassword123!"
    })
});
const data = await response.json();
console.log(data);

cURL

curl -X POST 'http://localhost:3010/auth/login' \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","password":"TestPassword123!"}'

Python

import requests

base_url = 'http://localhost:3010'
path = '/auth/login'
url = f'{base_url}{path}'

response = requests.post(
    url,
    json={
      "email": "[email protected]",
      "password": "TestPassword123!"
    }
)
data = response.json()
print(data)

TypeScript

import axios from 'axios';

(async () => {
  const baseUrl = 'http://localhost:3010';
  const path = '/auth/login';
  const url = `${baseUrl}${path}`;

  const response = await axios({
    method: 'post',
    headers: {
      'Content-Type': 'application/json'
    },
    url,
    data: {
        "email": "[email protected]",
        "password": "TestPassword123!"
      }
  });
  const data = response.data;
  console.log(data);
})();

Emojicode

📦 sockets 🏠

💭 Emojicode HTTP Client
💭 Compile: emojicodec example.🍇 -o example
💭 Run: ./example

🏁 🍇
  💭 Connection settings
  🔤localhost🔤 ➡️ host
  3010 ➡️ port
  🔤/auth/login🔤 ➡️ path

  💭 Request body
  🔤{"email":"[email protected]","password":"TestPassword123!"}🔤 ➡️ body

  💭 Build HTTP request
  🔤POST /auth/login HTTP/1.1❌r❌nHost: localhost:3010❌r❌nContent-Type: application/json❌r❌nContent-Length: 78❌r❌n❌r❌n{"email":"[email protected]","password":"TestPassword123!"}🔤 ➡️ request

  💭 Connect and send
  🍺 🆕📞 host port❗ ➡️ socket
  🍺 💬 socket 📇 request❗❗
  
  💭 Read and print response
  🍺 👂 socket 4096❗ ➡️ data
  😀 🍺 🔡 data❗❗
  
  💭 Close socket
  🚪 socket❗
🍉

Response

Status: 200

{
  "apiKeyRotationRequired": false,
  "createdAt": "2026-04-20T04:05:42Z",
  "email": "[email protected]",
  "emailVerified": true,
  "id": 378,
  "requestsThisMonth": 276,
  "role": "user",
  "sessionExpiresAt": "2026-05-20T04:05:55Z",
  "sessionToken": "your-api-key-here"
}

---

POST /auth/regenerate-key

Regenerate API key

Generates a new API key for the authenticated user. The old key is invalidated.

Parameters

Name	Type	Required	Source	Description
email	string	✓	body	The user's email address
password	string	✓	body	The user's password

Returns

object - New API key

Try It Out

Code Examples

JavaScript

const baseUrl = 'http://localhost:3010';
const path = '/auth/regenerate-key';
const url = `${baseUrl}${path}`;

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
      "email": "[email protected]",
      "password": "TestPassword1"
    })
});
const data = await response.json();
console.log(data);

cURL

curl -X POST 'http://localhost:3010/auth/regenerate-key' \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","password":"TestPassword1"}'

Python

import requests

base_url = 'http://localhost:3010'
path = '/auth/regenerate-key'
url = f'{base_url}{path}'

response = requests.post(
    url,
    json={
      "email": "[email protected]",
      "password": "TestPassword1"
    }
)
data = response.json()
print(data)

TypeScript

import axios from 'axios';

(async () => {
  const baseUrl = 'http://localhost:3010';
  const path = '/auth/regenerate-key';
  const url = `${baseUrl}${path}`;

  const response = await axios({
    method: 'post',
    headers: {
      'Content-Type': 'application/json'
    },
    url,
    data: {
        "email": "[email protected]",
        "password": "TestPassword1"
      }
  });
  const data = response.data;
  console.log(data);
})();

Emojicode

📦 sockets 🏠

💭 Emojicode HTTP Client
💭 Compile: emojicodec example.🍇 -o example
💭 Run: ./example

🏁 🍇
  💭 Connection settings
  🔤localhost🔤 ➡️ host
  3010 ➡️ port
  🔤/auth/regenerate-key🔤 ➡️ path

  💭 Request body
  🔤{"email":"[email protected]","password":"TestPassword1"}🔤 ➡️ body

  💭 Build HTTP request
  🔤POST /auth/regenerate-key HTTP/1.1❌r❌nHost: localhost:3010❌r❌nContent-Type: application/json❌r❌nContent-Length: 74❌r❌n❌r❌n{"email":"[email protected]","password":"TestPassword1"}🔤 ➡️ request

  💭 Connect and send
  🍺 🆕📞 host port❗ ➡️ socket
  🍺 💬 socket 📇 request❗❗
  
  💭 Read and print response
  🍺 👂 socket 4096❗ ➡️ data
  😀 🍺 🔡 data❗❗
  
  💭 Close socket
  🚪 socket❗
🍉

Response

Status: 200

{
  "apiKey": "your-api-key-here"
}

---

GET /auth/user-data

Get user data

Retrieves the authenticated user's account details including usage statistics and subscription status.

Returns

object - User data object

Try It Out

Code Examples

JavaScript

const baseUrl = 'http://localhost:3010';
const path = '/auth/user-data';
const url = `${baseUrl}${path}`;

const response = await fetch(url, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer your-api-key-here'
  }
});
const data = await response.json();
console.log(data);

cURL

curl -X GET 'http://localhost:3010/auth/user-data' \
  -H "Authorization: Bearer your-api-key-here"

Python

import requests

base_url = 'http://localhost:3010'
path = '/auth/user-data'
url = f'{base_url}{path}'

response = requests.get(
    url,
    headers={
        'Authorization': 'Bearer your-api-key-here'
    }
)
data = response.json()
print(data)

TypeScript

import axios from 'axios';

(async () => {
  const baseUrl = 'http://localhost:3010';
  const path = '/auth/user-data';
  const url = `${baseUrl}${path}`;

  const response = await axios({
    method: 'get',
    headers: {
      'Authorization': 'Bearer your-api-key-here'
    },
    url
  });
  const data = response.data;
  console.log(data);
})();

Emojicode

📦 sockets 🏠

💭 Emojicode HTTP Client
💭 Compile: emojicodec example.🍇 -o example
💭 Run: ./example

🏁 🍇
  💭 Connection settings
  🔤localhost🔤 ➡️ host
  3010 ➡️ port
  🔤/auth/user-data🔤 ➡️ path

  💭 Build HTTP request
  🔤GET /auth/user-data HTTP/1.1❌r❌nHost: localhost:3010❌r❌nAuthorization: Bearer your-api-key-here❌r❌n❌r❌n🔤 ➡️ request

  💭 Connect and send
  🍺 🆕📞 host port❗ ➡️ socket
  🍺 💬 socket 📇 request❗❗
  
  💭 Read and print response
  🍺 👂 socket 4096❗ ➡️ data
  😀 🍺 🔡 data❗❗
  
  💭 Close socket
  🚪 socket❗
🍉

Response

Status: 200

{
  "apiKeyRotationRequired": false,
  "email": "[email protected]",
  "emailVerified": true,
  "id": 379,
  "limits": {
    "monthlyLimit": 1000000,
    "unlimitedMonthly": false
  },
  "requestsThisMonth": 0,
  "role": "user",
  "subscriptionStatus": "free"
}

---

GET /auth/export-data

Export user data

Exports all stored user data for GDPR data portability compliance.

Returns

object - Complete user data export

Try It Out

Code Examples

JavaScript

const baseUrl = 'http://localhost:3010';
const path = '/auth/export-data';
const url = `${baseUrl}${path}`;

const response = await fetch(url, {
  method: 'GET',
  headers: {
    'x-api-key': 'your-api-key-here'
  }
});
const data = await response.json();
console.log(data);

cURL

curl -X GET 'http://localhost:3010/auth/export-data' \
  -H "x-api-key: your-api-key-here"

Python

import requests

base_url = 'http://localhost:3010'
path = '/auth/export-data'
url = f'{base_url}{path}'

response = requests.get(
    url,
    headers={
        'x-api-key': 'your-api-key-here'
    }
)
data = response.json()
print(data)

TypeScript

import axios from 'axios';

(async () => {
  const baseUrl = 'http://localhost:3010';
  const path = '/auth/export-data';
  const url = `${baseUrl}${path}`;

  const response = await axios({
    method: 'get',
    headers: {
      'x-api-key': 'your-api-key-here'
    },
    url
  });
  const data = response.data;
  console.log(data);
})();

Emojicode

📦 sockets 🏠

💭 Emojicode HTTP Client
💭 Compile: emojicodec example.🍇 -o example
💭 Run: ./example

🏁 🍇
  💭 Connection settings
  🔤localhost🔤 ➡️ host
  3010 ➡️ port
  🔤/auth/export-data🔤 ➡️ path

  💭 Build HTTP request
  🔤GET /auth/export-data HTTP/1.1❌r❌nHost: localhost:3010❌r❌nx-api-key: your-api-key-here❌r❌n❌r❌n🔤 ➡️ request

  💭 Connect and send
  🍺 🆕📞 host port❗ ➡️ socket
  🍺 💬 socket 📇 request❗❗
  
  💭 Read and print response
  🍺 👂 socket 4096❗ ➡️ data
  😀 🍺 🔡 data❗❗
  
  💭 Close socket
  🚪 socket❗
🍉

Response

Status: 200

{
  "apiAccess": {
    "hasMasterKey": true
  },
  "exportDate": "2026-04-20T04:05:55Z",
  "scopedKeys": [],
  "subscription": {
    "status": "free",
    "stripeCustomerId": "",
    "subscriptionId": ""
  },
  "usage": {
    "requestsThisMonth": 276,
    "requestsToday": 276
  },
  "user": {
    "createdAt": "2026-04-20T04:05:42Z",
    "email": "[email protected]",
    "id": 378,
    "updatedAt": "2026-04-20T04:05:55Z"
  }
}

---

DELETE /auth/account

Delete user account

Permanently deletes the user's account and all associated data.

Parameters

Name	Type	Required	Source	Description
confirmEmail	string	✓	body	The user's email address (must match account email)
password	string	✓	body	The user's password for verification

Returns

object - Confirmation of deletion

Try It Out

Code Examples

JavaScript

const baseUrl = 'http://localhost:3010';
const path = '/auth/account';
const url = `${baseUrl}${path}`;

const response = await fetch(url, {
  method: 'DELETE',
  headers: {
    'x-api-key': 'your-api-key-here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
      "confirmEmail": "[email protected]",
      "password": "TestPassword1"
    })
});
const data = await response.json();
console.log(data);

cURL

curl -X DELETE 'http://localhost:3010/auth/account' \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{"confirmEmail":"[email protected]","password":"TestPassword1"}'

Python

import requests

base_url = 'http://localhost:3010'
path = '/auth/account'
url = f'{base_url}{path}'

response = requests.delete(
    url,
    headers={
        'x-api-key': 'your-api-key-here'
    },
    json={
      "confirmEmail": "[email protected]",
      "password": "TestPassword1"
    }
)
data = response.json()
print(data)

TypeScript

import axios from 'axios';

(async () => {
  const baseUrl = 'http://localhost:3010';
  const path = '/auth/account';
  const url = `${baseUrl}${path}`;

  const response = await axios({
    method: 'delete',
    headers: {
      'x-api-key': 'your-api-key-here',
      'Content-Type': 'application/json'
    },
    url,
    data: {
        "confirmEmail": "[email protected]",
        "password": "TestPassword1"
      }
  });
  const data = response.data;
  console.log(data);
})();

Emojicode

📦 sockets 🏠

💭 Emojicode HTTP Client
💭 Compile: emojicodec example.🍇 -o example
💭 Run: ./example

🏁 🍇
  💭 Connection settings
  🔤localhost🔤 ➡️ host
  3010 ➡️ port
  🔤/auth/account🔤 ➡️ path

  💭 Request body
  🔤{"confirmEmail":"[email protected]","password":"TestPassword1"}🔤 ➡️ body

  💭 Build HTTP request
  🔤DELETE /auth/account HTTP/1.1❌r❌nHost: localhost:3010❌r❌nx-api-key: your-api-key-here❌r❌nContent-Type: application/json❌r❌nContent-Length: 81❌r❌n❌r❌n{"confirmEmail":"[email protected]","password":"TestPassword1"}🔤 ➡️ request

  💭 Connect and send
  🍺 🆕📞 host port❗ ➡️ socket
  🍺 💬 socket 📇 request❗❗
  
  💭 Read and print response
  🍺 👂 socket 4096❗ ➡️ data
  😀 🍺 🔡 data❗❗
  
  💭 Close socket
  🚪 socket❗
🍉

Response

Status: 200

{
  "message": "Account successfully deleted",
  "success": true
}

---

POST /auth/change-password

Change password while logged in

Allows an authenticated user to change their password.

Parameters

Name	Type	Required	Source	Description
currentPassword	string	✓	body	The user's current password
newPassword	string	✓	body	The new password (min 8 chars, must include uppercase, lowercase, and number)

Returns

object - Success message

Try It Out

Code Examples

JavaScript

const baseUrl = 'http://localhost:3010';
const path = '/auth/change-password';
const url = `${baseUrl}${path}`;

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'x-api-key': 'your-api-key-here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
      "currentPassword": "TestPassword123!",
      "newPassword": "ChangedPassword2"
    })
});
const data = await response.json();
console.log(data);

cURL

curl -X POST 'http://localhost:3010/auth/change-password' \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{"currentPassword":"TestPassword123!","newPassword":"ChangedPassword2"}'

Python

import requests

base_url = 'http://localhost:3010'
path = '/auth/change-password'
url = f'{base_url}{path}'

response = requests.post(
    url,
    headers={
        'x-api-key': 'your-api-key-here'
    },
    json={
      "currentPassword": "TestPassword123!",
      "newPassword": "ChangedPassword2"
    }
)
data = response.json()
print(data)

TypeScript

import axios from 'axios';

(async () => {
  const baseUrl = 'http://localhost:3010';
  const path = '/auth/change-password';
  const url = `${baseUrl}${path}`;

  const response = await axios({
    method: 'post',
    headers: {
      'x-api-key': 'your-api-key-here',
      'Content-Type': 'application/json'
    },
    url,
    data: {
        "currentPassword": "TestPassword123!",
        "newPassword": "ChangedPassword2"
      }
  });
  const data = response.data;
  console.log(data);
})();

Emojicode

📦 sockets 🏠

💭 Emojicode HTTP Client
💭 Compile: emojicodec example.🍇 -o example
💭 Run: ./example

🏁 🍇
  💭 Connection settings
  🔤localhost🔤 ➡️ host
  3010 ➡️ port
  🔤/auth/change-password🔤 ➡️ path

  💭 Request body
  🔤{"currentPassword":"TestPassword123!","newPassword":"ChangedPassword2"}🔤 ➡️ body

  💭 Build HTTP request
  🔤POST /auth/change-password HTTP/1.1❌r❌nHost: localhost:3010❌r❌nx-api-key: your-api-key-here❌r❌nContent-Type: application/json❌r❌nContent-Length: 71❌r❌n❌r❌n{"currentPassword":"TestPassword123!","newPassword":"ChangedPassword2"}🔤 ➡️ request

  💭 Connect and send
  🍺 🆕📞 host port❗ ➡️ socket
  🍺 💬 socket 📇 request❗❗
  
  💭 Read and print response
  🍺 👂 socket 4096❗ ➡️ data
  😀 🍺 🔡 data❗❗
  
  💭 Close socket
  🚪 socket❗
🍉

Response

Status: 200

{
  "message": "Password changed successfully"
}

---

POST /auth/forgot-password

Request a password reset

Sends a password reset email if the account exists.

Parameters

Name	Type	Required	Source	Description
email	string	✓	body	The email address associated with the account

Returns

object - Generic success message

Try It Out

Code Examples

JavaScript

const baseUrl = 'http://localhost:3010';
const path = '/auth/forgot-password';
const url = `${baseUrl}${path}`;

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
      "email": "[email protected]"
    })
});
const data = await response.json();
console.log(data);

cURL

curl -X POST 'http://localhost:3010/auth/forgot-password' \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]"}'

Python

import requests

base_url = 'http://localhost:3010'
path = '/auth/forgot-password'
url = f'{base_url}{path}'

response = requests.post(
    url,
    json={
      "email": "[email protected]"
    }
)
data = response.json()
print(data)

TypeScript

import axios from 'axios';

(async () => {
  const baseUrl = 'http://localhost:3010';
  const path = '/auth/forgot-password';
  const url = `${baseUrl}${path}`;

  const response = await axios({
    method: 'post',
    headers: {
      'Content-Type': 'application/json'
    },
    url,
    data: {
        "email": "[email protected]"
      }
  });
  const data = response.data;
  console.log(data);
})();

Emojicode

📦 sockets 🏠

💭 Emojicode HTTP Client
💭 Compile: emojicodec example.🍇 -o example
💭 Run: ./example

🏁 🍇
  💭 Connection settings
  🔤localhost🔤 ➡️ host
  3010 ➡️ port
  🔤/auth/forgot-password🔤 ➡️ path

  💭 Request body
  🔤{"email":"[email protected]"}🔤 ➡️ body

  💭 Build HTTP request
  🔤POST /auth/forgot-password HTTP/1.1❌r❌nHost: localhost:3010❌r❌nContent-Type: application/json❌r❌nContent-Length: 47❌r❌n❌r❌n{"email":"[email protected]"}🔤 ➡️ request

  💭 Connect and send
  🍺 🆕📞 host port❗ ➡️ socket
  🍺 💬 socket 📇 request❗❗
  
  💭 Read and print response
  🍺 👂 socket 4096❗ ➡️ data
  😀 🍺 🔡 data❗❗
  
  💭 Close socket
  🚪 socket❗
🍉

Response

Status: 200

{
  "message": "If an account with that email exists, a password reset link has been sent."
}

---

POST /auth/reset-password

Reset password with token

Resets the user's password using a valid reset token.

Parameters

Name	Type	Required	Source	Description
token	string	✓	body	The password reset token from the email
password	string	✓	body	The new password (min 8 chars, must include uppercase, lowercase, and number)

Returns

object - Success message

Try It Out

---

GET /auth/validate-reset-token/:token

Validate a password reset token

Checks whether a password reset token is still valid before showing the reset form.

Parameters

Name	Type	Required	Source	Description
token	string	✓	params	The password reset token to validate

Returns

object - Token validity status

Try It Out

---

POST /auth/api-keys

Create a new scoped API key

Creates a sub-key under the authenticated user's master key with optional restrictions.

Parameters

Name	Type	Required	Source	Description
name	string	✓	body	Friendly name for the key
scopedClientId	string		body	Lock to specific Foundry client ID
scopedUserId	string		body	Lock to specific Foundry user ID
monthlyLimit	string		body	Per-key monthly request cap
expiresAt	string		body	Expiry timestamp (ISO 8601)
foundryUrl	string		body	Foundry instance URL for headless sessions
foundryUsername	string		body	Foundry login username
foundryPassword	string		body	Foundry login password (encrypted at rest)

Returns

object - New scoped API key details

Try It Out

Code Examples

JavaScript

const baseUrl = 'http://localhost:3010';
const path = '/auth/api-keys';
const url = `${baseUrl}${path}`;

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'x-api-key': 'your-api-key-here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
      "name": "Test Scoped Key",
      "scopes": [
        "entity:read",
        "structure:read"
      ],
      "monthlyLimit": "500"
    })
});
const data = await response.json();
console.log(data);

cURL

curl -X POST 'http://localhost:3010/auth/api-keys' \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{"name":"Test Scoped Key","scopes":["entity:read","structure:read"],"monthlyLimit":"500"}'

Python

import requests

base_url = 'http://localhost:3010'
path = '/auth/api-keys'
url = f'{base_url}{path}'

response = requests.post(
    url,
    headers={
        'x-api-key': 'your-api-key-here'
    },
    json={
      "name": "Test Scoped Key",
      "scopes": [
        "entity:read",
        "structure:read"
      ],
      "monthlyLimit": "500"
    }
)
data = response.json()
print(data)

TypeScript

import axios from 'axios';

(async () => {
  const baseUrl = 'http://localhost:3010';
  const path = '/auth/api-keys';
  const url = `${baseUrl}${path}`;

  const response = await axios({
    method: 'post',
    headers: {
      'x-api-key': 'your-api-key-here',
      'Content-Type': 'application/json'
    },
    url,
    data: {
        "name": "Test Scoped Key",
        "scopes": [
          "entity:read",
          "structure:read"
        ],
        "monthlyLimit": "500"
      }
  });
  const data = response.data;
  console.log(data);
})();

Emojicode

📦 sockets 🏠

💭 Emojicode HTTP Client
💭 Compile: emojicodec example.🍇 -o example
💭 Run: ./example

🏁 🍇
  💭 Connection settings
  🔤localhost🔤 ➡️ host
  3010 ➡️ port
  🔤/auth/api-keys🔤 ➡️ path

  💭 Request body
  🔤{"name":"Test Scoped Key","scopes":["entity:read","structure:read"],"monthlyLimit":"500"}🔤 ➡️ body

  💭 Build HTTP request
  🔤POST /auth/api-keys HTTP/1.1❌r❌nHost: localhost:3010❌r❌nx-api-key: your-api-key-here❌r❌nContent-Type: application/json❌r❌nContent-Length: 89❌r❌n❌r❌n{"name":"Test Scoped Key","scopes":["entity:read","structure:read"],"monthlyLimit":"500"}🔤 ➡️ request

  💭 Connect and send
  🍺 🆕📞 host port❗ ➡️ socket
  🍺 💬 socket 📇 request❗❗
  
  💭 Read and print response
  🍺 👂 socket 4096❗ ➡️ data
  😀 🍺 🔡 data❗❗
  
  💭 Close socket
  🚪 socket❗
🍉

Response

Status: 201

{
  "createdAt": "2026-04-20T04:06:35Z",
  "enabled": true,
  "expiresAt": null,
  "id": 2184,
  "key": "your-api-key-here",
  "monthlyLimit": 500,
  "name": "Test Scoped Key",
  "scopedClientId": "",
  "scopedClientIds": null,
  "scopedUserId": "",
  "scopedUserIds": null,
  "scopes": [
    0: "entity:read",
    1: "structure:read"
  ]
}

---

GET /auth/api-keys

List all scoped API keys

Returns all scoped keys for the authenticated user.

Returns

array - Array of scoped API keys

Try It Out

Code Examples

JavaScript

const baseUrl = 'http://localhost:3010';
const path = '/auth/api-keys';
const url = `${baseUrl}${path}`;

const response = await fetch(url, {
  method: 'GET',
  headers: {
    'x-api-key': 'your-api-key-here'
  }
});
const data = await response.json();
console.log(data);

cURL

curl -X GET 'http://localhost:3010/auth/api-keys' \
  -H "x-api-key: your-api-key-here"

Python

import requests

base_url = 'http://localhost:3010'
path = '/auth/api-keys'
url = f'{base_url}{path}'

response = requests.get(
    url,
    headers={
        'x-api-key': 'your-api-key-here'
    }
)
data = response.json()
print(data)

TypeScript

import axios from 'axios';

(async () => {
  const baseUrl = 'http://localhost:3010';
  const path = '/auth/api-keys';
  const url = `${baseUrl}${path}`;

  const response = await axios({
    method: 'get',
    headers: {
      'x-api-key': 'your-api-key-here'
    },
    url
  });
  const data = response.data;
  console.log(data);
})();

Emojicode

📦 sockets 🏠

💭 Emojicode HTTP Client
💭 Compile: emojicodec example.🍇 -o example
💭 Run: ./example

🏁 🍇
  💭 Connection settings
  🔤localhost🔤 ➡️ host
  3010 ➡️ port
  🔤/auth/api-keys🔤 ➡️ path

  💭 Build HTTP request
  🔤GET /auth/api-keys HTTP/1.1❌r❌nHost: localhost:3010❌r❌nx-api-key: your-api-key-here❌r❌n❌r❌n🔤 ➡️ request

  💭 Connect and send
  🍺 🆕📞 host port❗ ➡️ socket
  🍺 💬 socket 📇 request❗❗
  
  💭 Read and print response
  🍺 👂 socket 4096❗ ➡️ data
  😀 🍺 🔡 data❗❗
  
  💭 Close socket
  🚪 socket❗
🍉

Response

Status: 200

{
  "keys": [
    0: {
      "createdAt": "2026-04-20T04:06:35Z",
      "enabled": true,
      "expiresAt": null,
      "id": 2184,
      "isExpired": false,
      "key": "e0c0c934...",
      "monthlyLimit": 500,
      "name": "Test Scoped Key",
      "requestsThisMonth": 0,
      "scopedClientId": "",
      "scopedClientIds": null,
      "scopedUserId": "",
      "scopedUserIds": null,
      "scopes": [ 2 items ],
      "updatedAt": "2026-04-20T04:06:35Z"
    }
  ]
}

---

DELETE /auth/api-keys/:id

Delete a scoped API key

Permanently deletes a scoped key.

Parameters

Name	Type	Required	Source	Description
id	string	✓	params	The scoped key ID

Returns

object - Success message

Try It Out

Code Examples

JavaScript

const baseUrl = 'http://localhost:3010';
const path = '/auth/api-keys/2184';
const url = `${baseUrl}${path}`;

const response = await fetch(url, {
  method: 'DELETE',
  headers: {
    'x-api-key': 'your-api-key-here'
  }
});
const data = await response.json();
console.log(data);

cURL

curl -X DELETE 'http://localhost:3010/auth/api-keys/2184' \
  -H "x-api-key: your-api-key-here"

Python

import requests

base_url = 'http://localhost:3010'
path = '/auth/api-keys/2184'
url = f'{base_url}{path}'

response = requests.delete(
    url,
    headers={
        'x-api-key': 'your-api-key-here'
    }
)
data = response.json()
print(data)

TypeScript

import axios from 'axios';

(async () => {
  const baseUrl = 'http://localhost:3010';
  const path = '/auth/api-keys/2184';
  const url = `${baseUrl}${path}`;

  const response = await axios({
    method: 'delete',
    headers: {
      'x-api-key': 'your-api-key-here'
    },
    url
  });
  const data = response.data;
  console.log(data);
})();

Emojicode

📦 sockets 🏠

💭 Emojicode HTTP Client
💭 Compile: emojicodec example.🍇 -o example
💭 Run: ./example

🏁 🍇
  💭 Connection settings
  🔤localhost🔤 ➡️ host
  3010 ➡️ port
  🔤/auth/api-keys/2184🔤 ➡️ path

  💭 Build HTTP request
  🔤DELETE /auth/api-keys/2184 HTTP/1.1❌r❌nHost: localhost:3010❌r❌nx-api-key: your-api-key-here❌r❌n❌r❌n🔤 ➡️ request

  💭 Connect and send
  🍺 🆕📞 host port❗ ➡️ socket
  🍺 💬 socket 📇 request❗❗
  
  💭 Read and print response
  🍺 👂 socket 4096❗ ➡️ data
  😀 🍺 🔡 data❗❗
  
  💭 Close socket
  🚪 socket❗
🍉

Response

Status: 200

{
  "message": "API key deleted",
  "success": true
}