ARCNM Geometry API

openapi: 3.2.0
info:
  title: Arcnm Io Geometry API
  version: 0.1.0
  description: 'Operations tagged geometry across 2 of this provider''s published API definitions: openapi-public.json, arcnm-io-openapi.yml. Each path carries the servers of the definition it was published in.'
security:
- ApiKeyAuth: []
- OAuth2PasswordBearer: []
tags:
- name: geometry
paths:
  /api/v1/geometry/{part_revision_id}/faces-url:
    get:
      tags:
      - geometry
      summary: Part Revision Faces Url
      description: 'Short-lived URL for the revision''s per-face GLB.


        The model is prepared once per CAD upload and served from cache here, so

        this call is cheap and safe to poll. Every B-rep face is its own glTF

        primitive carrying its stable ``face_uuid`` in ``primitive.extras`` — a

        picked primitive maps straight onto the face a cost driver refers to.


        Only STEP carries B-rep faces; a mesh upload answers ``unsupported``.

        See ``FacesUrl`` for the full status set.'
      operationId: geometry-part_revision_faces_url
      security:
      - ApiKeyAuth: []
      - OAuth2PasswordBearer: []
      parameters:
      - name: part_revision_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Part Revision Id
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-Org-Slug
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Org-Slug
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacesUrl'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/geometry/{part_revision_id}/drawing-url:
    get:
      tags:
      - geometry
      summary: Part Revision Drawing Url
      description: 'Short-lived URL for the revision''s active 2D drawing, plus its

        ``content_type`` so the overlay viewer knows whether to render it as an

        image or a PDF. ``{url, status, content_type}``; status ``no_dataset``

        when no drawing is attached.'
      operationId: geometry-part_revision_drawing_url
      security:
      - ApiKeyAuth: []
      - OAuth2PasswordBearer: []
      parameters:
      - name: part_revision_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Part Revision Id
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-Org-Slug
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Org-Slug
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DrawingUrl'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    DrawingUrl:
      properties:
        url:
          anyOf:
          - type: string
          - type: 'null'
          title: Url
        status:
          type: string
          title: Status
        content_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Content Type
      type: object
      required:
      - url
      - status
      - content_type
      title: DrawingUrl
      description: 'A short-lived 2D-drawing URL, its status, and the rendered content type.


        ``url`` / ``content_type`` are null whenever ``status`` is not ``ok``.

        ``status`` is ``ok`` (url present), ``no_dataset`` (no drawing attached),

        or ``failed`` (rendering error). A revision that does not exist in the

        caller''s organization answers 404 instead of ``no_dataset``. PDF drawings are rasterised to a PNG, so

        ``content_type`` is ``image/png`` for them and the source type otherwise.'
    FacesUrl:
      properties:
        url:
          anyOf:
          - type: string
          - type: 'null'
          title: Url
        status:
          type: string
          title: Status
        data_source_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Data Source Id
      type: object
      required:
      - url
      - status
      title: FacesUrl
      description: "A short-lived per-face GLB URL plus its generation status.\n\n``url`` is null whenever ``status`` is not ``ok``. ``status`` mirrors the\npreview contract:\n\n* ``ok`` — ``url`` present.\n* ``pending`` — the model is still being prepared. Poll; it will settle.\n* ``failed`` — preparation did not succeed. Retryable.\n* ``unsupported`` — the CAD is a mesh format, which carries no B-rep\n  faces, so a per-face model will never exist for it.\n* ``no_dataset`` — the revision has no active 3D CAD. A revision that\n  does not exist in the caller's organization answers 404 instead.\n\n``pending`` and ``failed`` are distinct from ``unsupported`` and\n``no_dataset`` on purpose: the first two describe a model that is coming\nor that can be retried, the last two a model that will never exist.\n``data_source_id`` identifies the CAD this answer is about, so a client\ncan retry preparation via ``POST /datasets/{id}/preview/retry``."
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /api/v1/sessions/login
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'Server-to-server API key in the ``X-API-Key`` header, e.g. ``ak_live_…``. See the Authentication guide. Do not send it as ``Authorization: Bearer`` — that header is reserved for session / MCP JWTs.'
x-refined-from:
- openapi-public.json
- arcnm-io-openapi.yml