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/relayger-com:relayger-com-tasks-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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:
  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 Tasks API
  version: 0.13.15
servers:
- url: https://relayger.com
security:
- bearerAuth: []
- sessionCookie: []
tags:
- name: Tasks
paths:
  /v1/tasks:
    get:
      operationId: get_v1_tasks
      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: Tasks you can access
      tags:
      - Tasks
    post:
      operationId: post_v1_tasks
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskCreate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
          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: Create a durable task
      tags:
      - Tasks
  /v1/tasks/{id}:
    get:
      operationId: get_v1_tasks__id_
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
          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: Task details
      tags:
      - Tasks
  /v1/tasks/{id}/cancel:
    post:
      operationId: post_v1_tasks__id__cancel
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OK'
          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: Cancel the task and its subtasks
      tags:
      - Tasks
  /v1/tasks/{id}/claim:
    post:
      operationId: post_v1_tasks__id__claim
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
          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: Take an atomic 30-second lease
      tags:
      - Tasks
  /v1/tasks/{id}/update:
    post:
      operationId: post_v1_tasks__id__update
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
          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: Fenced heartbeat or state change
      tags:
      - Tasks
components:
  schemas:
    TaskCreate:
      $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
      description: Optional structured data must fit 32 KiB as encoded JSON and after decimal number expansion.
      properties:
        assignee:
          maxLength: 64
          minLength: 1
          type: string
        assigneeId:
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          type: string
        clientTaskId:
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          type: string
        input:
          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
        parentLeaseOwner:
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          type: string
        parentTaskId:
          anyOf:
          - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
            type: string
          - type: 'null'
        parentVersion:
          pattern: ^(0|[1-9][0-9]*)$
          type: string
        roomId:
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          type: string
      required:
      - roomId
      - clientTaskId
      - input
      type: object
    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
    __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
    OK:
      additionalProperties: false
      properties:
        ok:
          type: boolean
      required:
      - ok
      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
    TaskUpdate:
      $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
      description: Optional result data must fit 32 KiB as encoded JSON and after decimal number expansion.
      properties:
        artifactIds:
          items:
            pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
            type: string
          maxItems: 8
          type: array
        error:
          maxLength: 2000
          type: string
        leaseOwner:
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          type: string
        progress:
          additionalProperties: false
          properties:
            note:
              maxLength: 500
              type: string
            percent:
              maximum: 100
              minimum: 0
              type: integer
          type: object
        result:
          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
        state:
          enum:
          - running
          - waiting_approval
          - completed
          - failed
          type: string
        version:
          pattern: ^(0|[1-9][0-9]*)$
          type: string
      required:
      - version
      - leaseOwner
      - state
      type: object
  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