Create API key
Create a new API key with specified permissions and metadata. The signed API token is returned once.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Request Body
application/json
name*string
Human-readable name for the API key
Length
1 <= lengthdescription?string
Description of the API key purpose
role*string
Role/permissions for this API key
Value in
"account_manager" | "admin" | "content_manager" | "viewer"expiration?string
Optional expiration preset
Value in
"30days" | "90days" | "1year" | "never"Response Body
application/json
application/json
curl -X POST "https://app.orbiqhq.com/api/v1/integrations/api-keys" \ -H "Content-Type: application/json" \ -d '{ "name": "Production Integration", "role": "account_manager" }'{
"success": true,
"data": {
"token": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"role": "0f3d9f4e-7fcb-45f1-8824-95cb11b2b2d6",
"expires_at": "2025-12-31T23:59:59Z",
"created_at": "2025-01-01T10:00:00Z"
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}{
"error": "Invalid input: role: Invalid option"
}Empty
Empty
How is this guide?