Aginera

Aginera Clients API

Account — the calling credential and capabilities.

GitHub OpenAPI

Operations 3

GET /clients/me Information about the calling credential #
GET /capabilities What this account can do right now #
POST /access-requests Request access to premium APIs #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/aginera-ai/openapi/aginera-ai-clients-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/aginera-ai/json-schema/aginera-ai-cad-file-result-schema.json
📊
JSONSchema
https://artifacts.apis.io/aginera-ai/json-schema/aginera-ai-cad-status-schema.json
📊
JSONSchema
https://artifacts.apis.io/aginera-ai/json-schema/aginera-ai-takeoff-schema.json
📊
JSONSchema
https://artifacts.apis.io/aginera-ai/json-schema/aginera-ai-takeoff-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/aginera-ai/json-schema/aginera-ai-capabilities-schema.json
📊
JSONSchema
https://artifacts.apis.io/aginera-ai/json-schema/aginera-ai-document-create-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/aginera-ai:aginera-ai-clients-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

aginera-ai-clients-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Aginera Ai Clients API
  version: 1.0.0-rc.1
  contact:
    name: Aginera Developer Support
    email: developers@aginera.ai
    url: https://aginera.ai/docs/developer
  license:
    name: Proprietary — Aginera Developer Platform Terms
    url: https://aginera.ai/legal/developer-terms
  termsOfService: https://aginera.ai/legal/developer-terms
  description: 'Operations tagged Clients across 3 of this provider''s published API definitions: aginera-ai-openapi.json, aginera-openapi.json, aginera-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.aginera.ai/partner/v1
  description: Production and sandbox (environment is per credential)
security:
- oauth2: []
tags:
- name: Clients
  description: Account — the calling credential and capabilities.
paths:
  /clients/me:
    get:
      operationId: clients.me
      summary: Information about the calling credential
      tags:
      - Clients
      security:
      - oauth2: []
      x-aginera-cut: core
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientInfo'
        default:
          description: Error (RFC 7807)
          content:
            application/problem+json:
              schema:
                type: object
                properties: {}
                $ref: '#/components/schemas/Problem'
    servers:
    - url: https://api.aginera.ai/partner/v1
      description: Production and sandbox (environment is per credential)
  /capabilities:
    get:
      operationId: capabilities.get
      summary: What this account can do right now
      tags:
      - Clients
      security:
      - oauth2: []
      x-aginera-cut: core
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Capabilities'
        default:
          description: Error (RFC 7807)
          content:
            application/problem+json:
              schema:
                type: object
                properties: {}
                $ref: '#/components/schemas/Problem'
    servers:
    - url: https://api.aginera.ai/partner/v1
      description: Production and sandbox (environment is per credential)
  /access-requests:
    post:
      operationId: accessRequests.create
      summary: Request access to premium APIs
      description: Ask for premium capabilities (deep takeoffs, interior reveal, BIM, clash). Records the request and notifies support@aginera.ai; an operator grants the scopes after confirming an active monthly subscription.
      tags:
      - Clients
      security:
      - oauth2: []
      x-aginera-cut: core
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                capabilities:
                  type: array
                  items:
                    type: string
                  minItems: 1
                  description: Premium scopes to request, e.g. ["bim:generate","clash:run"]
                note:
                  type: string
                  maxLength: 2000
              required:
              - capabilities
      responses:
        '202':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  request_id:
                    type: string
                  capabilities:
                    type: array
                    items:
                      type: string
                  contact:
                    type: string
                  created_at:
                    type: string
                required:
                - status
                - capabilities
                - contact
        default:
          description: Error (RFC 7807)
          content:
            application/problem+json:
              schema:
                type: object
                properties: {}
                $ref: '#/components/schemas/Problem'
    servers:
    - url: https://api.aginera.ai/partner/v1
      description: Production and sandbox (environment is per credential)
