> ## 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.

# List custom endpoints

> List the custom OpenAI-compatible endpoints of the current user or team,
oldest first. The API key is never returned.

Same access control as `/api/v1/byok/providers`: solo users and team
admins only; team members and viewers get 403. Requires the `byok`
feature. Refused with 403 `custom_endpoints_disabled` while custom
endpoints are turned off.




## OpenAPI

````yaml /openapi/neo.public.openapi.json get /api/v1/byok/custom-endpoints
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/byok/custom-endpoints:
    get:
      tags:
        - BYOK
      summary: List custom endpoints
      description: |
        List the custom OpenAI-compatible endpoints of the current user or team,
        oldest first. The API key is never returned.

        Same access control as `/api/v1/byok/providers`: solo users and team
        admins only; team members and viewers get 403. Requires the `byok`
        feature. Refused with 403 `custom_endpoints_disabled` while custom
        endpoints are turned off.
      operationId: get-v1-byok-custom-endpoints
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomEndpointsResponse'
          description: The account's custom endpoints
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Forbidden - BYOK not enabled, not a team admin, or
            `custom_endpoints_disabled`
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal server error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            `custom_endpoints_unavailable`: custom endpoints are not available
            yet (the database migration has not run)
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  schemas:
    CustomEndpointsResponse:
      properties:
        endpoints:
          items:
            $ref: '#/components/schemas/CustomEndpoint'
          type: array
        resource_id:
          description: The user or team ID
          type: string
        resource_type:
          description: Whether the endpoints belong to a user or team
          enum:
            - user
            - team
          type: string
      required:
        - endpoints
        - resource_type
        - resource_id
      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
    CustomEndpoint:
      description: A custom OpenAI-compatible endpoint. The API key is never returned.
      properties:
        base_url:
          description: >-
            Normalised https base URL, as the provider documents it (usually
            ending in /v1)
          type: string
        created_at:
          format: date-time
          type: string
        display_name:
          description: The user's name for the endpoint, unique per account ignoring case
          type: string
        id:
          format: uuid
          type: string
        is_validated:
          description: Whether the key was accepted by the endpoint
          type: boolean
        last_discovery_error:
          description: >-
            Stable code of the last model-list failure (for example
            `endpoint_not_found`); null after a successful listing
          nullable: true
          type: string
        manual_models:
          description: Model IDs typed by the user
          items:
            type: string
          type: array
        updated_at:
          format: date-time
          type: string
      required:
        - id
        - display_name
        - base_url
        - manual_models
        - is_validated
        - last_discovery_error
        - created_at
        - updated_at
      type: object
  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.