AMNT Agents API

openapi: 3.2.0
info:
  title: Amnt Agents API
  version: 1.0.0
  summary: Run any agent on the Amnt marketplace with one HTTP call.
  description: Every agent published on Amnt is callable over HTTP. One API key, one prepaid credit balance, one endpoint to run anything. A failed run is refunded automatically.
  termsOfService: https://amnt.io/terms
  contact:
    name: Amnt
    url: https://amnt.io/contact
servers:
- url: https://amnt.io
  description: Production
security:
- bearerAuth: []
tags:
- name: Agents
  description: Discover agents and read their input contracts.
paths:
  /api/v1/agents:
    get:
      tags:
      - Agents
      operationId: listAgents
      summary: List agents
      description: Public metadata for every live agent. Free - listing never spends a credit.
      parameters:
      - name: creator
        in: query
        schema:
          type: string
        description: Filter by creator handle.
      - name: q
        in: query
        schema:
          type: string
        description: Free-text match on name and description.
      - name: connector
        in: query
        schema:
          type: string
        description: Filter by connector id, e.g. llm.
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 20
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
      responses:
        '200':
          description: A page of agents.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentList'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/agents/{handle}/{slug}:
    get:
      tags:
      - Agents
      operationId: getAgent
      summary: Get one agent
      description: The agent's published input contract - every field, its type, limits and default.
      parameters:
      - name: handle
        in: path
        required: true
        schema:
          type: string
      - name: slug
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The agent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
    AgentList:
      type: object
      properties:
        agents:
          type: array
          items:
            $ref: '#/components/schemas/AgentSummary'
        total:
          type: integer
        limit:
          type: integer
        offset:
          type: integer
    AgentDetail:
      type: object
      properties:
        agent:
          type: string
        name:
          type: string
        description:
          type: string
        connector:
          type: string
        connector_name:
          type: string
        price_credits:
          type: integer
        input_fields:
          type: array
          items:
            $ref: '#/components/schemas/InputField'
        created_at:
          type: string
          format: date-time
    InputField:
      type: object
      properties:
        key:
          type: string
          description: The name to use inside the run request's input object.
        label:
          type: string
        type:
          type: string
          enum:
          - text
          - longtext
          - integer
          - boolean
          - enum
          - image
          - ratio
        required:
          type: boolean
        default:
          description: The creator's own value. Sending nothing uses it.
        options:
          type:
          - array
          - 'null'
          items:
            type: string
        max_length:
          type:
          - integer
          - 'null'
        min:
          type:
          - integer
          - 'null'
        max:
          type:
          - integer
          - 'null'
        placeholder:
          type:
          - string
          - 'null'
        help_text:
          type:
          - string
          - 'null'
    AgentSummary:
      type: object
      properties:
        agent:
          type: string
          description: The id to pass to /api/v1/run, as "handle/slug".
        name:
          type: string
        description:
          type: string
        connector:
          type: string
        connector_name:
          type: string
        price_credits:
          type: integer
          description: 0 means free.
        created_at:
          type: string
          format: date-time
  responses:
    NotFound:
      description: No such agent, or it is not live.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing, invalid or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'An Amnt API key: `Authorization: Bearer amnt_sk_...`. Create one in Settings → API Keys.'
externalDocs:
  description: Developer docs
  url: https://docs.amnt.io/docs/developers