components:
  schemas:
    Capabilities:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        capabilities:
          type: array
          items:
            type: object
            properties:
              capability:
                type: string
              description:
                type: string
              tools:
                type: array
                items:
                  type: string
              status:
                type: string
                enum:
                - available
                - coming_soon
                - not_enabled
              pricing:
                type: string
                description: How this capability is priced for the account, when it has its own price.
            required:
            - capability
            - description
            - tools
            - status
        example_requests:
          type: array
          items:
            type: string
        environment:
          $ref: '#/components/schemas/Environment'
        billing_mode:
          type: string
          enum:
          - ledger
          - artifact
        products:
          type: object
          additionalProperties:
            type: boolean
        disciplines:
          type: array
          items:
            $ref: '#/components/schemas/Discipline'
        export_formats:
          type: array
          items:
            $ref: '#/components/schemas/ExportFormat'
        limits:
          type: object
          additionalProperties:
            type: number
        credits_available:
          type:
          - number
          - 'null'
        unit_system:
          type: string
          enum:
          - imperial
          - metric
        api_version:
          type: string
        taxonomy_version:
          type: string
      required:
      - name
      - description
      - capabilities
      - example_requests
      - environment
      - billing_mode
      - products
      - disciplines
      - export_formats
      - limits
      - credits_available
      - unit_system
      - api_version
      - taxonomy_version
    ClientId:
      type:
      - string
      - 'null'
      pattern: ^(pc|oc)_[0-9A-Za-z]{22}$
    Environment:
      type: string
      enum:
      - sandbox
      - production
    ExportFormat:
      type: string
      enum:
      - csv
      - xlsx
      - json
      - accubid
      - mccormick
      - intellibid
      - bluebeam_ost
      - procore
    Problem:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        code:
          type: string
        detail:
          type: string
        request_id:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
            required:
            - field
            - message
        required_credits:
          type: number
        available_credits:
          type: number
        quota:
          type: string
        retry_after:
          type: integer
        next_step:
          type: string
      required:
      - type
      - title
      - status
      - code
      - detail
      - request_id
    ClientInfo:
      type: object
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/ClientId'
          - type: string
        name:
          type: string
        environment:
          $ref: '#/components/schemas/Environment'
        mode:
          type: string
          enum:
          - service
          - delegated
        agent:
          type:
          - string
          - 'null'
        billing_mode:
          type: string
          enum:
          - ledger
          - artifact
        tier:
          type: string
          enum:
          - sandbox
          - standard
          - enterprise
        scopes:
          type: array
          items:
            type: string
        products:
          type: object
          additionalProperties:
            type: boolean
        rate_limits:
          type: object
          additionalProperties:
            type: object
            properties:
              per_minute:
                type: integer
              burst:
                type: integer
            required:
            - per_minute
            - burst
        quotas:
          type: object
          additionalProperties:
            type: number
        secret_expires_at:
          type:
          - string
          - 'null'
          format: date-time
      required:
      - id
      - name
      - environment
      - mode
      - agent
      - billing_mode
      - tier
      - scopes
      - products
      - rate_limits
      - quotas
      - secret_expires_at
    Discipline:
      type: string
      enum:
      - electrical
      - mechanical
      - plumbing
      - fire_protection
      - process
      - structural
      - multi_discipline
  securitySchemes:
    oauth2:
      type: oauth2
      description: Client credentials (service mode, Microsoft Entra ID tenant of Aginera; request scope=api://<aginera-api-app-id>/.default; granular scopes are attached to the credential) or authorization code + PKCE (delegated mode via the Aginera authorization server; scopes are consented by the user).
      flows:
        clientCredentials:
          tokenUrl: https://login.microsoftonline.com/65f567a9-6e6a-4f81-863c-aea4ece1f8eb/oauth2/v2.0/token
          scopes:
            projects:read: View projects
            projects:write: Create and update projects
            projects:delete: Delete projects
            documents:read: View and download documents
            documents:write: Upload drawings
            documents:delete: Delete documents
            takeoffs:read: View takeoffs, items, routes and schedules
            takeoffs:run: Run takeoffs (uses credits)
            takeoffs:review: Accept, reject or adjust takeoff items
            takeoffs:delete: Delete takeoffs
            estimates:read: View estimates
            estimates:generate: Generate estimates (uses credits)
            exports:read: Download exports
            exports:create: Create exports
            billing:read: View credits and usage
            billing:write: Purchase credits
            events:read: Read the event log
            webhooks:manage: Manage webhook endpoints
            takeoffs:deep: Run deep (UI-parity) takeoffs
            interior:read: View floor-plan renders (dollhouse, room images, film)
            interior:generate: Render floor plans and start purchases on your account (uses credits; paid add-ons need your checkout)
            cad:convert: Convert PDF drawings to CAD (free to view; downloading the CAD file is a one-time purchase — paid from your credits only when you say so, otherwise via your own checkout)
            bim:read: View BIM coordination models
            bim:generate: Generate BIM models + embed URLs (uses credits)
            clash:run: Run clash detection + embed URLs (uses credits)
        authorizationCode:
          authorizationUrl: https://auth.aginera.ai/oauth/authorize
          tokenUrl: https://auth.aginera.ai/oauth/token
          refreshUrl: https://auth.aginera.ai/oauth/token
          scopes:
            projects:read: View projects
            projects:write: Create and update projects
            projects:delete: Delete projects
            documents:read: View and download documents
            documents:write: Upload drawings
            documents:delete: Delete documents
            takeoffs:read: View takeoffs, items, routes and schedules
            takeoffs:run: Run takeoffs (uses credits)
            takeoffs:review: Accept, reject or adjust takeoff items
            takeoffs:delete: Delete takeoffs
            estimates:read: View estimates
            estimates:generate: Generate estimates (uses credits)
            exports:read: Download exports
            exports:create: Create exports
            billing:read: View credits and usage
            billing:write: Purchase credits
            events:read: Read the event log
            webhooks:manage: Manage webhook endpoints
            takeoffs:deep: Run deep (UI-parity) takeoffs
            interior:read: View floor-plan renders (dollhouse, room images, film)
            interior:generate: Render floor plans and start purchases on your account (uses credits; paid add-ons need your checkout)
            cad:convert: Convert PDF drawings to CAD (free to view; downloading the CAD file is a one-time purchase — paid from your credits only when you say so, otherwise via your own checkout)
            bim:read: View BIM coordination models
            bim:generate: Generate BIM models + embed URLs (uses credits)
            clash:run: Run clash detection + embed URLs (uses credits)
x-refined-from:
- aginera-ai-openapi.json
- aginera-openapi.json
- aginera-openapi.yaml