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/wove-sources-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: Wove External Sources API
  version: 1.0.0
  description: '# Wove External API Documentation


    The Wove External API allows you to programmatically access document processing, shipment management, and validation capabilities.'
  contact:
    name: Wove API Support
    email: api-support@wove.com
    url: https://docs.wove.com
  license:
    name: Proprietary
    url: https://wove.com/terms
servers:
- url: https://api.wove.com
  description: Production server
- url: https://staging-api.wove.com
  description: Staging server
- url: http://localhost:4000
  description: Development server
security:
- bearerAuth: []
tags:
- name: Sources
  description: Rate sheet source management - upload, process, and query status
paths:
  /api/v1/external/sources/upload:
    post:
      tags:
      - Sources
      summary: Get presigned URL for source upload
      description: 'Creates a new source record and returns a presigned URL for uploading a rate sheet file.


        **Workflow**:

        1. Call this endpoint with file metadata

        2. Upload the file directly to the returned presigned URL using PUT

        3. Call POST /sources/{sourceId}/process to start processing


        **Supported file types**: Excel (.xlsx, .xls), CSV, PDF


        **File size limit**: 50MB'
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSourceUploadRequest'
            example:
              filename: carrier_rates_2024.xlsx
              contentType: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
              sourceType: contract
              carrierId: '123456789'
              effectiveDate: '2024-01-01'
              expiryDate: '2024-12-31'
              description: Q1 2024 contract rates from carrier
      responses:
        '201':
          description: Source created successfully with upload URL
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/CreateSourceUploadResponse'
              example:
                success: true
                data:
                  sourceId: '1234567890123456789'
                  uploadUrl: https://s3.amazonaws.com/bucket/path?signature=...
                  expiresAt: '2024-01-15T12:30:00.000Z'
        '400':
          description: Bad request - invalid parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Insufficient permissions - requires sources:write scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: postApiV1ExternalSourcesUpload
      x-operation-id-source: derived
  /api/v1/external/sources/{sourceId}/process:
    post:
      tags:
      - Sources
      summary: Start processing an uploaded source
      description: 'Initiates processing of a source file after it has been uploaded to the presigned URL.


        The source will be queued for processing and its status will transition through:

        - `pending` → `processing` → `complete` or `failed`


        Use GET /sources/{sourceId} to monitor processing status.

        Configure webhooks to receive notifications when processing completes.'
      security:
      - bearerAuth: []
      parameters:
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
        description: The source ID returned from the upload endpoint
        example: '1234567890123456789'
      responses:
        '200':
          description: Processing started successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/ProcessSourceResponse'
              example:
                success: true
                data:
                  sourceId: '1234567890123456789'
                  status: pending
                  message: Source queued for processing
        '400':
          description: Source not ready for processing (not uploaded yet)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Source not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: postApiV1ExternalSourcesBySourceIdProcess
      x-operation-id-source: derived
  /api/v1/external/sources:
    get:
      tags:
      - Sources
      summary: List all sources
      description: 'Returns a paginated list of all rate sheet sources for your organization.


        Sources can be filtered by status and sorted by various fields.'
      security:
      - bearerAuth: []
      parameters:
      - name: status
        in: query
        schema:
          type: string
          enum:
          - awaiting_upload
          - pending
          - processing
          - complete
          - failed
        description: Filter by processing status
      - name: carrierId
        in: query
        schema:
          type: string
        description: Filter by carrier ID
      - name: limit
        in: query
        schema:
          type: integer
          default: 50
          maximum: 100
        description: Number of results to return
      - name: offset
        in: query
        schema:
          type: integer
          default: 0
        description: Number of results to skip
      responses:
        '200':
          description: Sources retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      sources:
                        type: array
                        items:
                          $ref: '#/components/schemas/ExternalSourceSummary'
                      total:
                        type: integer
                        description: Total number of sources matching the filter
              example:
                success: true
                data:
                  sources:
                  - id: '1234567890123456789'
                    filename: carrier_rates_2024.xlsx
                    status: complete
                    sourceType: contract
                    carrierId: '123456789'
                    carrierName: Maersk
                    rateCount: 1250
                    effectiveDate: '2024-01-01'
                    expiryDate: '2024-12-31'
                    createdAt: '2024-01-15T10:00:00.000Z'
                    processedAt: '2024-01-15T10:05:00.000Z'
                  total: 1
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: getApiV1ExternalSources
      x-operation-id-source: derived
  /api/v1/external/sources/{sourceId}:
    get:
      tags:
      - Sources
      summary: Get source details
      description: Returns detailed information about a specific source, including processing status and any errors.
      security:
      - bearerAuth: []
      parameters:
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
        description: The source ID
        example: '1234567890123456789'
      responses:
        '200':
          description: Source details retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/ExternalSourceDetail'
              example:
                success: true
                data:
                  id: '1234567890123456789'
                  filename: carrier_rates_2024.xlsx
                  status: complete
                  sourceType: contract
                  carrierId: '123456789'
                  carrierName: Maersk
                  rateCount: 1250
                  effectiveDate: '2024-01-01'
                  expiryDate: '2024-12-31'
                  description: Q1 2024 contract rates
                  createdAt: '2024-01-15T10:00:00.000Z'
                  processedAt: '2024-01-15T10:05:00.000Z'
                  error: null
        '404':
          description: Source not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: getApiV1ExternalSourcesBySourceId
      x-operation-id-source: derived
