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-email-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 Email API
  version: 0.13.15
servers:
- url: https://relayger.com
security:
- bearerAuth: []
- sessionCookie: []
tags:
- name: Email
paths:
  /v1/email/complete:
    post:
      operationId: post_v1_email_complete
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailComplete'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailResult'
          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
      security: []
      summary: Complete with the 15-minute single-use link and the receiving email address.
      tags:
      - Email
  /v1/email/request:
    post:
      operationId: post_v1_email_request
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailRequest'
        required: true
      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
      security: []
      summary: Request a verification, sign-in or recovery link.
      tags:
      - Email
  /v1/email/status:
    get:
      operationId: get_v1_email_status
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailConfig'
          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
      security: []
      summary: Email service configuration status; contains no secrets
      tags:
      - Email
components:
  schemas:
    EmailRequest:
      $schema: https://json-schema.org/draft/2020-12/schema
      oneOf:
      - additionalProperties: false
        properties:
          displayName:
            maxLength: 120
            minLength: 1
            type: string
          email:
            maxLength: 254
            minLength: 3
            pattern: ^[\x21-\x7e]+@[^\s@]+$
            type: string
          handle:
            pattern: ^[a-z][a-z0-9_-]{1,39}$
            type: string
          purpose:
            const: signup
            type: string
        required:
        - purpose
        - email
        - handle
        - displayName
        type: object
      - additionalProperties: false
        properties:
          email:
            maxLength: 254
            minLength: 3
            pattern: ^[\x21-\x7e]+@[^\s@]+$
            type: string
          purpose:
            enum:
            - verify
            - login
            - recover
            type: string
        required:
        - purpose
        - email
        type: object
    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
    EmailResult:
      $schema: https://json-schema.org/draft/2020-12/schema
      anyOf:
      - additionalProperties: false
        properties:
          expiresAt:
            type: string
          id:
            format: uuid
            pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            type: string
          purpose:
            enum:
            - login
            - recover
            type: string
          recoveryKey:
            type: string
          token:
            pattern: ^rgt_[a-f0-9]{64}$
            type: string
        required:
        - id
        - token
        - expiresAt
        - purpose
        type: object
      - additionalProperties: false
        properties:
          emailVerified:
            type: boolean
          expiresAt:
            type: string
          id:
            format: uuid
            pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            type: string
          number:
            pattern: ^[1-9][0-9]{9}$
            type: string
          purpose:
            const: signup
            type: string
          recoveryKey:
            type: string
          scopes:
            items:
              type: string
            type: array
          token:
            pattern: ^rgt_[a-f0-9]{64}$
            type: string
        required:
        - id
        - token
        - expiresAt
        - purpose
        - number
        - scopes
        type: object
      - additionalProperties: false
        properties:
          ok:
            const: true
            type: boolean
          purpose:
            const: verify
            type: string
        required:
        - ok
        - purpose
        type: object
    EmailComplete:
      $schema: https://json-schema.org/draft/2020-12/schema
      additionalProperties: false
      properties:
        email:
          maxLength: 254
          minLength: 3
          pattern: ^[\x21-\x7e]+@[^\s@]+$
          type: string
        newPassword:
          maxLength: 256
          minLength: 12
          type: string
        token:
          pattern: ^em_[a-f0-9]{64}$
          type: string
      required:
      - email
      - token
      type: object
    EmailConfig:
      additionalProperties: false
      properties:
        available:
          type: boolean
        required:
          type: boolean
      required:
      - available
      - required
      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