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

# Published agent metadata

> agentId is a Project id in the key's workspace. Slugs are not accepted. 404 for an unknown id or an agent outside the workspace.



## OpenAPI

````yaml /openapi.json get /v1/agent/{agentId}
openapi: 3.1.0
info:
  title: Syvon API
  version: 1.0.0
  description: >-
    Two client-facing surfaces: the Portal management plane (syvon.ai/api/*,
    portal JWT) and the Brain read plane (brain.syvon.ai/v1/*, workspace key
    sk_ws_…). Schemas are generated from the @syvon/sdk TypeScript types — the
    shipped .d.ts files are the authoritative contract.
servers:
  - url: https://syvon.ai
    description: Portal (management plane)
  - url: https://brain.syvon.ai
    description: Brain (read plane)
security: []
tags:
  - name: Auth
    description: Minting the portal JWT
  - name: Portal
    description: Management plane — user-scoped (portal JWT)
  - name: Brain
    description: Published-agent read plane — workspace-scoped (sk_ws_…)
paths:
  /v1/agent/{agentId}:
    get:
      tags:
        - Brain
      summary: Published agent metadata
      description: >-
        agentId is a Project id in the key's workspace. Slugs are not accepted.
        404 for an unknown id or an agent outside the workspace.
      operationId: getAgent
      parameters:
        - name: agentId
          in: path
          required: true
          description: Project (agent) id
          schema:
            type: string
      responses:
        '200':
          description: Agent metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentMetadata'
        '404':
          description: Unknown agent
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
      security:
        - workspaceKeyAuth: []
      servers:
        - url: https://brain.syvon.ai
components:
  schemas:
    AgentMetadata:
      type: object
      description: ''
      properties:
        id:
          description: ''
          type: string
        slug:
          description: ''
          type: string
        name:
          description: ''
          type: string
        brand:
          description: ''
          anyOf:
            - anyOf:
                - type: object
                  properties:
                    id:
                      description: ''
                      type: string
                    slug:
                      description: ''
                      type: string
                    name:
                      description: ''
                      type: string
                - type: string
            - type: 'null'
        activeWorkflowId:
          description: ''
          anyOf:
            - type: string
            - type: 'null'
      required:
        - id
        - slug
        - name
        - brand
        - activeWorkflowId
  securitySchemes:
    workspaceKeyAuth:
      type: http
      scheme: bearer
      description: Workspace API key (sk_ws_…)

````