SewerAI

SewerAI Exports API

The exports API from SewerAI — 4 operation(s) for exports.

GitHub OpenAPI

Operations 14

GET /v1/exports/ V1 exports list #
POST /v1/exports/ V1 exports create #
GET /v1/exports/{sid}/ V1 exports read #
PUT /v1/exports/{sid}/ V1 exports update #
PATCH /v1/exports/{sid}/ V1 exports partial update #
DELETE /v1/exports/{sid}/ V1 exports delete #
GET /exports/ Exports list #
POST /exports/ Exports create #
GET /exports/SchemaOptions/ Exports schema options #
POST /exports/file-output-paths/ Exports file output paths #
GET /exports/{sid}/ Exports read #
PUT /exports/{sid}/ Exports update #
PATCH /exports/{sid}/ Exports partial update #
DELETE /exports/{sid}/ Exports delete #

Documentation

📖
Documentation
https://docs.sewerai.com/
📖
APIReference
https://docs.sewerai.com/#sewerai-api
📖
GettingStarted
https://docs.sewerai.com/#introduction
📖
Authentication
https://artifacts.apis.io/sewerai/authentication/sewerai-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/sewerai/openapi/sewerai-exports-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/sewerai/json-schema/sewerai-export-schema.json
📊
JSONSchema
https://artifacts.apis.io/sewerai/json-schema/sewerai-export-read-schema.json
📊
JSONSchema
https://artifacts.apis.io/sewerai/json-schema/sewerai-export-write-schema.json

Other Resources

🔗
Swagger
https://artifacts.apis.io/sewerai/openapi/_original/sewerai-swagger.json
🔗
Conventions
https://artifacts.apis.io/sewerai/conventions/sewerai-conventions.yml
🔗
DataModel
https://artifacts.apis.io/sewerai/data-model/sewerai-data-model.yml

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/sewerai:sewerai-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

sewerai-exports-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Snippets Exports API
  description: Test description
  termsOfService: https://www.google.com/policies/terms/
  contact:
    email: contact@snippets.local
  license:
    name: BSD License
  version: v1
servers:
- url: https://574ea6n6tdopt2qigvs3hjzoha0nhhvj.lambda-url.us-west-2.on.aws/
security:
- Basic: []
tags:
- name: Exports
paths:
  /v1/exports/:
    parameters: []
    get:
      operationId: v1_exports_list
      description: ''
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExportRead'
      tags:
      - Exports
      summary: V1 exports list
      x-summary-source: derived
    post:
      operationId: v1_exports_create
      description: ''
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportWrite'
      tags:
      - Exports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportWrite'
        required: true
      summary: V1 exports create
      x-summary-source: derived
  /v1/exports/{sid}/:
    parameters:
    - name: sid
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: v1_exports_read
      description: ''
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportRead'
      tags:
      - Exports
      summary: V1 exports read
      x-summary-source: derived
    put:
      operationId: v1_exports_update
      description: ''
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportWrite'
      tags:
      - Exports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportWrite'
        required: true
      summary: V1 exports update
      x-summary-source: derived
    patch:
      operationId: v1_exports_partial_update
      description: ''
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportWrite'
      tags:
      - Exports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportWrite'
        required: true
      summary: V1 exports partial update
      x-summary-source: derived
    delete:
      operationId: v1_exports_delete
      description: ''
      responses:
        '204':
          description: ''
      tags:
      - Exports
      summary: V1 exports delete
      x-summary-source: derived
  /exports/:
    parameters: []
    get:
      operationId: exports_list
      description: ''
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Export'
      tags:
      - Exports
      summary: Exports list
      x-summary-source: derived
    post:
      operationId: exports_create
      description: ''
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Export'
      tags:
      - Exports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Export'
        required: true
      summary: Exports create
      x-summary-source: derived
  /exports/SchemaOptions/:
    parameters: []
    get:
      operationId: exports_SchemaOptions
      description: ''
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Export'
      tags:
      - Exports
      summary: Exports schema options
      x-summary-source: derived
  /exports/file-output-paths/:
    parameters: []
    post:
      operationId: exports_file_output_paths
      description: 'Given an account SID and inspection header data,

        return the file naming format that will be used when exporting a video.


        Example inspection header data:

        {

        "Pipe_Segment_Reference": "01234 01235",

        "Inspection_Date": "2020-12-24",

        "Inspection_Time": "20:09",

        ...

        }'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Export'
      tags:
      - Exports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Export'
        required: true
      summary: Exports file output paths
      x-summary-source: derived
  /exports/{sid}/:
    parameters:
    - name: sid
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: exports_read
      description: ''
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Export'
      tags:
      - Exports
      summary: Exports read
      x-summary-source: derived
    put:
      operationId: exports_update
      description: ''
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Export'
      tags:
      - Exports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Export'
        required: true
      summary: Exports update
      x-summary-source: derived
    patch:
      operationId: exports_partial_update
      description: ''
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Export'
      tags:
      - Exports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Export'
        required: true
      summary: Exports partial update
      x-summary-source: derived
    delete:
      operationId: exports_delete
      description: ''
      responses:
        '204':
          description: ''
      tags:
      - Exports
      summary: Exports delete
      x-summary-source: derived
components:
  schemas:
    ExportRead:
      type: object
      properties:
        url:
          title: Url
          type: string
          format: uri
          readOnly: true
        sid:
          title: Sid
          type: string
          format: uuid
          readOnly: true
        name:
          title: Name
          type:
          - string
          - 'null'
          maxLength: 128
        downloads:
          title: Downloads
          type: string
          readOnly: true
        output_paths:
          title: Output paths
          type: string
          readOnly: true
        progress:
          title: Progress
          type: object
        total_size:
          title: Total size
          type: number
    ExportWrite:
      type: object
      properties:
        name:
          title: Name
          type:
          - string
          - 'null'
          maxLength: 128
        sid:
          title: Sid
          type: string
          format: uuid
          readOnly: true
    Export:
      type: object
      properties:
        sid:
          title: Sid
          type: string
          format: uuid
          readOnly: true
        options:
          title: Options
          type: string
          readOnly: true
        name:
          title: Name
          type:
          - string
          - 'null'
          maxLength: 128
        num_inspections:
          title: Num inspections
          type: string
          readOnly: true
        num_inspections_completed:
          title: Num inspections completed
          type: string
          readOnly: true
        num_files:
          title: Num files
          type: string
          readOnly: true
        is_done:
          title: Is done
          type: string
          readOnly: true
        files:
          title: Files
          type: string
          readOnly: true
        has_error:
          title: Has error
          type: string
          readOnly: true
        lineal_feet:
          title: Lineal feet
          type:
          - integer
          - 'null'
          maximum: 2147483647
          minimum: -2147483648
        projects:
          type: array
          items:
            title: Projects
            type: string
            maxLength: 512
            minLength: 1
        total_size:
          title: Total size
          type: number
        progress:
          title: Progress
          type: object
        packaging_progress:
          title: Packaging progress
          type: string
          readOnly: true
        created:
          title: Created
          type: string
          format: date-time
          readOnly: true
        created_by:
          title: Created by
          type: integer
          readOnly: true
        created_by_email:
          title: Created by email
          type: string
          readOnly: true
          minLength: 1
        updated:
          title: Updated
          type: string
          format: date-time
          readOnly: true
        updated_by:
          title: Updated by
          type: integer
          readOnly: true
        completed_at:
          title: Completed at
          type:
          - string
          - 'null'
          format: date-time
  securitySchemes:
    Basic:
      type: http
      scheme: basic
x-provenance:
  method: harvested
  publisher: SewerAI
  source: https://api.sewerai.com/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)