> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a publicly shared agent

> Read-only public view of an agent/workflow shared via a 'Share Agent' link. No authentication — the opaque share token in the path is the credential. Returns the agent's name, prompt, triggers, filters and enabled tools, sanitized for public viewing (no tenant identity, usage, cost or integration permission detail). Returns 404 if the link is unknown or has been disabled.



## OpenAPI

````yaml https://api.neoagent.io/public-api/openapi.json get /public-api/shared-agents/{share_token}
openapi: 3.1.0
info:
  description: >-
    Neo's public contract for the dashboard ChatAgent, partner integrations, and
    MSP automation. Every response is wrapped in a `{data, meta}` envelope;
    errors use `{error: {code, message, details?}, meta: {request_id}}`.
    Authenticate with a `Bearer neo_sk_<env>_<secret>` API key (service account)
    or a Microsoft Entra ID JWT (dashboard user). Signed-URL endpoints (end-user
    feedback links) take a `signature` query parameter instead.
  title: Neo Public API
  version: 1.0.0
servers:
  - url: https://api.neoagent.io
security: []
tags:
  - description: Service metadata — health, OpenAPI.
    name: Meta
  - description: Agents and workflows — read, version history, delete, stats.
    name: Agents
  - description: Agent/workflow execution history, sub-resources, retry/cancel.
    name: Executions
  - description: PSA webhook events and their workflow-match results.
    name: Callbacks
  - description: Technician-in-the-loop approval requests.
    name: TIL requests
  - description: RMM script executions triggered by agents.
    name: RMM scripts
  - description: Dispatch-agent field-update decisions.
    name: Dispatch
  - description: The authenticated tenant.
    name: Tenant
  - description: Agent-builder schema catalogs (raw JSON payloads).
    name: Schemas
  - description: Escalate to the Neo team (HubSpot ticket).
    name: Escalation
  - description: Tenant settings.
    name: Settings
  - description: Tenant API-key management (dashboard JWT only).
    name: API keys
  - description: End-user feedback links (signed-URL auth).
    name: Feedback
  - description: End-client companies (CRUD + bulk-update).
    name: End companies
  - description: Channels — bind a CONVERSATIONAL agent to a transport (Teams).
    name: Channels
  - description: PSA/RMM/M365 integration status and connection management.
    name: Integrations
  - description: Technician roster (controls TIL routing and paging).
    name: Technicians
  - description: Future runs queued for TRIGGERED agents.
    name: Scheduled work
  - description: Subscription state and customer-facing credit usage (no provider $).
    name: Billing
  - description: Inbox messages and announcements.
    name: Inbox & Comms
  - description: Tenant-authored agent skills (CRUD) and the built-in skill catalog.
    name: Skills
paths:
  /public-api/shared-agents/{share_token}:
    get:
      tags:
        - Sharing
      summary: Get a publicly shared agent
      description: >-
        Read-only public view of an agent/workflow shared via a 'Share Agent'
        link. No authentication — the opaque share token in the path is the
        credential. Returns the agent's name, prompt, triggers, filters and
        enabled tools, sanitized for public viewing (no tenant identity, usage,
        cost or integration permission detail). Returns 404 if the link is
        unknown or has been disabled.
      operationId: public_api.shared_agents_get_get
      parameters:
        - in: path
          name: share_token
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/SharedAgentSnapshot'
                  meta:
                    $ref: '#/components/schemas/SuccessMeta'
                required:
                  - data
                  - meta
                type: object
          description: Success.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Bad request — malformed input.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Unauthenticated — missing or invalid credentials.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Forbidden — authenticated but not allowed.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Not found.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Conflict — the resource is in a state that blocks this operation.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Request validation failed.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Rate limited — see Retry-After.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Internal server error.
      security: []
