tender-agents-com Gaeb API

openapi: 3.2.0
info:
  title: Tender Agents Com Gaeb API
  version: 0.1.0
  description: 'Operations tagged gaeb across 2 of this provider''s published API definitions: api.tender-agents.com_openapi.json, tender-agents-com-agentleads-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: gaeb
paths:
  /api/v1/pilot/{profile_id}/{access_token}/gaeb/analyze:
    post:
      tags:
      - gaeb
      summary: Analyze Gaeb Upload
      operationId: analyze_gaeb_upload_api_v1_pilot__profile_id___access_token__gaeb_analyze_post
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          type: string
          title: Profile Id
      - name: access_token
        in: path
        required: true
        schema:
          type: string
          title: Access Token
      - name: search
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Search
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_analyze_gaeb_upload_api_v1_pilot__profile_id___access_token__gaeb_analyze_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GaebAnalysisOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/pilot/{profile_id}/{access_token}/gaeb/export:
    post:
      tags:
      - gaeb
      summary: Export Gaeb Upload
      operationId: export_gaeb_upload_api_v1_pilot__profile_id___access_token__gaeb_export_post
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          type: string
          title: Profile Id
      - name: access_token
        in: path
        required: true
        schema:
          type: string
          title: Access Token
      - name: format
        in: query
        required: false
        schema:
          enum:
          - csv
          - xlsx
          type: string
          default: csv
          title: Format
      - name: search
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Search
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_export_gaeb_upload_api_v1_pilot__profile_id___access_token__gaeb_export_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Body_export_gaeb_upload_api_v1_pilot__profile_id___access_token__gaeb_export_post:
      properties:
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
      type: object
      required:
      - file
      title: Body_export_gaeb_upload_api_v1_pilot__profile_id___access_token__gaeb_export_post
    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
    Body_analyze_gaeb_upload_api_v1_pilot__profile_id___access_token__gaeb_analyze_post:
      properties:
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
      type: object
      required:
      - file
      title: Body_analyze_gaeb_upload_api_v1_pilot__profile_id___access_token__gaeb_analyze_post
    GaebAnalysisOut:
      properties:
        exchange_phase:
          type: string
          enum:
          - X83
          - X84
          title: Exchange Phase
        gaeb_version:
          anyOf:
          - type: string
          - type: 'null'
          title: Gaeb Version
        project_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Name
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
        boq_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Boq Name
        position_count:
          type: integer
          title: Position Count
        sections:
          items:
            $ref: '#/components/schemas/GaebSectionSummaryOut'
          type: array
          title: Sections
        positions:
          items:
            $ref: '#/components/schemas/GaebPositionOut'
          type: array
          title: Positions
      type: object
      required:
      - exchange_phase
      - position_count
      title: GaebAnalysisOut
    GaebPositionOut:
      properties:
        section:
          type: string
          title: Section
        ordinal:
          type: string
          title: Ordinal
        short_text:
          anyOf:
          - type: string
          - type: 'null'
          title: Short Text
        long_text:
          anyOf:
          - type: string
          - type: 'null'
          title: Long Text
        quantity:
          anyOf:
          - type: string
          - type: 'null'
          title: Quantity
        unit:
          anyOf:
          - type: string
          - type: 'null'
          title: Unit
        unit_price:
          anyOf:
          - type: string
          - type: 'null'
          title: Unit Price
        total_price:
          anyOf:
          - type: string
          - type: 'null'
          title: Total Price
      type: object
      required:
      - section
      - ordinal
      title: GaebPositionOut
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    GaebSectionSummaryOut:
      properties:
        name:
          type: string
          title: Name
        position_count:
          type: integer
          title: Position Count
      type: object
      required:
      - name
      - position_count
      title: GaebSectionSummaryOut
  securitySchemes:
    oauth2ClientCredentials:
      type: oauth2
      description: 'OAuth 2.0 Client Credentials. client_id ist die Kennung eines API-Schluessels, client_secret der Schluessel selbst. Das Token laeuft nach einer Stunde ab und nennt seinen Umfang; wird der Schluessel widerrufen, traegt es sofort nicht mehr. Metadaten: /.well-known/oauth-authorization-server und /.well-known/oauth-protected-resource.'
      flows:
        clientCredentials:
          tokenUrl: /oauth/token
          scopes:
            tenders:read: Read tender search, detail, source status and country coverage.
            fulltext:read: Full text search across indexed notices. Requires a plan that permits it.
            profiles:read: Read company profiles and their explained matches.
            webhooks:write: Manage delivery webhooks.
    apiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: sk_<random>
      description: 'API-Schluessel als HTTP-Bearer-Token: ''Authorization: Bearer sk_...''. Kein anderer Header wird ausgewertet; eine Anfrage mit X-API-Key gilt als nicht angemeldet und laeuft im anonymen Limit. Schluessel gibt es kostenlos ueber POST /api/signup. Der Tarif des Schluessels (free, pro, agent) entscheidet ueber Limits und ueber den Zugang zu Volltextsuche, Export und Agent-Funktionen.'
x-refined-from:
- api.tender-agents.com_openapi.json
- tender-agents-com-agentleads-openapi.json