> ## Documentation Index > Fetch the complete documentation index at: https://docs.akua.dev/llms.txt > Use this file to discover all available pages before exploring further. # Suggest what you mainly do > Ranks the four onboarding answers from visited landing roles, sign-up attribution, early dashboard pages and installed apps in the selected workspace. Returns both deterministic and available evaluated reader evidence with reasons. Confirmation through PATCH is required to save a choice; this operation never changes preferences. ## OpenAPI ````yaml /openapi-public.json post /dashboard_preferences:suggestRole openapi: 3.1.0 info: title: Akua API version: 1.0.0 description: >- Public API for managing Akua workspaces, clusters, products, and installs. Authenticate with a workspace API token via the `Authorization: Bearer sk_akua_...` header. A workspace-owned token implies its workspace. Broad tokens select the active workspace via the optional `Akua-Context` header. contact: name: Akua API support email: support@akua.dev url: https://akua.dev/docs servers: - url: https://api.akua.dev/v1 description: Production security: [] tags: - name: Auth description: Authentication and token management. - name: Agent events description: Persisted agent transcripts and response recovery. - name: Custom domains description: Workspace custom domains and routing targets. - name: Cloudflare description: Cloudflare account credentials and gateway control. - name: Clusters description: Kubernetes clusters and cluster access operations. - name: ComputeConfigs description: Workspace compute provider configurations. - name: Entitlements description: Effective workspace capabilities and limits. - name: Dashboards description: Dashboard and widget resources. - name: Installs description: Installation and render operations. - name: Machines description: Compute machines and lifecycle events. - name: Notifications description: User notification state. - name: Offer Channels description: Private offer channels and policy versions. - name: Offers description: Marketplace offers and redemption tracking. - name: Operations description: Long-running operation status and controls. - name: Order Drafts description: Draft checkout orders and checkout sessions. - name: Organizations description: Organizations, memberships, and managed workspaces. - name: Packages description: Software packages, versions, and input schemas. - name: Products description: Marketplace product catalog resources. - name: Preview hostnames description: Install preview hostnames and routing state. - name: Quotas description: Workspace quota limits and usage. - name: Regions description: Available deployment regions. - name: Registry description: Container registry credentials and repositories. - name: Repository change requests description: Fork-backed repository change reviews and lifecycle actions. - name: Repositories description: Source repositories available to the workspace. - name: Secrets description: Workspace secrets and secret versions. - name: Snippets description: Reusable snippets and snippet runs. - name: Workspace subdomains description: Workspace subdomain identity. - name: Workspaces description: Workspace resources, members, and billing state. paths: /dashboard_preferences:suggestRole: post: tags: - Dashboard Preferences summary: Suggest what you mainly do description: >- Ranks the four onboarding answers from visited landing roles, sign-up attribution, early dashboard pages and installed apps in the selected workspace. Returns both deterministic and available evaluated reader evidence with reasons. Confirmation through PATCH is required to save a choice; this operation never changes preferences. operationId: dashboardPreferences.suggestRole parameters: - name: akua-context in: header schema: type: string minLength: 1 maxLength: 53 description: >- Optional workspace/scope context for the request. Carries a single workspace wire id (`ws_…`) today. Only needed for broad tokens - a workspace-owned token implies its workspace. examples: - ws_j572abc123def456 required: false requestBody: content: application/json: schema: $ref: '#/components/schemas/DashboardRoleSuggestionRequest' required: true responses: '200': description: DashboardRoleSuggestion content: application/json: schema: $ref: '#/components/schemas/DashboardRoleSuggestion' '400': description: The request is malformed. content: application/json: schema: $ref: '#/components/schemas/ApiBadRequest' '401': description: Missing, invalid or expired credential. content: application/json: schema: $ref: '#/components/schemas/ApiUnauthorized' '403': description: The credential may not act in this workspace. content: application/json: schema: $ref: '#/components/schemas/ApiForbidden' '429': description: The caller is over its per-minute budget. content: application/json: schema: $ref: '#/components/schemas/ApiTooManyRequests' '503': description: The service is temporarily unavailable. content: application/json: schema: $ref: '#/components/schemas/ApiServiceUnavailable' security: - BearerAuth: [] components: schemas: DashboardRoleSuggestionRequest: type: object properties: landing: type: array items: type: object properties: kind: type: string enum: - role_tab - role_page - use_case_page - use_case_chip role_preset: type: string enum: - owners - operations - developers - vendors use_case: type: string enum: - customer-database - online-orders - email-assistant - social-posts - up-to-date - automation - website - customer-cloud - more-customers - staged-updates - customer-template - partner-channel required: - kind - role_preset additionalProperties: false maxItems: 20 signup_source: type: string maxLength: 200 utm: type: object properties: source: type: string maxLength: 200 medium: type: string maxLength: 200 campaign: type: string maxLength: 200 content: type: string maxLength: 200 term: type: string maxLength: 200 additionalProperties: false dashboard_visits: type: array items: type: string enum: - home - workspace - marketplace - packages - products - offers - managed_deployments - customers - apps - agents - repository_change_requests - operations - docs - compute - machines - clusters - secrets - registries - regions - cloudflare - dashboards - snippets - runs - quotas - api_tokens - billing - account - organization_members - organization - notifications - payments - access maxItems: 20 first_chat_message: type: string maxLength: 2000 additionalProperties: false DashboardRoleSuggestion: type: object properties: suggested_role: anyOf: - type: string enum: - owners - operations - developers - vendors - type: 'null' source: type: string enum: - baseline - jev baseline: type: object properties: suggested_role: anyOf: - type: string enum: - owners - operations - developers - vendors - type: 'null' confidence: type: number minimum: 0 maximum: 1 ranked_roles: type: array items: type: object properties: role_preset: type: string enum: - owners - operations - developers - vendors score: type: integer minimum: 0 reasons: type: array items: type: string required: - role_preset - score - reasons additionalProperties: false why: type: string required: - suggested_role - confidence - ranked_roles - why additionalProperties: false jev: anyOf: - type: object properties: probabilities: type: object properties: owners: type: number minimum: 0 maximum: 1 operations: type: number minimum: 0 maximum: 1 developers: type: number minimum: 0 maximum: 1 vendors: type: number minimum: 0 maximum: 1 required: - owners - operations - developers - vendors additionalProperties: false model: type: string eligible: type: boolean required: - probabilities - model - eligible additionalProperties: false - type: 'null' reasons: type: array items: type: string why: type: string required: - suggested_role - source - baseline - jev - reasons - why additionalProperties: false ApiBadRequest: type: object properties: _tag: type: string enum: - Validation success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiUnauthorized: type: object properties: _tag: type: string enum: - Unauthorized success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiForbidden: type: object properties: _tag: type: string enum: - Forbidden success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiTooManyRequests: type: object properties: _tag: type: string enum: - TooManyRequests success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiServiceUnavailable: type: object properties: _tag: type: string enum: - ServiceUnavailable success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiErrorEntry: type: object properties: code: type: integer description: Machine-readable error code examples: - 7002 message: type: string description: Human-readable error message examples: - Resource not found path: type: array items: type: string description: Field path that caused the error, when applicable examples: - - body - name metadata: type: object additionalProperties: type: string required: - code - message additionalProperties: false securitySchemes: BearerAuth: description: >- workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.