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

# Get evaluation agent

> Read the saved metadata for one evaluation agent, including its target endpoint and payload template.



## OpenAPI

````yaml get /api/agents/{id}
openapi: 3.0.3
info:
  title: Rippletide Agent Evaluation API
  description: >-
    Public API for evaluation agents, test prompts, test results, and knowledge
    imports
  version: 1.0.0
  contact:
    name: Rippletide API Support
servers:
  - url: https://agent-evalserver-production.up.railway.app
    description: Production server
  - url: http://localhost:3001
    description: Development server
security: []
paths:
  /api/agents/{id}:
    get:
      tags:
        - Agents
      summary: Get evaluation agent
      description: >-
        Read the saved metadata for one evaluation agent, including its target
        endpoint and payload template.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Evaluation agent ID returned by Create evaluation agent.
      responses:
        '200':
          description: Evaluation agent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Agent'
              examples:
                agent:
                  summary: Evaluation agent
                  value:
                    id: 2f7e9c9c-9a2e-4e3a-b77f-6d9d1a7e3a11
                    name: Support bot evaluation
                    seed: 123
                    numNodes: 100
                    publicUrl: https://example.com/chat
                    advancedPayload: null
                    label: eval
                    created_at: '2026-06-02T15:00:00Z'
                    updated_at: '2026-06-02T15:00:00Z'
        '404':
          description: Agent not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    Agent:
      type: object
      description: >-
        Evaluation agent registered in Rippletide. This record tells Rippletide
        what external agent endpoint to test and how to store evaluation
        results.
      properties:
        id:
          type: string
          format: uuid
          description: >-
            Unique agent identifier returned by Rippletide. Use this ID in later
            evaluation API calls.
          example: 2f7e9c9c-9a2e-4e3a-b77f-6d9d1a7e3a11
        name:
          type: string
          description: Human-readable name for this evaluation agent.
          example: Support bot evaluation
        seed:
          type: integer
          description: >-
            Deterministic seed used by the evaluation setup. Use any integer;
            the CLI generates one automatically.
          example: 123
        numNodes:
          type: integer
          description: >-
            Evaluation graph size hint. Use 100 unless the Rippletide team
            recommends another value.
          default: 100
          example: 100
        publicUrl:
          type: string
          format: uri
          nullable: true
          description: Public HTTPS endpoint for the agent Rippletide should evaluate.
          example: https://example.com/chat
        advancedPayload:
          type: object
          additionalProperties:
            type: string
          nullable: true
          description: >-
            Optional request payload template used when Rippletide calls the
            agent endpoint. Omit this for standard chat-style APIs.
          example:
            payload: '{"message":"[eval-question]"}'
        label:
          type: string
          enum:
            - eval
          default: eval
          description: Public integrations should use eval.
          example: eval
        created_at:
          type: string
          format: date-time
          description: Creation timestamp.
          example: '2026-06-02T15:00:00Z'
        updated_at:
          type: string
          format: date-time
          description: Last update timestamp.
          example: '2026-06-02T15:05:00Z'
      required:
        - name
        - seed
        - numNodes
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        details:
          type: string
          nullable: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Platform API key for authenticated account-level API access

````