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-documents-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

openapi: 3.2.0
info:
  title: Aginera Ai Documents 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 Documents 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: Documents
  description: Foundation — drawing ingestion.
paths:
  /documents:
    post:
      operationId: documents.create
      summary: Add a drawing document (from a URL, or prepare a direct upload)
      description: 'source.type = "url": Aginera fetches the file (HTTPS, ≤ 50 MB) and returns 202 with status "ingesting". source.type = "upload": returns 201 with a 15-minute upload URL; PUT the bytes, then call /documents/{id}/complete. Supported: PDF, DWG, DXF, PNG, JPEG.'
      tags:
      - Documents
      security:
      - oauth2:
        - documents:write
      x-aginera-cut: core
      parameters:
      - schema:
          type: string
          description: Replays within 24 hours return the original response.
        required: false
        name: Idempotency-Key
        in: header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentCreate'
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/DocumentWithUpload'
                - $ref: '#/components/schemas/Document'
        '202':
          description: Ingesting from URL
          content:
            application/problem+json:
              schema:
                type: object
                properties: {}
                $ref: '#/components/schemas/Problem'
        default:
          description: Error (RFC 7807)
          content:
            application/problem+json:
              schema:
                type: object
                properties: {}
                $ref: '#/components/schemas/Problem'
    get:
      operationId: documents.list
      summary: List documents
      tags:
      - Documents
      security:
      - oauth2:
        - documents:read
      x-aginera-cut: core
      parameters:
      - schema:
          type: integer
          minimum: 1
          maximum: 200
          default: 50
        required: false
        name: limit
        in: query
      - schema:
          type: string
          maxLength: 512
        required: false
        name: cursor
        in: query
      - schema:
          $ref: '#/components/schemas/ProjectId'
        required: false
        name: project_id
        in: query
      - schema:
          $ref: '#/components/schemas/DocumentStatus'
        required: false
        name: status
        in: query
      - schema:
          type: string
          maxLength: 128
        required: false
        name: external_ref
        in: query
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentList'
        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)
  /documents/{document_id}:
    get:
      operationId: documents.get
      summary: Get a document (with sheets when ready)
      tags:
      - Documents
      security:
      - oauth2:
        - documents:read
      x-aginera-cut: core
      parameters:
      - schema:
          $ref: '#/components/schemas/DocumentId'
        required: true
        name: document_id
        in: path
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        default:
          description: Error (RFC 7807)
          content:
            application/problem+json:
              schema:
                type: object
                properties: {}
                $ref: '#/components/schemas/Problem'
    delete:
      operationId: documents.delete
      summary: Delete a document and its takeoffs
      tags:
      - Documents
      security:
      - oauth2:
        - documents:delete
      x-aginera-cut: core
      parameters:
      - schema:
          $ref: '#/components/schemas/DocumentId'
        required: true
        name: document_id
        in: path
      responses:
        '204':
          description: No content
        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)
  /documents/{document_id}/complete:
    post:
      operationId: documents.complete
      summary: Signal that a direct upload has finished
      tags:
      - Documents
      security:
      - oauth2:
        - documents:write
      x-aginera-cut: core
      parameters:
      - schema:
          $ref: '#/components/schemas/DocumentId'
        required: true
        name: document_id
        in: path
      responses:
        '202':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        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)
  /documents/{document_id}/download:
    get:
      operationId: documents.download
      summary: Download the original file (302 to a 10-minute signed URL)
      tags:
      - Documents
      security:
      - oauth2:
        - documents:read
      x-aginera-cut: core
      parameters:
      - schema:
          $ref: '#/components/schemas/DocumentId'
        required: true
        name: document_id
        in: path
      responses:
        '302':
          description: Redirect
          headers:
            Location:
              schema:
                type: string
              required: true
        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:
    Failure:
      type: object
      properties:
        code:
          type: string
          enum:
          - document_unreadable
          - unsupported_content
          - no_pages_selected
          - capacity
          - cancelled
          - internal
        message:
          type: string
      required:
      - code
      - message
    Metadata:
      type: object
      additionalProperties:
        type: string
        maxLength: 500
    DocumentList:
      type: object
      properties:
        next_cursor:
          type:
          - string
          - 'null'
        has_more:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/Document'
      required:
      - next_cursor
      - has_more
      - data
    ProjectId:
      type: string
      pattern: ^prj_[0-9A-Za-z]{22}$
      example: prj_4kR9sT2vWx7yZa1bCd3eFg
    DocumentCreate:
      type: object
      properties:
        project_id:
          $ref: '#/components/schemas/ProjectId'
        filename:
          type: string
          minLength: 1
          maxLength: 255
        source:
          oneOf:
          - type: object
            properties:
              type:
                type: string
                enum:
                - url
              url:
                type: string
                maxLength: 2048
                format: uri
            required:
            - type
            - url
            additionalProperties: false
          - type: object
            properties:
              type:
                type: string
                enum:
                - upload
              size_bytes:
                type: integer
                exclusiveMinimum: 0
              content_type:
                type: string
                enum:
                - application/pdf
                - image/vnd.dwg
                - application/dxf
                - image/png
                - image/jpeg
            required:
            - type
            additionalProperties: false
        kind:
          type: string
          enum:
          - drawing
          - specification
          - schedule
          default: drawing
        discipline_hint:
          $ref: '#/components/schemas/Discipline'
        external_ref:
          type: string
          minLength: 1
          maxLength: 128
          description: Your own identifier for this resource; unique per tenant.
        metadata:
          $ref: '#/components/schemas/Metadata'
      required:
      - project_id
      - filename
      - source
      additionalProperties: false
    DocumentId:
      type: string
      pattern: ^doc_[0-9A-Za-z]{22}$
      example: doc_4kR9sT2vWx7yZa1bCd3eFg
    DocumentPage:
      type: object
      properties:
        number:
          type: integer
        sheet_number:
          type:
          - string
          - 'null'
        sheet_title:
          type:
          - string
          - 'null'
        has_text:
          type: boolean
        rotation:
          type: integer
        size_pt:
          type: object
          properties:
            width:
              type: number
            height:
              type: number
          required:
          - width
          - height
          additionalProperties: false
        disciplines_detected:
          type: array
          items:
            $ref: '#/components/schemas/Trade'
      required:
      - number
      - sheet_number
      - sheet_title
      - has_text
      - rotation
      - size_pt
    DocumentStatus:
      type: string
      enum:
      - awaiting_upload
      - ingesting
      - ready
      - failed
    Trade:
      type: string
      enum:
      - electrical
      - mechanical
      - plumbing
      - fire_protection
      - structural
      - architectural
      - civil
      - process
      - other
    DocumentWithUpload:
      type: object
      properties:
        document:
          $ref: '#/components/schemas/Document'
        upload:
          type: object
          properties:
            url:
              type: string
              format: uri
            method:
              type: string
              enum:
              - PUT
            headers:
              type: object
              additionalProperties:
                type: string
            expires_at:
              type: string
              format: date-time
          required:
          - url
          - method
          - headers
          - expires_at
      required:
      - document
      - upload
    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
    Discipline:
      type: string
      enum:
      - electrical
      - mechanical
      - plumbing
      - fire_protection
      - process
      - structural
      - multi_discipline
    Document:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/DocumentId'
        project_id:
          $ref: '#/components/schemas/ProjectId'
        filename:
          type: string
        kind:
          type: string
          enum:
          - drawing
          - specification
          - schedule
        status:
          $ref: '#/components/schemas/DocumentStatus'
        external_ref:
          type:
          - string
          - 'null'
        page_count:
          type:
          - integer
          - 'null'
        pages:
          type: array
          items:
            $ref: '#/components/schemas/DocumentPage'
        size_bytes:
          type:
          - integer
          - 'null'
        failure:
          $ref: '#/components/schemas/Failure'
        metadata:
          type: object
          additionalProperties:
            type: string
        created_at:
          type: string
          format: date-time
        ready_at:
          type:
          - string
          - 'null'
          format: date-time
        retain_until:
          type:
          - string
          - 'null'
          format: date-time
      required:
      - id
      - project_id
      - filename
      - kind
      - status
      - external_ref
      - page_count
      - size_bytes
      - metadata
      - created_at
      - ready_at
      - retain_until
  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