> ## Documentation Index > Fetch the complete documentation index at: https://docs.neo.projectdiscovery.io/llms.txt > Use this file to discover all available pages before exploring further. # Get current user > Get the current authenticated user's profile information including: - Email and role - Feature flags (neo_ai access, etc.) - User tag (if any) - Team membership (if user belongs to a team) ## OpenAPI ````yaml /openapi/neo.public.openapi.json get /api/v1/user openapi: 3.1.0 info: contact: name: ProjectDiscovery url: https://neo.projectdiscovery.io description: Neo API Server - Security agent orchestration platform license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 title: Neo API version: 1.0.0 servers: - description: Production url: https://neo.api.projectdiscovery.io - description: Development url: https://neo.api.dev.projectdiscovery.io - description: Local development url: http://localhost:8080 security: [] tags: - description: Task execution and management name: Tasks - description: Agent listing and management name: Agents - description: Public agent directory name: Agent Directory - description: User file storage management name: Files - description: User working memory management name: Memory - description: Scheduled and recurring task management name: Schedules - description: Knowledge base and semantic search name: Knowledge - description: Encrypted user credentials and API keys name: Secrets - description: Neo API key management for programmatic access name: API Keys - description: User profile and account information name: User - description: Task and LLM usage tracking name: Usage - description: Bring Your Own Key provider management name: BYOK - description: Connect personal AI provider accounts and select them as a model source name: AI Connections - description: Model discovery and capabilities name: Models - description: Third-party integrations name: Integrations - description: Skill knowledge documents for agent prompts name: Skills - description: User-authored tools and toolkit management name: Dynamic Tools - description: Team management and member invitations name: Teams - description: Prompt library management and discovery name: Prompts - description: Slack bot integration for workspace installation and OAuth name: Slack - description: GitHub integration for PR reviews and repository management name: GitHub - description: Vulnerability issue tracking and management name: Issues - description: Subscription billing and plans name: Billing - description: Project management and member assignments name: Projects - description: SSH key pair generation and management for remote server access name: SSH Keys - description: Codebase structural analysis and mapping name: Codemaps - description: AI-generated codebase documentation and security analysis name: CodeWiki - description: Captured HTTP traffic query and replay name: Network Events - description: User and team API activity metadata name: Audit Logs - description: Vulnerability triage for HackerOne, GitHub, and Security Inbox name: Triage paths: /api/v1/user: get: tags: - User summary: Get current user description: | Get the current authenticated user's profile information including: - Email and role - Feature flags (neo_ai access, etc.) - User tag (if any) - Team membership (if user belongs to a team) operationId: get-v1-user responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserProfileResponse' description: User profile information '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Unauthorized '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Internal server error security: - BearerAuth: [] - ApiKeyAuth: [] components: schemas: UserProfileResponse: properties: ai_connection_models: description: >- Models exposed by the user's AI connections. Returned when AI connections are selected. items: $ref: '#/components/schemas/AIConnectionModel' type: array available_models: description: >- List of canonical Neo model IDs available for the user. In BYOK mode this contains only discovered provider models that Neo supports. items: type: string type: array byok_models: description: >- Provider-discovered BYOK models with Neo support classification. Returned when the user is in BYOK mode. items: $ref: '#/components/schemas/ByokDiscoveredModel' type: array cap: allOf: - $ref: '#/components/schemas/SpendingCapStatus' description: >- Caller's own effective spending-cap status (source/limit/used/remaining). Null for solo / no-team users or when the team isn't on a spend-controls plan. Drives the user's own cap banner. nullable: true egress_ip: $ref: '#/components/schemas/EgressIPInfo' description: Outbound IP information for customer allowlists nullable: true email: description: User's email address format: email type: string features: additionalProperties: {} description: > Feature flags for the user. Values may be booleans (neo_ai), numbers (neo_credits), or objects. The protected_domains flag controls the government-domain guardrail per user and accepts: true to reset to the default (the policy is default-on for free-plan users), {"enabled": false} or false to disable it, or {"tlds": [".gov", ...]} to replace the default suffix list. An explicit flag always wins over the plan default. example: neo_ai: true neo_credits: 500 protected_domains: enabled: false type: object model_use_mode: description: Effective model source for the current user. enum: - neo - byok - ai_connections type: string x-enum-varnames: - UserProfileResponseModelUseModeNeo - UserProfileResponseModelUseModeByok - UserProfileResponseModelUseModeAIConnections model_use_scope: $ref: '#/components/schemas/ModelUseScope' neo_cost_rate: description: >- Effective BYOK neo cost rate for the user. Returned when the user is in BYOK mode. format: float nullable: true type: number onboarding: $ref: '#/components/schemas/UserOnboardingStatus' description: >- Onboarding status flags for the user (active subscription, team membership) role: description: User's role in the system enum: - user - admin type: string source_type: description: >- Event the account's credits were attributed to, via a promo code or an admin grant. Null for users with no event attribution. enum: - blackhat - defcon nullable: true type: string tag: description: >- Effective UI cohort tag. Solo users receive their stored tag. Active team admins and members receive the highest-priority stored tag among accepted/auto-joined team admins; ordinary member tags are ignored while on the team. self_serve is a persistent cohort marker and can represent active, past_due, scheduled-cancel, or canceled customers; billing status and accounting_mode remain authoritative for access. nullable: true type: string target_identity_simulation_enabled: default: true description: >- Whether automatic target identity simulation is enabled for this user. type: boolean team: $ref: '#/components/schemas/UserTeamInfo' description: Team membership information (null if user is not in a team) nullable: true required: - email - role - features - target_identity_simulation_enabled - model_use_mode - model_use_scope type: object ErrorResponse: properties: code: description: > Stable machine-readable error code — branch on this rather than matching the human `error`/`message` strings. `access_restricted` (HTTP 403) denies hosted Neo access under the access policy. On team invitations, param=email identifies a restricted recipient rather than the caller; show the error without redirecting the caller. Domain codes include `user_spending_cap_reached`, `project_spending_cap_reached`, and `insufficient_neo_credits`; Free/usage codes include `free_grant_challenge_required`, `free_usage_exhausted`, `free_task_budget_exhausted`, `model_not_available_on_free`, `sandbox_not_available_on_free` (cloud sandbox surfaces are not available on the Free plan; task files remain available from the task), `free_cannot_continue_managed_task` (a task that ran on the standard cloud sandbox cannot be continued on the Free plan; start a new task), `free_origin_not_supported` (integration-originated tasks are not available on the Free plan), `weekly_usage_limit_reached`, `billing_period_usage_limit_reached`, `topup_required`, `subscription_required`, and `isolated_workspace_purged`. Otherwise it mirrors the error kind (e.g. `forbidden`, `invalid_request`, `not_exists`, `already_exists`). example: user_spending_cap_reached type: string error: example: Bad request type: string error_id: description: Correlation id for a specific error instance, when present. type: string kind: description: Coarse error category (e.g. "forbidden request", "invalid request"). example: forbidden request type: string message: description: | Human-readable detail (the kind prefixed to the error). For display, not for branching. type: string param: description: >- Field rejected by the policy; email for a restricted invite recipient. type: string turnstile_site_key: description: | Public Cloudflare Turnstile site key returned only with `free_grant_challenge_required`, so the client can complete the invisible verification before retrying the request. type: string required: - error type: object AIConnectionModel: properties: context_window: description: Maximum input context reported by the connected provider. type: integer default_reasoning_effort: enum: - none - minimal - low - medium - high - xhigh - max type: string x-enum-varnames: - AIConnectionModelDefaultReasoningEffortNone - AIConnectionModelDefaultReasoningEffortMinimal - AIConnectionModelDefaultReasoningEffortLow - AIConnectionModelDefaultReasoningEffortMedium - AIConnectionModelDefaultReasoningEffortHigh - AIConnectionModelDefaultReasoningEffortXhigh - AIConnectionModelDefaultReasoningEffortMax default_speed: enum: - standard - fast type: string x-enum-varnames: - AIConnectionModelDefaultSpeedStandard - AIConnectionModelDefaultSpeedFast display_name: description: >- Provider-supplied display name, falling back to the model identifier. type: string id: description: Model identifier exposed by a AI connection. type: string max_output_tokens: description: Maximum output tokens reported by the connected provider. type: integer neo_model_id: type: string provider: description: Provider that owns the model. type: string provider_model_id: type: string reason: type: string reasoning_efforts: items: enum: - none - minimal - low - medium - high - xhigh - max type: string x-enum-varnames: - AIConnectionModelReasoningEffortsNone - AIConnectionModelReasoningEffortsMinimal - AIConnectionModelReasoningEffortsLow - AIConnectionModelReasoningEffortsMedium - AIConnectionModelReasoningEffortsHigh - AIConnectionModelReasoningEffortsXhigh - AIConnectionModelReasoningEffortsMax type: array supported: description: Whether Neo can execute this model through the AI connection. type: boolean supported_input_modalities: items: type: string type: array supported_output_modalities: items: type: string type: array supports_speed: description: Whether the model accepts an explicit speed selection. type: boolean required: - id - provider - display_name - supported - reasoning_efforts - supports_speed type: object ByokDiscoveredModel: properties: context_window: description: Maximum input context reported by the BYOK provider. type: integer default_reasoning_effort: description: Provider default reasoning effort for this model. enum: - none - minimal - low - medium - high - xhigh - max type: string x-enum-varnames: - ByokDiscoveredModelDefaultReasoningEffortNone - ByokDiscoveredModelDefaultReasoningEffortMinimal - ByokDiscoveredModelDefaultReasoningEffortLow - ByokDiscoveredModelDefaultReasoningEffortMedium - ByokDiscoveredModelDefaultReasoningEffortHigh - ByokDiscoveredModelDefaultReasoningEffortXhigh - ByokDiscoveredModelDefaultReasoningEffortMax default_speed: description: Provider default speed tier for this model. enum: - standard - fast type: string x-enum-varnames: - ByokDiscoveredModelDefaultSpeedStandard - ByokDiscoveredModelDefaultSpeedFast id: description: Provider-side model or deployment identifier shown to the user. type: string max_output_tokens: description: Maximum output tokens reported by the BYOK provider. type: integer neo_model_id: description: Canonical Neo model label when supported. nullable: true type: string provider: description: BYOK provider id that exposed this model. type: string provider_model_id: description: Underlying provider/base model identifier when available. nullable: true type: string reason: description: >- Reason the row is not selectable, such as unsupported_by_neo or provider_discovery_failed. nullable: true type: string reasoning_efforts: description: >- Exact reasoning effort overrides reported as accepted by this BYOK model. An empty array means none are accepted; omission means the provider did not report capabilities. items: enum: - none - minimal - low - medium - high - xhigh - max type: string x-enum-varnames: - ByokDiscoveredModelReasoningEffortsNone - ByokDiscoveredModelReasoningEffortsMinimal - ByokDiscoveredModelReasoningEffortsLow - ByokDiscoveredModelReasoningEffortsMedium - ByokDiscoveredModelReasoningEffortsHigh - ByokDiscoveredModelReasoningEffortsXhigh - ByokDiscoveredModelReasoningEffortsMax type: array supported: description: >- Whether Neo supports executing this provider model through a canonical Neo model label. type: boolean supported_reasoning_efforts: deprecated: true description: Deprecated alias for reasoning_efforts. items: enum: - none - minimal - low - medium - high - xhigh - max type: string type: array supported_speeds: deprecated: true description: >- Deprecated provider-reported speed values retained for backward compatibility. Use supports_speed. items: enum: - standard - fast type: string type: array supports_speed: description: >- Whether provider discovery reports that this BYOK model accepts an explicit standard or fast speed selection. Omitted when unknown. type: boolean required: - id - provider - supported type: object SpendingCapStatus: properties: limit: description: Effective cap in credits. null when source is "none". format: float nullable: true type: number remaining: description: limit − used, clamped ≥ 0. null when source is "none". format: float nullable: true type: number source: description: >- What the effective limit comes from — an explicit per-member override, the team-wide default, or none (bounded only by the team pool / not on a spend-controls plan). enum: - override - global_default - none type: string used: description: Credits spent in the current cap window. format: float type: number required: - source type: object EgressIPInfo: properties: browser: $ref: '#/components/schemas/EgressIPSurfaceInfo' nullable: true platform: description: >- Neo's own outbound addresses, each a bare IP or a CIDR, which customers must allowlist for SSH. Shared by all customers rather than per-account. More than one is normal and every one has to be allowed — any of them may be the source of a given connection. Omitted when the deployment has published none (on-prem). items: type: string type: array sandbox: $ref: '#/components/schemas/EgressIPSurfaceInfo' nullable: true scope: description: Scope that provides the static egress IP, when known. enum: - user - team nullable: true type: string type: object ModelUseScope: properties: resource_id: description: Public scope identifier. Personal scope is represented as `self`. type: string resource_type: enum: - user - team type: string x-enum-varnames: - ModelUseScopeResourceTypeUser - ModelUseScopeResourceTypeTeam required: - resource_type - resource_id type: object UserOnboardingStatus: properties: subscription: description: True if the user (or their team) has an active subscription type: boolean team: description: True if the user belongs to a team type: boolean required: - subscription - team type: object UserTeamInfo: properties: auto_joined: description: >- Only present and true when user just auto-joined in this request (for first-time onboarding UI) type: boolean branding: allOf: - $ref: '#/components/schemas/TeamBranding' description: >- Brand overrides applied to Canvas PDF exports for this user's team. Inlined on the user profile so the UI can render branded PDFs without a second round-trip. Null when the team hasn't configured branding. nullable: true can_view_audit_logs: description: >- True when the caller can read the team audit log. Requires accepted admin membership and a team plan that includes audit logs. Clients should hide audit log views when this is false or absent. type: boolean id: description: Team ID type: string name: description: Team name type: string role: $ref: '#/components/schemas/TeamMemberRole' description: User's role in the team required: - id - name - role type: object EgressIPSurfaceInfo: properties: ip_address: description: Static outbound IP address when mode is static. nullable: true type: string mode: description: Whether the surface currently uses dynamic or static outbound IP. enum: - dynamic - static type: string required: - mode type: object TeamBranding: description: >- Per-team branding overrides for Canvas PDF exports. Mirrors the renderer's `BrandInfo` shape (neo-ui canvas-export-pdf.tsx). Every field is optional; the renderer falls back to the default Neo wordmark for fields that are unset. properties: logo_url: description: >- HTTPS URL of a custom raster logo. PNG or JPEG only — SVG is not supported by the PDF renderer. The URL is SSRF-validated at write time: `http://`, userinfo, and any hostname that resolves to a private/loopback/link-local/multicast/cloud-metadata IP is rejected. Empty string clears the logo. format: uri maxLength: 2048 nullable: true type: string name: description: >- Display name set in Young Serif (the primary tier of the wordmark). Empty string clears the name and reverts to the default Neo wordmark. Control characters are rejected. maxLength: 64 nullable: true type: string tagline: description: >- Short subtitle next to the name (e.g. "by Acme"). Null leaves the default `by Projectdiscovery` tagline; explicit empty string hides the tagline entirely. Control characters are rejected. maxLength: 96 nullable: true type: string type: object TeamMemberRole: description: >- Role of a team member (admin=full access, member=write access, viewer=read-only) enum: - admin - member - viewer type: string securitySchemes: BearerAuth: bearerFormat: JWT description: JWT authentication token scheme: bearer type: http ApiKeyAuth: description: Neo API key (neo_sk_* prefix) in: header name: X-Api-Key type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.