openapi: 3.2.0
info:
  version: v2.222.1
  title: Corva Tasks API
  description: 'The Corva API is a powerful interface providing great flexibility and extensibility with Corva. Whether your needs are simple UI visualizations, data entry, replication/sync tasks, real-time stream processing, or complex machine learning CPU-intensive apps, the Corva API is the way to make it happen. Our concepts are split into three distinct silos: data apps, visualization apps, and a REST API'
  termsOfService: https://www.corva.ai/terms-and-conditions/
  contact:
    name: Corva API Team
    email: support@corva.ai
security:
- api_key: []
tags:
- name: Tasks
  description: Trigger and check status for background tasks
paths:
  /v2/tasks:
    post:
      summary: Create a new task
      tags:
      - Tasks
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          description: Show the created task
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskConfiguration'
        description: Task Configuration
        required: true
      operationId: postV2Tasks
      x-operation-id-source: derived
    get:
      summary: List tasks for asset and application
      tags:
      - Tasks
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          description: List all queried tasks
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Task'
      parameters:
      - in: query
        name: asset_id
        description: Asset ID
        required: true
        schema:
          type: integer
      - in: query
        name: app_key
        description: App Key for the background app to execute
        required: true
        schema:
          type: string
      - in: query
        name: per_page
        description: Number of items to list per page
        schema:
          type: integer
      - in: query
        name: sort
        description: A field to sort by
        schema:
          type: string
          enum:
          - state
          - created_at
          - updated_at
          default: created_at
      - in: query
        name: order
        description: A sorting direction
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      - in: query
        name: state
        description: Filter by task's state
        schema:
          type: string
          enum:
          - running
          - failed
          - succeeded
      - in: query
        name: output_type
        description: Filter by outputType property presence
        schema:
          type: boolean
      - in: query
        name: include_performer
        description: Include performer User in response
        schema:
          type: string
          enum:
          - 'true'
      operationId: getV2Tasks
      x-operation-id-source: derived
  /v2/tasks/{id}:
    get:
      summary: Show Task
      tags:
      - Tasks
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          type: object
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskShow'
      parameters:
      - in: path
        name: id
        description: Task ID
        required: true
        schema:
          type: string
          format: uuid
      operationId: getV2TasksById
      x-operation-id-source: derived
    patch:
      summary: Update payload of a task.
      tags:
      - Tasks
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      parameters:
      - in: path
        name: id
        description: Task ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                payload:
                  type: object
              example:
                payload:
                  attribute: value
        description: Task Configuration
        required: true
      operationId: patchV2TasksById
      x-operation-id-source: derived
  /v2/tasks/{id}/{status}:
    put:
      summary: Update task status
      tags:
      - Tasks
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          description: Show the task
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
      parameters:
      - in: path
        name: id
        description: Task ID
        required: true
        schema:
          type: string
      - in: query
        name: status
        description: Status
        required: true
        schema:
          type: string
          enum: success failure
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskPayload'
        description: Payload
      operationId: putV2TasksByIdByStatus
      x-operation-id-source: derived
components:
  schemas:
    TaskPayload:
      properties:
        fail_reason:
          type: string
        payload:
          type: object
      example:
        fail_reason: null
        payload:
          offsets:
          - 248
          - 93434
          factor: 56
    TaskShow:
      properties:
        id:
          type: integer
          format: uuid
        state:
          type: string
        fail_reason:
          type: string
        asset_id:
          type: integer
          format: int64
        company_id:
          type: integer
          format: int64
        app_id:
          type: integer
          format: int64
        document_bucket:
          type: string
        properties:
          type: object
        payload:
          type: object
      example:
        id: e42776dd-2b13-48ad-9c89-620eb7808956
        state: running
        fail_reason: null
        asset_id: 3208
        company_id: 3
        app_id: 596
        document_bucket: corva-files
        properties:
          attribute: value
        payload: {}
    AuthorizationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 403
        message: Access denied
    Task:
      required:
      - id
      - type
      properties:
        id:
          type: integer
          format: int64
        type:
          type: string
        attributes:
          type: object
          properties:
            id:
              type: string
              format: uuid
            state:
              type: string
            fail_reason:
              type: string
            asset_id:
              type: integer
              format: int64
            company_id:
              type: integer
              format: int64
            app_id:
              type: integer
              format: int64
            document_bucket:
              type: string
            properties:
              type: object
            payload:
              type: object
      example:
        id: e42776dd-2b13-48ad-9c89-620eb7808956
        name: My Task
        options:
          name: A single option
          value: The optional value
        type: task
        attributes:
          id: e42776dd-2b13-48ad-9c89-620eb7808956
          state: running
          fail_reason: null
          asset_id: 3208
          company_id: 2930
          app_id: 596
          document_bucket: corva-files
          properties:
            attribute: value
          payload: {}
    TaskConfiguration:
      properties:
        app_key:
          type: string
        provider:
          type: string
        asset_id:
          type: integer
        properties:
          type: object
        payload:
          type: object
        app_version:
          type: integer
      example:
        provider: corva
        app_key: drilling-roadmap
        asset_id: 2342
        properties:
          operation: scoring
        payload:
          offsets:
          - 248
          - 93434
          factor: 56
        app_version: 2
    AuthenticationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 401
        message: Missing authentication. Please try again.
    NotFoundError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 404
        message: Not found
  securitySchemes:
    api_key:
      type: apiKey
      name: authorization
      in: header