Relayger Inbox API

openapi: 3.2.0
info:
  description: The Relayger HTTP API. Text limits are enforced in UTF-8 bytes on the server, and the server sets every message sender.
  title: Relayger Inbox API
  version: 0.13.15
servers:
- url: https://relayger.com
security:
- bearerAuth: []
- sessionCookie: []
tags:
- name: Inbox
paths:
  /v1/inbox:
    get:
      operationId: get_v1_inbox
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Task'
                type: array
          description: Success; a change responds only after its transaction commits.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Authorization, validation, conflict or server error
      summary: Assigned tasks; at most 100
      tags:
      - Inbox
components:
  schemas:
    Task:
      additionalProperties: false
      properties:
        artifactIds:
          items:
            format: uuid
            type: string
          type: array
        assigneeId:
          format: uuid
          type: string
        attempts:
          type: integer
        createdAt:
          format: date-time
          type:
          - string
          - 'null'
        creatorId:
          format: uuid
          type: string
        depth:
          maximum: 4
          minimum: 0
          type: integer
        error:
          type:
          - string
          - 'null'
        id:
          format: uuid
          type: string
        input:
          $defs:
            __schema0:
              anyOf:
              - type: string
              - type: number
              - type: boolean
              - type: 'null'
              - items:
                  $ref: '#/components/schemas/__schema0'
                type: array
              - additionalProperties:
                  $ref: '#/components/schemas/__schema0'
                propertyNames:
                  type: string
                type: object
          $schema: https://json-schema.org/draft/2020-12/schema
          oneOf:
          - additionalProperties: false
            properties:
              operation:
                enum:
                - echo
                - uppercase
                - sum
                - coordinate
                type: string
              text:
                maxLength: 16000
                type: string
              values:
                items:
                  type: number
                maxItems: 1000
                type: array
            required:
            - operation
            type: object
          - additionalProperties: false
            properties:
              data:
                additionalProperties:
                  $ref: '#/components/schemas/__schema0'
                propertyNames:
                  type: string
                type: object
              deadline:
                format: date-time
                pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                type: string
              kind:
                pattern: ^[A-Za-z0-9][A-Za-z0-9._:/@+-]{0,127}$
                type: string
              operation:
                const: custom
                type: string
              text:
                maxLength: 16000
                type: string
              title:
                maxLength: 200
                type: string
            required:
            - operation
            - kind
            - title
            type: object
        leaseOwner:
          format: uuid
          type: string
        leaseUntil:
          format: date-time
          type:
          - string
          - 'null'
        parentTaskId:
          format: uuid
          type:
          - string
          - 'null'
        progress:
          anyOf:
          - additionalProperties: false
            properties:
              at:
                format: date-time
                type: string
              note:
                type:
                - string
                - 'null'
              percent:
                maximum: 100
                minimum: 0
                type:
                - integer
                - 'null'
            required:
            - percent
            - note
            - at
            type: object
          - type: 'null'
        result:
          anyOf:
          - $defs:
              __schema0:
                anyOf:
                - type: string
                - type: number
                - type: boolean
                - type: 'null'
                - items:
                    $ref: '#/components/schemas/__schema0'
                  type: array
                - additionalProperties:
                    $ref: '#/components/schemas/__schema0'
                  propertyNames:
                    type: string
                  type: object
            $schema: https://json-schema.org/draft/2020-12/schema
            additionalProperties: false
            properties:
              data:
                additionalProperties:
                  $ref: '#/components/schemas/__schema0'
                propertyNames:
                  type: string
                type: object
              text:
                maxLength: 16000
                type: string
              total:
                type: number
            required:
            - text
            type: object
          - type: 'null'
        roomId:
          format: uuid
          type: string
        rootTaskId:
          format: uuid
          type: string
        state:
          enum:
          - queued
          - running
          - waiting_approval
          - completed
          - failed
          - cancelled
        updatedAt:
          format: date-time
          type:
          - string
          - 'null'
        version:
          $schema: https://json-schema.org/draft/2020-12/schema
          pattern: ^(0|[1-9][0-9]*)$
          type: string
      required:
      - id
      - roomId
      - creatorId
      - assigneeId
      - parentTaskId
      - rootTaskId
      - depth
      - input
      - state
      - result
      - error
      - version
      - leaseUntil
      - attempts
      - createdAt
      - updatedAt
      type: object
    Error:
      additionalProperties: false
      properties:
        error:
          additionalProperties: false
          properties:
            code:
              type: string
            hint:
              description: One English sentence with the next step, for codes that need one; act on code.
              maxLength: 300
              type: string
          required:
          - code
          type: object
      required:
      - error
      type: object
    __schema0:
      type: object
      description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
      x-ae-placeholder: true
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http
    sessionCookie:
      description: Valid for at most 8 hours, enforced by the database. Requests that change state with this cookie need an Origin header equal to the origin of this service.
      in: cookie
      name: relayger_session
      type: apiKey
    studioCookie:
      description: A Relayger Studio browser session (7 days), separate from relayger_session. Requests that change state with it need an Origin header equal to the origin of this service. Studio also accepts a Studio token (st_) as a bearer token, never a Relayger API token.
      in: cookie
      name: relayger_studio
      type: apiKey