agentry-com Identity API

openapi: 3.2.0
info:
  title: Agentry Identity API
  description: AI Agent Registry and Discovery service — browse, search, and register AI agents. Machine-readable via /llms.txt, /.well-known/agents.json, and /api/agents/public (A2A).
  version: 0.4.0
tags:
- name: Identity
paths:
  /api/identity/register:
    post:
      tags:
      - Identity
      summary: Register Nostr Identity
      description: 'Register a Nostr keypair for an agent.


        Binds a secp256k1 public key (npub) to an Agentry agent, creating:

        - A DID (did:agentry:...) for portable identity

        - A NIP-05 identifier (name@agentry.com) for human-readable discovery

        - The foundation for NIP-98 authenticated API requests


        Agents with registered Nostr identities get higher trust/reputation scores.'
      operationId: register_nostr_identity_api_identity_register_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NostrKeyRegistration'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/identity/keys/{agent_id}:
    get:
      tags:
      - Identity
      summary: Get Identity
      description: 'Get the Nostr identity record for an agent.


        Returns the agent''s npub, DID, NIP-05 identifier, fingerprint,

        and verification stats. Private keys are never stored.'
      operationId: get_identity_api_identity_keys__agent_id__get
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/identity/challenge:
    post:
      tags:
      - Identity
      summary: Create Challenge
      description: 'Generate a challenge for an agent to sign with their Nostr key.


        Returns a nonce that the agent signs using their nsec to prove ownership.

        Challenge expires in 5 minutes.'
      operationId: create_challenge_api_identity_challenge_post
      parameters:
      - name: agent_id
        in: query
        required: true
        schema:
          type: string
          title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/identity/verify-challenge:
    post:
      tags:
      - Identity
      summary: Verify Challenge
      description: 'Verify a signed challenge — proves the agent controls their Nostr key.


        Successful verification increments the agent''s verification count,

        contributing to reputation. This is the Agentry equivalent of

        proving you own a Nostr account.'
      operationId: verify_challenge_api_identity_verify_challenge_post
      parameters:
      - name: agent_id
        in: query
        required: true
        schema:
          type: string
          title: Agent Id
      - name: signature_hex
        in: query
        required: true
        schema:
          type: string
          title: Signature Hex
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/identity/verify-nip98:
    post:
      tags:
      - Identity
      summary: Verify Nip98 Auth
      description: 'Verify a NIP-98 HTTP Auth event.


        NIP-98 allows agents to authenticate API requests by signing

        a Nostr event (kind 27235) containing the request URL and method.

        This is the decentralized equivalent of API key authentication.'
      operationId: verify_nip98_auth_api_identity_verify_nip98_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NIP98AuthEvent'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/identity/resolve/{did}:
    get:
      tags:
      - Identity
      summary: Resolve Did
      description: 'Resolve a DID to an agent''s full identity + registry profile.


        Any system can look up an agent by their did:agentry:... identifier

        to get their Nostr pubkey, npub, NIP-05, trust score, and more.

        Enables cross-platform agent discovery.'
      operationId: resolve_did_api_identity_resolve__did__get
      parameters:
      - name: did
        in: path
        required: true
        schema:
          type: string
          title: Did
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/identity/lookup/npub/{npub}:
    get:
      tags:
      - Identity
      summary: Lookup By Npub
      description: 'Look up an agent by their Nostr npub.


        Enables any Nostr client to find an agent''s Agentry profile

        from just their public key.'
      operationId: lookup_by_npub_api_identity_lookup_npub__npub__get
      parameters:
      - name: npub
        in: path
        required: true
        schema:
          type: string
          title: Npub
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    IdentityResponse:
      properties:
        agent_id:
          type: string
          title: Agent Id
        did:
          type: string
          title: Did
        npub:
          type: string
          title: Npub
        pubkey_hex:
          type: string
          title: Pubkey Hex
        nip05:
          type: string
          title: Nip05
        fingerprint:
          type: string
          title: Fingerprint
        registered_at:
          type: string
          title: Registered At
        verification_count:
          type: integer
          title: Verification Count
          default: 0
      type: object
      required:
      - agent_id
      - did
      - npub
      - pubkey_hex
      - nip05
      - fingerprint
      - registered_at
      title: IdentityResponse
    NIP98AuthEvent:
      properties:
        id:
          type: string
          title: Id
        pubkey:
          type: string
          title: Pubkey
        created_at:
          type: integer
          title: Created At
        kind:
          type: integer
          title: Kind
          default: 27235
        tags:
          items:
            items:
              type: string
            type: array
          type: array
          title: Tags
        content:
          type: string
          title: Content
          default: ''
        sig:
          type: string
          title: Sig
      type: object
      required:
      - id
      - pubkey
      - created_at
      - tags
      - sig
      title: NIP98AuthEvent
      description: NIP-98 HTTP Auth event for authenticating API requests.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    NostrKeyRegistration:
      properties:
        agent_id:
          type: string
          title: Agent Id
          description: Agentry agent ID to bind identity to
        pubkey:
          type: string
          title: Pubkey
          description: Nostr public key — npub1... bech32 or 64-char hex
        nip05_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Nip05 Name
          description: Desired NIP-05 name (e.g. 'myagent' → myagent@agentry.com). Auto-generated from agent name if not provided.
        proof_event:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Proof Event
          description: Signed Nostr event (kind 27235 / NIP-98) proving key ownership
      type: object
      required:
      - agent_id
      - pubkey
      title: NostrKeyRegistration
      description: Register a Nostr identity for an agent.