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-exports-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 Exports 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 Exports 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: Exports
  description: Takeoff API — export results.
paths:
  /exports:
    post:
      operationId: exports.create
      summary: Export a takeoff (csv, xlsx, json)
      tags:
      - Exports
      security:
      - oauth2:
        - exports:create
      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/ExportCreate'
      responses:
        '202':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Export'
        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)
  /exports/{export_id}:
    get:
      operationId: exports.get
      summary: Get export status and download link
      tags:
      - Exports
      security:
      - oauth2:
        - exports:read
      x-aginera-cut: core
      parameters:
      - schema:
          $ref: '#/components/schemas/ExportId'
        required: true
        name: export_id
        in: path
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Export'
        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
    JobStatus:
      type: string
      enum:
      - queued
      - processing
      - completed
      - failed
      - cancelled
    TakeoffId:
      type: string
      pattern: ^tko_[0-9A-Za-z]{22}$
      example: tko_4kR9sT2vWx7yZa1bCd3eFg
    ExportId:
      type: string
      pattern: ^exp_[0-9A-Za-z]{22}$
      example: exp_4kR9sT2vWx7yZa1bCd3eFg
    UnitSystemPref:
      type: string
      enum:
      - imperial
      - metric
      - as_drawn
      default: as_drawn
    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
    Export:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ExportId'
        takeoff_id:
          $ref: '#/components/schemas/TakeoffId'
        format:
          $ref: '#/components/schemas/ExportFormat'
        status:
          $ref: '#/components/schemas/JobStatus'
        external_ref:
          type:
          - string
          - 'null'
        credits_charged:
          type: number
        download:
          type: object
          properties:
            url:
              type: string
              format: uri
            filename:
              type: string
            expires_at:
              type: string
              format: date-time
          required:
          - url
          - filename
          - expires_at
        failure:
          $ref: '#/components/schemas/Failure'
        created_at:
          type: string
          format: date-time
        completed_at:
          type:
          - string
          - 'null'
          format: date-time
      required:
      - id
      - format
      - status
      - external_ref
      - credits_charged
      - created_at
      - completed_at
    ExportCreate:
      type: object
      properties:
        takeoff_id:
          $ref: '#/components/schemas/TakeoffId'
        estimate_id:
          type: string
        format:
          $ref: '#/components/schemas/ExportFormat'
        external_ref:
          type: string
          minLength: 1
          maxLength: 128
          description: Your own identifier for this resource; unique per tenant.
        options:
          type: object
          properties:
            accepted_only:
              type: boolean
              default: false
            include_evidence:
              type: boolean
              default: false
            units:
              $ref: '#/components/schemas/UnitSystemPref'
          default: {}
          additionalProperties: false
      required:
      - format
      additionalProperties: false
  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