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

> ## Agent Instructions
> These docs cover three products: TrustGate (AI agent gateway), TrustGuard (runtime security), and TrustTest (AI red teaming). Start from each product overview for the definition and How it works. Prefer the .md URL next to a page in /llms.txt when you need the full article. Use /llms-full.txt for a single-file dump of the site.

# Preview an agent card

> Resolves and reads the agent card an a2a_target names, and returns it with its digest and the A2A versions it offers. Writes nothing; credentials in the body are used for this read only.



## OpenAPI

````yaml /trustgate/api/openapi.json post /v1/gateways/{gateway_id}/registries/preview-agent-card
openapi: 3.0.0
info:
  description: >-
    Administrative API for managing gateways and their registries, policies,
    consumers and auth credentials.
  title: TrustGate Admin API
  contact:
    name: NeuralTrust
    url: https://neuraltrust.ai/contact
    email: support@neuraltrust.ai
  version: '1.0'
servers:
  - url: /
security: []
paths:
  /v1/gateways/{gateway_id}/registries/preview-agent-card:
    post:
      tags:
        - registries
      summary: Preview an agent card
      description: >-
        Resolves and reads the agent card an a2a_target names, and returns it
        with its digest and the A2A versions it offers. Writes nothing;
        credentials in the body are used for this read only.
      parameters:
        - description: Gateway id
          name: gateway_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/github_com_NeuralTrust_TrustGate_pkg_api_handler_http_registry_request.PreviewAgentCardRequest
        description: Agent to read
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/github_com_NeuralTrust_TrustGate_pkg_api_handler_http_registry_response.PreviewAgentCardResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/github_com_NeuralTrust_TrustGate_pkg_api_handler_http_httpio.ErrorBody
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/github_com_NeuralTrust_TrustGate_pkg_api_handler_http_httpio.ErrorBody
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/github_com_NeuralTrust_TrustGate_pkg_api_handler_http_httpio.ErrorBody
      security:
        - BearerAuth: []
components:
  schemas:
    github_com_NeuralTrust_TrustGate_pkg_api_handler_http_registry_request.PreviewAgentCardRequest:
      type: object
      properties:
        allowed_methods:
          type: array
          items:
            type: string
        auth:
          $ref: >-
            #/components/schemas/github_com_NeuralTrust_TrustGate_pkg_api_handler_http_registry_request.MCPAuthRequest
        azure_foundry:
          $ref: >-
            #/components/schemas/github_com_NeuralTrust_TrustGate_pkg_domain_registry.FoundryLocator
        bedrock_agentcore:
          $ref: >-
            #/components/schemas/github_com_NeuralTrust_TrustGate_pkg_domain_registry.AgentCoreLocator
        card_auth:
          type: string
          enum:
            - same
            - client_credentials
            - cloud
        card_url:
          type: string
        cloud_auth:
          $ref: >-
            #/components/schemas/github_com_NeuralTrust_TrustGate_pkg_api_handler_http_registry_request.A2ACloudAuthRequest
        headers:
          type: object
          additionalProperties:
            type: string
        protocol_version:
          type: string
          enum:
            - '0.3'
            - '1.0'
        provider:
          type: string
          enum:
            - generic
            - bedrock_agentcore
            - azure_foundry
            - vertex_agent_engine
        url:
          type: string
        vertex_agent_engine:
          $ref: >-
            #/components/schemas/github_com_NeuralTrust_TrustGate_pkg_domain_registry.VertexLocator
    github_com_NeuralTrust_TrustGate_pkg_api_handler_http_registry_response.PreviewAgentCardResponse:
      type: object
      properties:
        card:
          type: object
        card_digest:
          type: string
        default_version:
          type: string
        resolved_card_url:
          type: string
        versions:
          type: array
          items:
            type: string
    github_com_NeuralTrust_TrustGate_pkg_api_handler_http_httpio.ErrorBody:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
    github_com_NeuralTrust_TrustGate_pkg_api_handler_http_registry_request.MCPAuthRequest:
      type: object
      properties:
        account:
          description: >-
            Account is whose account a forwarded credential is: the caller's own

            (empty, or "user") or the one the instance holds for everyone
            ("shared").
          type: string
        actor:
          type: string
        audience:
          type: string
        authorize_url:
          type: string
        client_id:
          type: string
        client_secret:
          description: '#nosec G117'
          type: string
        expected_audience:
          type: string
        header:
          type: string
        identity_id:
          description: |-
            IdentityID is the gateway oauth2 auth that signs an obo or
            token_exchange call.
          type: string
        mode:
          type: string
        pattern:
          type: string
        provider:
          type: string
        registration:
          type: string
        resource:
          type: string
        scope:
          type: string
        scopes:
          type: array
          items:
            type: string
        token_endpoint_auth_method:
          type: string
        token_url:
          type: string
        value:
          description: '#nosec G117'
          type: string
    github_com_NeuralTrust_TrustGate_pkg_domain_registry.FoundryLocator:
      type: object
      properties:
        agent_name:
          type: string
        project_endpoint:
          type: string
    github_com_NeuralTrust_TrustGate_pkg_domain_registry.AgentCoreLocator:
      type: object
      properties:
        qualifier:
          type: string
        runtime_arn:
          type: string
    github_com_NeuralTrust_TrustGate_pkg_api_handler_http_registry_request.A2ACloudAuthRequest:
      type: object
      properties:
        aws:
          $ref: >-
            #/components/schemas/github_com_NeuralTrust_TrustGate_pkg_api_handler_http_registry_request.A2AAWSAuthRequest
        azure:
          $ref: >-
            #/components/schemas/github_com_NeuralTrust_TrustGate_pkg_api_handler_http_registry_request.AzureAuthRequest
        gcp:
          $ref: >-
            #/components/schemas/github_com_NeuralTrust_TrustGate_pkg_api_handler_http_registry_request.A2AGCPAuthRequest
    github_com_NeuralTrust_TrustGate_pkg_domain_registry.VertexLocator:
      type: object
      properties:
        location:
          type: string
        project:
          type: string
        reasoning_engine_id:
          type: string
    github_com_NeuralTrust_TrustGate_pkg_api_handler_http_registry_request.A2AAWSAuthRequest:
      type: object
      properties:
        access_key_id:
          type: string
        external_id:
          type: string
        region:
          type: string
        role:
          type: string
        secret_access_key:
          description: '#nosec G117'
          type: string
        session_token:
          description: '#nosec G117'
          type: string
        use_role:
          type: boolean
    github_com_NeuralTrust_TrustGate_pkg_api_handler_http_registry_request.AzureAuthRequest:
      type: object
      properties:
        api_key:
          description: '#nosec G117'
          type: string
        client_id:
          type: string
        client_secret:
          description: '#nosec G117'
          type: string
        endpoint:
          type: string
        tenant_id:
          type: string
        use_managed_identity:
          type: boolean
        version:
          type: string
    github_com_NeuralTrust_TrustGate_pkg_api_handler_http_registry_request.A2AGCPAuthRequest:
      type: object
      properties:
        impersonate_service_account:
          type: string
        service_account_json:
          type: string
  securitySchemes:
    BearerAuth:
      type: apiKey
      name: Authorization
      in: header

````

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