List API Keys Response Array of API key objects Key name (1-100 characters)
First 8 characters of the key (e.g., “os_live_”)
ISO 8601 timestamp of last use (null if never used)
Number of requests made today
Number of requests made this month
Example Request curl -X GET "https://api.opensight.ai/api/api-keys" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response { "keys" : [ { "id" : "key_123" , "user_id" : "user_456" , "name" : "Production API Key" , "key_prefix" : "os_live_" , "last_used_at" : "2024-01-15T10:00:00Z" , "requests_today" : 45 , "requests_month" : 1250 , "created_at" : "2024-01-01T08:00:00Z" }, { "id" : "key_124" , "user_id" : "user_456" , "name" : "Development Key" , "key_prefix" : "os_test_" , "last_used_at" : null , "requests_today" : 0 , "requests_month" : 0 , "created_at" : "2024-01-10T14:00:00Z" } ] }
Create API Key Request Body Descriptive name for the API key (1-100 characters)
Response The created API key object with full key value Full API key value (only returned on creation)
First 8 characters of the key
Security warning about saving the key
Example Request curl -X POST "https://api.opensight.ai/api/api-keys" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Production API Key" }'
Example Response { "key" : { "id" : "key_123" , "user_id" : "user_456" , "name" : "Production API Key" , "key" : "os_live_1234567890abcdef1234567890abcdef" , "key_prefix" : "os_live_" , "last_used_at" : null , "requests_today" : 0 , "requests_month" : 0 , "created_at" : "2024-01-15T10:00:00Z" }, "warning" : "Please save this API key in a secure location. You will not be able to view it again." }
The full API key is only shown once during creation. Store it securely as you cannot retrieve it again. If you lose the key, you must create a new one.
Errors
403 Forbidden - API key limit reached for your plan400 Bad Request - Invalid input data
Plan Limits
Free : 2 API keysStarter : 5 API keysGrowth : 20 API keys
Delete API Key Path Parameters Response The revoked API key object
Example Request curl -X DELETE "https://api.opensight.ai/api/api-keys/key_123" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response { "key" : { "id" : "key_123" , "user_id" : "user_456" , "name" : "Production API Key" , "key_prefix" : "os_live_" , "last_used_at" : "2024-01-15T10:00:00Z" , "requests_today" : 45 , "requests_month" : 1250 , "created_at" : "2024-01-01T08:00:00Z" }, "message" : "API key has been revoked and is no longer usable" }
Errors
404 Not Found - API key not found or user doesn’t own it400 Bad Request - API key already revoked
Best Practices
Rotation : Regularly rotate API keys for securityNaming : Use descriptive names to identify key purposesLeast Privilege : Create separate keys for different environments (production, staging, development)Monitoring : Track key usage through requests_today and requests_month fieldsRevocation : Immediately revoke keys if compromised
Using API Keys Include your API key in the Authorization header of all API requests:
Authorization: Bearer os_live_1234567890abcdef1234567890abcdef
Or use it as a query parameter (less secure):
https://api.opensight.ai/api/brands?api_key =os_live_1234567890abcdef1234567890abcdef
The header method is strongly recommended for security. Query parameters may be logged in server access logs.