API Keys

API key management endpoints

List API keys

get

https://api.visobird.comhttp://localhost:3000

/api/v1/api-keys

Get a list of your API keys with optional full key display and plan limits

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication. Include your API key in the Authorization header:

Authorization: Bearer vb_your_api_key_here

Query parameters

fullbooleanOptional

Show full API keys instead of masked versions

Default: false

Responses

200

List of API keys with plan limits

application/json

401

Authentication required or invalid API key

application/json

500

Internal server error

application/json

get

/api/v1/api-keys

HTTPcURLJavaScriptPython

GET /api/v1/api-keys HTTP/1.1
Host: api.visobird.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "apiKeys": [
    {
      "id": "key_123",
      "name": "Production API Key",
      "key": "vb_abcd1234...xyz9",
      "fullKey": "vb_abcd1234efgh5678ijkl9012mnop3456qrst7890uvwxyz9",
      "isActive": true,
      "lastUsedAt": "2024-01-15T10:30:00Z",
      "createdAt": "2024-01-01T08:00:00Z"
    }
  ],
  "limits": {
    "current": 2,
    "max": 5,
    "planName": "Pro"
  }
}

Create API key

post

https://api.visobird.comhttp://localhost:3000

/api/v1/api-keys

Create a new API key

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication. Include your API key in the Authorization header:

Authorization: Bearer vb_your_api_key_here

Body

application/json

namestring · min: 1 · max: 100Required

Human-readable name for the API key

Responses

200

API key created successfully

application/json

400

Bad request

application/json

401

Authentication required or invalid API key

application/json

403

API key limit exceeded

application/json

500

Internal server error

application/json

post

/api/v1/api-keys

HTTPcURLJavaScriptPython

POST /api/v1/api-keys HTTP/1.1
Host: api.visobird.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "name": "My New API Key"
}

{
  "apiKey": {
    "id": "key_123",
    "name": "My New API Key",
    "key": "vb_abcd1234efgh5678ijkl9012mnop3456qrst7890uvwxyz9",
    "isActive": true,
    "createdAt": "2024-01-15T10:30:00Z"
  }
}

Delete API key

delete

https://api.visobird.comhttp://localhost:3000

/api/v1/api-keys

Delete an API key

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication. Include your API key in the Authorization header:

Authorization: Bearer vb_your_api_key_here

Query parameters

idstringRequired

API key ID to delete

Example: key_123

Responses

200

API key deleted successfully

application/json

400

Bad request

application/json

401

Authentication required or invalid API key

application/json

500

Internal server error

application/json

delete

/api/v1/api-keys

HTTPcURLJavaScriptPython

DELETE /api/v1/api-keys?id=key_123 HTTP/1.1
Host: api.visobird.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true
}