Relevance AI

Relevance AI Warmup API

The Warmup API from Relevance AI — 4 operation(s) for warmup.

GitHub OpenAPI

Operations 4

POST /warmup/create CreateEmailWarmupInbox #
GET /warmup/{email_id}/get GetEmailWarmupStats #
POST /warmup/start StartEmailWarmup #
POST /warmup/stop StopEmailWarmup #

Documentation

📖
Documentation
https://relevanceai.com/docs
📖
APIReference
https://api-f1db6c.stack.tryrelevance.com/latest/documentation
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/authentication/relevance-ai-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/openapi/relevance-ai-warmup-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/errors/relevance-ai-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/data-model/relevance-ai-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/relevance-ai-warmup-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

relevance-ai-warmup-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Relevance AI Endpoints
  title: Relevance AI Endpoints Warmup API
  version: latest
  contact:
    email: dev@tryrelevance.com
servers:
- url: /latest
security:
- AuthorizationHeader:
  - Authorization
tags:
- name: Warmup
paths:
  /warmup/create:
    post:
      summary: CreateEmailWarmupInbox
      tags:
      - Warmup
      description: 'Begin to warmup an email address


        ### Required permissions

        > [

        {

        "actions": [

        "agents:write"

        ]

        }

        ]'
      operationId: CreateEmailWarmupInbox
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEmailWarmupInboxInput'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEmailWarmupInboxOutput'
  /warmup/{email_id}/get:
    get:
      summary: GetEmailWarmupStats
      tags:
      - Warmup
      description: 'Get the warmup stats for an email


        ### Required permissions

        > [

        {

        "actions": [

        "agents:write"

        ],

        "datasets": [

        {

        "raw": "*"

        }

        ]

        }

        ]'
      operationId: GetEmailWarmupStats
      parameters:
      - name: email_id
        in: path
        description: ID of email
        required: true
        schema:
          type: string
          maxLength: 240
          pattern: ^[a-zd._-]+$
      - in: query
        name: include_stats
        schema:
          type: boolean
        description: ''
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEmailWarmupStatsOutput'
  /warmup/start:
    post:
      summary: StartEmailWarmup
      tags:
      - Warmup
      description: 'Start email warmup for an email address


        ### Required permissions

        > [

        {

        "actions": [

        "agents:write"

        ]

        }

        ]'
      operationId: StartEmailWarmup
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartEmailWarmupInput'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartEmailWarmupOutput'
  /warmup/stop:
    post:
      summary: StopEmailWarmup
      tags:
      - Warmup
      description: 'Stop email warmup for an email address


        ### Required permissions

        > [

        {

        "actions": [

        "agents:write"

        ]

        }

        ]'
      operationId: StopEmailWarmup
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopEmailWarmupInput'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopEmailWarmupOutput'
components:
  schemas:
    StopEmailWarmupInput:
      type: object
      properties:
        email:
          type: string
      required:
      - email
    StartEmailWarmupOutput:
      type: object
      properties: {}
    CreateEmailWarmupInboxOutput:
      type: object
      properties: {}
    GetEmailWarmupStatsOutput:
      type: object
      properties:
        id:
          type: integer
        status:
          type: string
        created_at:
          type: string
        reply_rate:
          type: integer
        warmup_key_id:
          type: string
        blocked_reason:
          type:
          - string
          - 'null'
        total_sent_count:
          type: integer
        total_spam_count:
          type: integer
        warmup_max_count:
          type: integer
        warmup_min_count:
          type: integer
        is_warmup_blocked:
          type: boolean
        max_email_per_day:
          type: integer
        warmup_reputation:
          type:
          - string
          - 'null'
        stats:
          type: object
          properties:
            id:
              type: integer
            sent_count:
              type: string
            spam_count:
              type: string
            inbox_count:
              type: string
            warmup_email_received_count:
              type: string
            stats_by_date:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: integer
                  date:
                    type: string
                  sent_count:
                    type: integer
                  reply_count:
                    type: integer
                  save_from_spam_count:
                    type: integer
    CreateEmailWarmupInboxInput:
      type: object
      properties:
        from_name:
          type: string
        email:
          type: string
        password:
          type: string
        max_email_per_day:
          type: integer
        custom_tracking_url:
          type: string
        bcc:
          type: string
        signature:
          type: string
        total_warmup_per_day: {}
        daily_rampup:
          type: integer
        reply_rate_percentage:
          type: integer
      required:
      - from_name
      - email
      - password
    StopEmailWarmupOutput:
      type: object
      properties: {}
    StartEmailWarmupInput:
      type: object
      properties:
        email:
          type: string
      required:
      - email
  securitySchemes:
    AuthorizationHeader:
      type: apiKey
      in: header
      name: Authorization
      description: 'Authorization credentials. Header authorization should be in the form of: project:api_key'