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

# Get a guest-published agent's metadata

> Returns the whitelisted 8-field metadata view for a single guest-published agent. Returns 404 for non-UUID `id` values, unpublished agents, and inactive agents — the backend rejects non-UUID strings before any DB query to prevent SQL cast errors. No authentication is required.



## OpenAPI

````yaml /openapi/openapi.json get /public-agents/{id}/meta
openapi: 3.1.0
info:
  title: IMP REST API
  version: 1.0.0
  description: >-
    REST endpoints of the IMP backend. GraphQL covers entity CRUD; REST covers
    agent runs, media, files, and system utilities. All requests require
    authentication unless the agent is public.
servers:
  - url: '{baseUrl}'
    variables:
      baseUrl:
        default: http://localhost:9001
        description: >-
          Base URL of your IMP backend. Self-hosted deployments typically run on
          port 9001.
security:
  - apiKey: []
  - bearer: []
tags:
  - name: Agents
    description: Endpoints for running, compacting, and querying agent instances.
  - name: Sessions
    description: Endpoints for managing files attached to agent sessions.
  - name: Media
    description: Transcription, speech synthesis, and image generation.
  - name: System
    description: Platform health and configuration utilities.
  - name: Budgets
    description: >-
      LiteLLM tag-budget management for users, roles, teams, projects, agents,
      and routines. Access requires `super_admin` or a role with
      `budget_management` write scope.
  - name: Skills
    description: >-
      Skills are versioned bundles of files (markdown, scripts, assets) mounted
      into the agent sandbox. These endpoints manage the skill registry and
      individual skill files.
  - name: Uploads
    description: >-
      Uppy-compatible S3 companion routes for single-part and multipart file
      uploads. Accept the standard API key. The `internal-key` header (set to
      `INTERNAL_SECRET`) is accepted only on `/s3/delete`, `/s3/download`,
      `/s3/list`, and `/s3/object` — it does **not** work on `/s3/sign` or the
      `/s3/multipart` routes.
  - name: Compliance
    description: >-
      GDPR / DSGVO operator endpoints for data-subject access (export) and
      erasure. Both require `super_admin`.
  - name: Artifacts
    description: >-
      Shareable artifact links — create, list, and revoke share links for files
      stored in S3.
  - name: Credentials
    description: >-
      Tool-credential management — submit, list, and revoke per-user credentials
      for oauth and user_credentials-enabled tools. Values are stored encrypted
      and never returned through these endpoints.
  - name: Public Agents
    description: >-
      Unauthenticated endpoints for guest-published agent discovery. Only
      whitelisted metadata fields are ever returned; no instructions, tools, or
      model details are exposed.
paths:
  /public-agents/{id}/meta:
    get:
      tags:
        - Public Agents
      summary: Get a guest-published agent's metadata
      description: >-
        Returns the whitelisted 8-field metadata view for a single
        guest-published agent. Returns 404 for non-UUID `id` values, unpublished
        agents, and inactive agents — the backend rejects non-UUID strings
        before any DB query to prevent SQL cast errors. No authentication is
        required.
      operationId: getPublicAgentMeta
      parameters:
        - name: id
          in: path
          required: true
          description: Agent UUID. Non-UUID strings return 404 immediately.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Public agent metadata view.
          content:
            application/json:
              schema:
                type: object
                required:
                  - id
                  - name
                  - description
                  - welcomemessage
                  - slug
                  - guest_auth_mode
                  - guest_has_cover
                properties:
                  id:
                    type: string
                    format: uuid
                  name:
                    type: string
                  description:
                    type: string
                  image:
                    type:
                      - string
                      - 'null'
                  welcomemessage:
                    type: string
                  slug:
                    type: string
                  guest_auth_mode:
                    type: string
                    enum:
                      - public
                      - password
                      - regular
                  guest_has_cover:
                    type: boolean
        '404':
          description: >-
            Agent not found, not guest-published, inactive, or `id` is not a
            valid UUID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security: []
components:
  schemas:
    Error:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message.
        message:
          type: string
          description: Human-readable error message (alternate key used on some endpoints).
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Organisation API key. Format: `sk_<secret>/<keyname>` — the secret
        portion, a literal slash, and the human-readable key name. The header
        `exulu-api-key` is accepted as an alias. A `Bearer ` prefix is tolerated
        and stripped. Keys with an agent scope are only valid for the scoped
        agent instance.
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        NextAuth session JWT (HS256, signed with `NEXTAUTH_SECRET`). This is the
        token the IMP frontend uses automatically.

````