components:
  schemas:
    ExternalSourceDetail:
      type: object
      properties:
        id:
          type: string
        filename:
          type: string
        status:
          type: string
          enum:
          - awaiting_upload
          - pending
          - processing
          - complete
          - failed
        sourceType:
          type: string
          enum:
          - contract
          - spot
          - tariff
        carrierId:
          type: string
        carrierName:
          type: string
        rateCount:
          type: integer
        effectiveDate:
          type: string
          format: date
        expiryDate:
          type: string
          format: date
        description:
          type: string
        createdAt:
          type: string
          format: date-time
        processedAt:
          type: string
          format: date-time
        error:
          type: string
          nullable: true
          description: Error message if processing failed
    CreateSourceUploadResponse:
      type: object
      properties:
        sourceId:
          type: string
          description: Unique identifier for the created source
        uploadUrl:
          type: string
          description: Presigned URL for uploading the file (expires in 15 minutes)
        expiresAt:
          type: string
          format: date-time
          description: When the upload URL expires
      required:
      - sourceId
      - uploadUrl
      - expiresAt
    CreateSourceUploadRequest:
      type: object
      properties:
        filename:
          type: string
          description: The filename of the rate sheet to upload
          example: carrier_rates_2024.xlsx
        contentType:
          type: string
          description: MIME type of the file
          example: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
        sourceType:
          type: string
          enum:
          - contract
          - spot
          - tariff
          description: Type of rate sheet
        carrierId:
          type: string
          description: Optional carrier ID to associate with this source
        effectiveDate:
          type: string
          format: date
          description: Date when rates become effective
        expiryDate:
          type: string
          format: date
          description: Date when rates expire
        description:
          type: string
          description: Optional description of the source
      required:
      - filename
    ExternalSourceSummary:
      type: object
      properties:
        id:
          type: string
          description: Source ID
        filename:
          type: string
          description: Original filename
        status:
          type: string
          enum:
          - awaiting_upload
          - pending
          - processing
          - complete
          - failed
          description: Processing status
        sourceType:
          type: string
          enum:
          - contract
          - spot
          - tariff
        carrierId:
          type: string
        carrierName:
          type: string
        rateCount:
          type: integer
          description: Number of rates extracted from this source
        effectiveDate:
          type: string
          format: date
        expiryDate:
          type: string
          format: date
        createdAt:
          type: string
          format: date-time
        processedAt:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
              example: VALIDATION_ERROR
            message:
              type: string
              example: Invalid input parameters
            details:
              type: object
              description: Additional error context
      required:
      - success
      - error
    ProcessSourceResponse:
      type: object
      properties:
        sourceId:
          type: string
          description: The source ID
        status:
          type: string
          enum:
          - pending
          - processing
          description: Current processing status
        message:
          type: string
          description: Status message
      required:
      - sourceId
      - status
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 Bearer token obtained from /auth/token endpoint