> ## Documentation Index > Fetch the complete documentation index at: https://docs.cotool.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get current user permissions and all available permissions > Returns the current user's effective permissions and the list of all permission definitions available in the system. ## OpenAPI ````yaml https://app.cotool.ai/api/docs/openapi.json get /api/perms openapi: 3.1.0 info: title: Cotool API version: 1.0.0 description: >- # Cotool API Documentation The Cotool API allows you to interact with the Cotool platform programmatically, enabling you to build powerful integrations and automate your workflows. ## Getting an API Key Follow these steps to generate your API key: 1. **Log in** to the Cotool web interface 2. **Navigate** to `/settings/api-keys` 3. **Click** "Generate Key" 4. **Copy and store** your API key securely ⚠️ *It won't be shown again* ## API Key Authentication For programmatic access and integrations, use your API key with the Authorization header: ```http Authorization: Bearer your_api_key_here ``` ```bash curl -X GET "https://app.cotool.ai/api/endpoint" \ -H "Authorization: Bearer your_api_key_here" \ -H "Content-Type: application/json" ``` servers: - url: https://app.cotool.ai description: Production server security: - ApiKeyAuth: [] paths: /api/perms: get: tags: - Users summary: Get current user permissions and all available permissions description: >- Returns the current user's effective permissions and the list of all permission definitions available in the system. responses: '200': description: Successful response content: application/json: schema: type: object properties: userPerms: type: array items: anyOf: - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: agent.create required: - resource - action - type: object properties: resource: anyOf: - type: object properties: type: type: string const: all required: - type - type: object properties: type: type: string const: specific id: type: string required: - type - id action: type: string const: agent.read required: - resource - action - type: object properties: resource: anyOf: - type: object properties: type: type: string const: all required: - type - type: object properties: type: type: string const: specific id: type: string required: - type - id action: type: string const: agent.execute required: - resource - action - type: object properties: resource: anyOf: - type: object properties: type: type: string const: all required: - type - type: object properties: type: type: string const: specific id: type: string required: - type - id action: type: string const: agent.edit required: - resource - action - type: object properties: resource: anyOf: - type: object properties: type: type: string const: all required: - type - type: object properties: type: type: string const: specific id: type: string required: - type - id action: type: string const: tool.use required: - resource - action - type: object properties: resource: anyOf: - type: object properties: type: type: string const: all required: - type - type: object properties: type: type: string const: specific id: type: string required: - type - id action: type: string const: tool.read required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: tool.manage required: - resource - action - type: object properties: resource: anyOf: - type: object properties: type: type: string const: all required: - type - type: object properties: type: type: string const: specific id: type: string required: - type - id action: type: string const: cli.read required: - resource - action - type: object properties: resource: anyOf: - type: object properties: type: type: string const: all required: - type - type: object properties: type: type: string const: specific id: type: string required: - type - id action: type: string const: cli.use required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: cli.manage required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: chat.manage required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: alert.triage required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: alert.manage required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.perms.manage required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.users.update required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.users.invite required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.users.delete required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.apiKey.manage required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.auditLog.read required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.customModel.manage required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.auth.manage required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.tags.manage required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.suggestions.manage required: - resource - action allPerms: type: array items: anyOf: - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: agent.create required: - resource - action - type: object properties: resource: anyOf: - type: object properties: type: type: string const: all required: - type - type: object properties: type: type: string const: specific id: type: string required: - type - id action: type: string const: agent.read required: - resource - action - type: object properties: resource: anyOf: - type: object properties: type: type: string const: all required: - type - type: object properties: type: type: string const: specific id: type: string required: - type - id action: type: string const: agent.execute required: - resource - action - type: object properties: resource: anyOf: - type: object properties: type: type: string const: all required: - type - type: object properties: type: type: string const: specific id: type: string required: - type - id action: type: string const: agent.edit required: - resource - action - type: object properties: resource: anyOf: - type: object properties: type: type: string const: all required: - type - type: object properties: type: type: string const: specific id: type: string required: - type - id action: type: string const: tool.use required: - resource - action - type: object properties: resource: anyOf: - type: object properties: type: type: string const: all required: - type - type: object properties: type: type: string const: specific id: type: string required: - type - id action: type: string const: tool.read required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: tool.manage required: - resource - action - type: object properties: resource: anyOf: - type: object properties: type: type: string const: all required: - type - type: object properties: type: type: string const: specific id: type: string required: - type - id action: type: string const: cli.read required: - resource - action - type: object properties: resource: anyOf: - type: object properties: type: type: string const: all required: - type - type: object properties: type: type: string const: specific id: type: string required: - type - id action: type: string const: cli.use required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: cli.manage required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: chat.manage required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: alert.triage required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: alert.manage required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.perms.manage required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.users.update required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.users.invite required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.users.delete required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.apiKey.manage required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.auditLog.read required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.customModel.manage required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.auth.manage required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.tags.manage required: - resource - action - type: object properties: resource: type: object properties: type: type: string const: all required: - type action: type: string const: setting.suggestions.manage required: - resource - action required: - userPerms - allPerms '400': description: Bad request — input validation failed or the request was malformed content: application/json: schema: $ref: '#/components/schemas/ValidationError' '401': description: Unauthorized — missing or invalid API key / session content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden — the authenticated user lacks the required permissions content: application/json: schema: $ref: '#/components/schemas/PermissionError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' x-codeSamples: - lang: shell label: cURL source: |- curl -X GET "https://app.cotool.ai/api/perms" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" components: schemas: ValidationError: type: object properties: error: type: string description: Error message describing what went wrong issues: type: array description: >- Detailed validation issues, present when request or response schema validation fails items: type: object additionalProperties: true required: - error Error: type: object properties: error: type: string description: Error message describing what went wrong required: - error PermissionError: type: object properties: error: type: string description: Error message describing what went wrong missingPerms: type: array description: Permissions the authenticated user is missing for this operation items: type: string required: - error securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API Key description: >- API Key authentication for programmatic access. Include your API key in the Authorization header as: `Bearer your_api_key_here` ````