components:
  schemas:
    SharedAgentSnapshot:
      description: >-
        Self-contained bundle the public page renders from — no separate schema
        endpoints, no

        stored state, built fresh at view time. `view` drives the header + the
        Overview/Triggers

        panels; `agent` + the (generic) schema catalogs + the connected map feed
        the REAL builder

        components (Custom Instructions + AvailableToolsPanel) on the Tools &
        Settings tab.
      properties:
        action_schemas:
          items:
            additionalProperties: true
            type: object
          title: Action Schemas
          type: array
        agent:
          additionalProperties: true
          title: Agent
          type: object
        callback_change_options:
          items:
            type: string
          title: Callback Change Options
          type: array
        integration_schemas:
          additionalProperties: true
          title: Integration Schemas
          type: object
        integration_statuses:
          additionalProperties: true
          title: Integration Statuses
          type: object
        ticket_schema:
          additionalProperties: true
          title: Ticket Schema
          type: object
        time_entry_schema:
          additionalProperties: true
          title: Time Entry Schema
          type: object
        tool_schemas:
          items:
            additionalProperties: true
            type: object
          title: Tool Schemas
          type: array
        view:
          $ref: '#/components/schemas/SharedAgentView'
      required:
        - view
        - agent
        - tool_schemas
        - integration_schemas
        - integration_statuses
        - ticket_schema
        - time_entry_schema
        - action_schemas
        - callback_change_options
      title: SharedAgentSnapshot
      type: object
    SuccessMeta:
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        request_id:
          format: uuid
          type: string
        timings_ms:
          additionalProperties:
            type: number
          type: object
        warnings:
          description: >-
            Non-fatal warnings about the created/updated resource (e.g. an
            unhealthy PSA callback).
          items:
            type: string
          type: array
      required:
        - request_id
        - timings_ms
      type: object
    ErrorEnvelope:
      properties:
        error:
          properties:
            code:
              description: Stable machine-readable error code.
              type: string
            details:
              additionalProperties: true
              type: object
            message:
              type: string
          required:
            - code
            - message
          type: object
        meta:
          properties:
            request_id:
              format: uuid
              type:
                - string
                - 'null'
          type: object
      required:
        - error
        - meta
      type: object
    SharedAgentView:
      description: >-
        The complete public projection of a shared agent/workflow — everything
        the no-login

        read-only viewer is allowed to see. Built only by
        `build_shared_agent_view`.
      properties:
        attribution:
          anyOf:
            - $ref: '#/components/schemas/SharedAttribution'
            - type: 'null'
        autonomy_type:
          $ref: '#/components/schemas/AutonomyType'
        capabilities:
          $ref: '#/components/schemas/SharedAgentCapabilities'
        created_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Created At
        entity_type:
          $ref: '#/components/schemas/EntityType'
        filter_values_masked:
          title: Filter Values Masked
          type: boolean
        filters:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Filters
        integrations:
          items:
            $ref: '#/components/schemas/SharedIntegrationDisplay'
          title: Integrations
          type: array
        name:
          title: Name
          type: string
        pipeline:
          items:
            $ref: '#/components/schemas/SharedPipelineStep'
          title: Pipeline
          type: array
        prompt:
          anyOf:
            - type: string
            - type: 'null'
          title: Prompt
        schedule:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Schedule
        tools:
          items:
            $ref: '#/components/schemas/SharedToolDisplay'
          title: Tools
          type: array
        trigger_type:
          $ref: '#/components/schemas/WorkflowTriggerType'
        triggers:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Triggers
      required:
        - name
        - autonomy_type
        - entity_type
        - trigger_type
        - prompt
        - schedule
        - triggers
        - filters
        - pipeline
        - tools
        - integrations
        - capabilities
        - attribution
        - filter_values_masked
        - created_at
      title: SharedAgentView
      type: object
    Pagination:
      properties:
        has_more:
          type: boolean
        next_cursor:
          type:
            - string
            - 'null'
      required:
        - next_cursor
        - has_more
      type: object
    SharedAttribution:
      properties:
        label:
          anyOf:
            - type: string
            - type: 'null'
          title: Label
        logo_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Logo Url
      required:
        - label
        - logo_url
      title: SharedAttribution
      type: object
    AutonomyType:
      enum:
        - CHAINED_ACTIONS
        - AGENTIC
        - CONVERSATIONAL
      title: AutonomyType
      type: string
    SharedAgentCapabilities:
      properties:
        sandbox_enabled:
          title: Sandbox Enabled
          type: boolean
        subagents_enabled:
          title: Subagents Enabled
          type: boolean
      required:
        - sandbox_enabled
        - subagents_enabled
      title: SharedAgentCapabilities
      type: object
    EntityType:
      enum:
        - ticket
        - project_ticket
        - task
        - scheduled_entry
        - time_entry
        - project
        - company
        - contact
        - resource
        - contract
        - opportunity
        - none
        - configuration
        - note
        - team
        - role
        - audit_trail
        - appointment
        - servicecall
        - contract_service
        - company_location
        - product
      title: EntityType
      type: string
    SharedIntegrationDisplay:
      description: >-
        A connected integration with its read-only permission matrix — the same
        shape the real

        builder's Tools & Settings tab renders. Only enabled (non-DISABLED)
        groups are included.
      properties:
        groups:
          items:
            $ref: '#/components/schemas/SharedPermissionGroup'
          title: Groups
          type: array
        key:
          title: Key
          type: string
        name:
          title: Name
          type: string
      required:
        - key
        - name
        - groups
      title: SharedIntegrationDisplay
      type: object
    SharedPipelineStep:
      description: >-
        One step in a CHAINED_ACTIONS workflow's action pipeline
        (post-FIND_ENTITIES). `settings` is

        the action's config (notification message, fields updated, PSA options)
        — None unless the owner

        opted into `reveal_tool_details`, mirroring
        `SharedToolDisplay.settings`.
      properties:
        action_type:
          title: Action Type
          type: string
        label:
          title: Label
          type: string
        settings:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Settings
      required:
        - action_type
        - label
        - settings
      title: SharedPipelineStep
      type: object
    SharedToolDisplay:
      description: >-
        One enabled tool. `settings` is None unless the owner opted into
        `reveal_tool_details`

        — per-tool config can carry staff emails / technician names / PSA option
        ids.
      properties:
        group:
          title: Group
          type: string
        settings:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Settings
        title:
          title: Title
          type: string
        type:
          title: Type
          type: string
      required:
        - type
        - title
        - group
        - settings
      title: SharedToolDisplay
      type: object
    WorkflowTriggerType:
      enum:
        - SCHEDULED
        - TRIGGERED
        - NONE
      title: WorkflowTriggerType
      type: string
    SharedPermissionGroup:
      description: One row of an integration's read-only permission matrix.
      properties:
        access:
          title: Access
          type: string
        name:
          title: Name
          type: string
        requires_approval:
          title: Requires Approval
          type: boolean
      required:
        - name
        - access
        - requires_approval
      title: SharedPermissionGroup
      type: object

````