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

# Read Agent Card

> The card published at an A2A agent's address.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/workspaces/{workspace}/a2a/agent-cards
openapi: 3.1.0
info:
  description: >-
    Modular and extensible framework for building AI agents. This API requires
    JWT Bearer token authentication for most endpoints. Include your JWT token
    in the Authorization header. Public endpoints include /, /health, /docs,
    /redoc, and /openapi.json.
  title: AgentArea API
  version: 0.1.0
servers: []
security:
  - bearer: []
paths:
  /v1/workspaces/{workspace}/a2a/agent-cards:
    post:
      tags:
        - v1
        - protected
        - a2a
      summary: Read Agent Card
      description: The card published at an A2A agent's address.
      operationId: read_agent_card_v1_a2a_agent_cards_post
      parameters:
        - description: Slug of the workspace the request acts in
          in: path
          name: workspace
          required: true
          schema:
            description: Slug of the workspace the request acts in
            maxLength: 120
            pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
            title: Workspace
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentCardLookup'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentCardSummary'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - HTTPBearer: []
components:
  schemas:
    AgentCardLookup:
      properties:
        url:
          description: The agent's address, or the URL of its agent card
          title: Url
          type: string
      required:
        - url
      title: AgentCardLookup
      type: object
    AgentCardSummary:
      properties:
        address:
          description: The agent's address, the form a delegate stores
          title: Address
          type: string
        description:
          title: Description
          type: string
        name:
          title: Name
          type: string
        skills:
          items:
            $ref: '#/components/schemas/AgentCardSkill'
          title: Skills
          type: array
      required:
        - address
        - name
        - description
        - skills
      title: AgentCardSummary
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    AgentCardSkill:
      properties:
        description:
          title: Description
          type: string
        name:
          title: Name
          type: string
      required:
        - name
        - description
      title: AgentCardSkill
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    bearer:
      bearerFormat: JWT
      description: JWT Bearer token for authentication
      scheme: bearer
      type: http
    HTTPBearer:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.