---
updatedAt: 2025-11-27T11:45:22.000Z
agentTools:
  projectIndex: https://developers.happeo.com/llms.txt
---

# Get an agent by ID

Retrieves a specific agent by its unique identifier

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Agent API",
    "version": "1.0",
    "description": "Agent management endpoints for creating and managing AI agents."
  },
  "tags": [
    {
      "name": "Agents",
      "description": "Agent management endpoints for creating and managing AI agents"
    }
  ],
  "servers": [
    {
      "url": "https://api.happeo.com/",
      "description": "Production"
    },
    {
      "url": "http://api.unvrs.io/",
      "description": "Staging"
    }
  ],
  "components": {
    "schemas": {
      "Agent": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the agent"
          },
          "name": {
            "type": "string",
            "description": "Display name of the agent"
          },
          "description": {
            "type": "string",
            "description": "Description of the agent usage"
          },
          "icon": {
            "type": "string",
            "description": "Icon for the agent"
          },
          "instructions": {
            "type": "string",
            "description": "Instructions for the agent, injected to the system prompt"
          },
          "createdAt": {
            "type": "integer",
            "description": "Creation timestamp"
          },
          "updatedAt": {
            "type": "integer",
            "description": "Last update timestamp"
          },
          "permissions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AgentPermissionItem"
            },
            "description": "Array of permission items defining who can access this agent"
          },
          "organisationId": {
            "type": "string",
            "description": "Organization identifier"
          },
          "promptNickname": {
            "type": "string",
            "description": "Prompt to use as the basis for the system prompt"
          },
          "context": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Context in which the agent is operating"
          },
          "mcpServer": {
            "$ref": "#/components/schemas/MCPServerConfiguration"
          },
          "tools": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Functions that are executed on the frontend"
          },
          "conversationStarters": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Array of suggested conversation starters to help users begin conversations with the agent"
          }
        }
      },
      "AgentResponse": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Agent"
          },
          {
            "type": "object",
            "properties": {
              "_links": {
                "type": "object",
                "properties": {
                  "self": {
                    "type": "string"
                  },
                  "urn:happeo:rel:delete": {
                    "type": "string"
                  },
                  "urn:happeo:rel:edit": {
                    "type": "string"
                  }
                }
              },
              "permission": {
                "type": "string",
                "enum": [
                  "read",
                  "write"
                ],
                "description": "User's permission level for this agent"
              }
            }
          }
        ]
      },
      "AgentPermissionItem": {
        "type": "object",
        "required": [
          "level",
          "type"
        ],
        "properties": {
          "id": {
            "type": "string",
            "nullable": true,
            "description": "User ID, group ID, organisation ID, or null for authenticated users"
          },
          "level": {
            "type": "string",
            "enum": [
              "read",
              "write"
            ],
            "description": "Permission level"
          },
          "type": {
            "type": "string",
            "enum": [
              "user",
              "group",
              "organisation",
              "authenticated"
            ],
            "description": "Type of permission"
          }
        }
      },
      "MCPServerConfiguration": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "requestParams": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "x-universe-auth"
      }
    }
  },
  "paths": {
    "/agents/{agentId}": {
      "get": {
        "summary": "Get an agent by ID",
        "description": "Retrieves a specific agent by its unique identifier",
        "tags": [
          "Agents"
        ],
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "agentId",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "The unique identifier of the agent"
          }
        ],
        "responses": {
          "200": {
            "description": "Agent found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized - invalid or missing authentication"
          },
          "404": {
            "description": "Agent not found"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ]
}
```