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

# Get Agent by Name

> Retrieve an agent by its unique name.



## OpenAPI

````yaml GET /agent/{name}
openapi: 3.0.1
info:
  title: Machina Sports SDK
  description: >-
    Machina Sports API for seamless AI integration in sports, offering real-time
    insights, personalized content, and fan sentiment analysis.
  version: '1.0'
  termsOfService: http://machina.gg/tos/
  contact:
    email: support@machina.gg
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://{api-address}.org.machina.gg
    description: Production server
    variables:
      api-address:
        default: https://api.machina.gg
        description: Your api-address
  - url: http://local.machina:5001
    description: Local development server
security:
  - ApiToken: []
paths:
  /agent/{name}:
    get:
      tags:
        - agents
      summary: Get Agent by Name
      description: Retrieve an agent by its unique name.
      operationId: getAgentByName
      parameters:
        - name: name
          in: path
          required: true
          description: Unique name of the agent
          schema:
            type: string
      responses:
        '200':
          description: Agent details
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      _id:
                        type: string
                        description: Unique identifier of the agent
                        example: 67e09cb441dc71ef8db3992f
                      name:
                        type: string
                        description: Unique name of the agent
                        example: my-new-agent
                      title:
                        type: string
                        description: Display title of the agent
                        example: My New Agent
                      description:
                        type: string
                        description: Description of the agent's purpose
                        example: Your agent description
                      status:
                        type: string
                        enum:
                          - active
                          - inactive
                        description: Current status of the agent
                        example: inactive
                      context:
                        type: object
                        description: Configuration settings for the agent
                        example:
                          config-frequency: 0.04
                      workflows:
                        type: array
                        description: List of workflows associated with the agent
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                              description: Name of the workflow
                              example: sync-nba-embeds
                            description:
                              type: string
                              description: Description of the workflow
                              example: sync-nba-embeds
                            inputs:
                              type: object
                              description: Input mappings for the workflow
                              example:
                                event_code: $.get('event_code') or None
                            outputs:
                              type: object
                              description: Output mappings for the workflow
                              example:
                                sync-nba-embeds-status: $.get('workflow-status', False)
                      created:
                        type: string
                        description: Creation timestamp
                        example: Sun, 23 Mar 2025 23:43:48 GMT
                      updated:
                        type: string
                        description: Last update timestamp
                        example: Mon, 24 Mar 2025 00:21:10 GMT
                      last_execution:
                        type: string
                        description: Timestamp of the last execution
                        example: Mon, 24 Mar 2025 00:21:10 GMT
                      processing:
                        type: boolean
                        description: Whether the agent is currently processing
                        example: false
                      scheduled:
                        type: boolean
                        description: Whether the agent is scheduled for execution
                        example: false
                  status:
                    type: boolean
                    description: Operation status
                    example: true
        '401':
          description: Unauthorized
        '404':
          description: Agent not found
components:
  securitySchemes:
    ApiToken:
      type: apiKey
      name: x-api-token
      in: header
      description: API key authentication

````