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/vertesiahq:vertesiahq-email-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

openapi: 3.2.0
info:
  title: Vertesia Email API
  version: 1.6.0-dev.20261019.172735Z
  x-api-version: '20260803'
  description: The Vertesia API provides project-scoped access to interaction execution and content workflows. Use it to run interactions, inspect execution history, stream run progress, replay previous executions, and search content objects and collections. Authenticate requests with a bearer token, or use the official `@vertesia/client` package for typed access from Node.js applications.
  contact:
    name: Vertesia
    url: https://vertesiahq.com/
  license:
    name: Apache-2.0
    identifier: Apache-2.0
  x-scalar-sdk-installation:
  - lang: Node
    description: 'Install the **Vertesia Client** from npm:'
    source: npm install @vertesia/client
servers:
- url: https://api.{region}.vertesia.io/api/v1
  description: Vertesia API
  variables:
    region:
      default: us1
      enum:
      - us1
      - eu1
      - jp1
      description: Regional API host label. `us1` is the global endpoint.
tags:
- name: Email
paths:
  /email/send:
    parameters:
    - name: x-api-version
      in: header
      required: true
      schema:
        type: string
        minLength: 1
        pattern: \S
        example: '20260803'
      description: Required Vertesia API version header. Use `20260803` for the current stable API shape.
      x-vertesia-global-header: true
    post:
      operationId: SendAgentEmail
      tags:
      - Email
      summary: Send an email from an agent workflow
      description: 'Send an email from an agent/workflow.

        Creates a route key if not provided, sends via Resend, and returns routing info.

        Resend configuration is fetched from the project''s integration settings.


        **Required permissions:** `workflow:run`'
      security:
      - bearerAuth: []
      - OAuth2:
        - workflow:run
      parameters: []
      responses:
        '200':
          description: Email delivery result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendEmailResponse'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Server Error
                status: 500
                message: Internal server error.
        4XX:
          description: Client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
                status: 400
                message: Request validation failed.
      x-vertesia-permissions:
      - workflow:run
      x-vertesia-source:
        file: ../../apps/zeno-server/src/api/email.ts
        className: EmailResource
        methodName: sendEmail
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendEmailRequest'
  /email/routes:
    parameters:
    - name: x-api-version
      in: header
      required: true
      schema:
        type: string
        minLength: 1
        pattern: \S
        example: '20260803'
      description: Required Vertesia API version header. Use `20260803` for the current stable API shape.
      x-vertesia-global-header: true
    post:
      operationId: CreateEmailRoute
      tags:
      - Email
      summary: Create an email reply route
      description: 'Create a new email route without sending an email.

        Useful for external services that want to handle email sending themselves

        but need reply routing back to Vertesia workflows.


        Returns the route key to use in reply-to addresses: r+{route_key}@{email_domain}


        **Required permissions:** `workflow:run`'
      security:
      - bearerAuth: []
      - OAuth2:
        - workflow:run
      parameters: []
      responses:
        '200':
          description: Created email route.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEmailRouteResponse'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Server Error
                status: 500
                message: Internal server error.
        4XX:
          description: Client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
                status: 400
                message: Request validation failed.
      x-vertesia-permissions:
      - workflow:run
      x-vertesia-source:
        file: ../../apps/zeno-server/src/api/email.ts
        className: EmailResource
        methodName: createRoute
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEmailRouteRequest'
  /email/routes/{key}:
    parameters:
    - name: x-api-version
      in: header
      required: true
      schema:
        type: string
        minLength: 1
        pattern: \S
        example: '20260803'
      description: Required Vertesia API version header. Use `20260803` for the current stable API shape.
      x-vertesia-global-header: true
    get:
      operationId: GetEmailRoute
      tags:
      - Email
      summary: Retrieve an email route
      description: 'Get an email route by key.


        **Required permissions:** Any of `agent_run:read`, `workflow:run`'
      security:
      - bearerAuth: []
      - OAuth2:
        - agent_run:read
      - OAuth2:
        - workflow:run
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Email route data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailRouteResponse'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Server Error
                status: 500
                message: Internal server error.
        4XX:
          description: Client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
                status: 400
                message: Request validation failed.
      x-vertesia-permissions:
      - agent_run:read
      - workflow:run
      x-vertesia-source:
        file: ../../apps/zeno-server/src/api/email.ts
        className: EmailResource
        methodName: getRoute
    put:
      operationId: UpdateEmailRoute
      tags:
      - Email
      summary: Update email route threading data
      description: 'Update an email route (e.g., to update threading info).


        **Required permissions:** `workflow:run`'
      security:
      - bearerAuth: []
      - OAuth2:
        - workflow:run
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Email route update result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateEmailRouteResponse'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Server Error
                status: 500
                message: Internal server error.
        4XX:
          description: Client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
                status: 400
                message: Request validation failed.
      x-vertesia-permissions:
      - workflow:run
      x-vertesia-source:
        file: ../../apps/zeno-server/src/api/email.ts
        className: EmailResource
        methodName: updateRoute
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEmailRouteRequest'
  /email/routes/{key}/forward:
    parameters:
    - name: x-api-version
      in: header
      required: true
      schema:
        type: string
        minLength: 1
        pattern: \S
        example: '20260803'
      description: Required Vertesia API version header. Use `20260803` for the current stable API shape.
      x-vertesia-global-header: true
    post:
      operationId: ForwardEmailToWorkflow
      tags:
      - Email
      summary: Forward an email to a workflow
      description: 'Forward an email to an existing workflow via route key.


        Use this when an external service receives an email reply and needs to

        forward it to the Vertesia workflow. The external service can add custom

        context data (like auth tokens) that will be passed to the workflow.


        **Required permissions:** `workflow:run`'
      security:
      - bearerAuth: []
      - OAuth2:
        - workflow:run
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Forwarding result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForwardEmailResponse'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Server Error
                status: 500
                message: Internal server error.
        4XX:
          description: Client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
                status: 400
                message: Request validation failed.
      x-vertesia-permissions:
      - workflow:run
      x-vertesia-source:
        file: ../../apps/zeno-server/src/api/email.ts
        className: EmailResource
        methodName: forwardEmailToWorkflow
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ForwardEmailRequest'
components:
  schemas:
    UpdateEmailRouteResponse:
      type: object
      properties:
        success:
          type: boolean
        route_key:
          type: string
      required:
      - success
      - route_key
      additionalProperties: false
    EmailRouteResponse:
      type: object
      properties:
        runId:
          type: string
        accountId:
          type: string
        projectId:
          type: string
        threadSubject:
          type: string
        inReplyTo:
          type: string
        references:
          type: array
          items:
            type: string
        userEmail:
          type: string
        inboundDomain:
          type: string
        route_key:
          type: string
      required:
      - runId
      - accountId
      - projectId
      - userEmail
      - inboundDomain
      - route_key
      additionalProperties: false
    CreateEmailRouteResponse:
      type: object
      properties:
        route_key:
          type: string
        reply_to:
          type: string
        email_domain:
          type: string
      required:
      - route_key
      - reply_to
      - email_domain
      additionalProperties: false
    UpdateEmailRouteRequest:
      type: object
      properties:
        threadSubject:
          type: string
        inReplyTo:
          type: string
        references:
          type: array
          items:
            type: string
        userEmail:
          type: string
      additionalProperties: false
    CreateEmailRouteRequest:
      type: object
      properties:
        run_id:
          type: string
        user_email:
          type: string
        thread_subject:
          type: string
      required:
      - run_id
      - user_email
      additionalProperties: false
    ForwardEmailRequest:
      type: object
      properties:
        email:
          type: object
          properties:
            from:
              type: string
            subject:
              type: string
            text:
              type: string
            html:
              type: string
            message_id:
              type: string
          required:
          - from
          - text
          additionalProperties: false
        context:
          type: object
          additionalProperties: true
        attachments:
          type: array
          items:
            type: object
            properties:
              filename:
                type: string
              content_type:
                type: string
              size:
                type: number
              download_url:
                type: string
            required:
            - filename
            - content_type
            - size
            - download_url
            additionalProperties: false
      required:
      - email
      additionalProperties: false
    SendEmailRequest:
      type: object
      properties:
        to_email:
          type: string
        subject:
          type: string
        body:
          type: string
        agent_name:
          type: string
        from_name:
          type: string
        run_id:
          type: string
        route_key:
          type: string
        in_reply_to:
          type: string
        references:
          type: array
          items:
            type: string
      required:
      - to_email
      - subject
      - body
      - agent_name
      - run_id
      additionalProperties: false
    SendEmailResponse:
      type: object
      properties:
        success:
          type: boolean
        email_id:
          type: string
        message_id:
          type: string
        route_key:
          type: string
        error:
          type: string
      required:
      - success
      additionalProperties: false
    ErrorResponse:
      type: object
      description: Standard JSON error response returned by the server error handler.
      properties:
        error:
          type: string
          description: HTTP status text or normalized error type.
        status:
          type: integer
          format: int32
          minimum: 400
          maximum: 599
          description: HTTP status code. Client errors use a 4xx status code; server errors use 500.
          example: 400
        message:
          type: string
          description: Human-readable error message.
        details:
          type: string
          description: Optional additional error details.
        errorCode:
          type: string
          description: Machine-readable code for the specific failure, present when the error carries one, so clients can branch on it without parsing `message`.
          example: account_api_key_creation_disabled
      required:
      - error
      - status
      additionalProperties: false
    ForwardEmailResponse:
      type: object
      properties:
        success:
          type: boolean
        run_id:
          type: string
        workflow_id:
          type: string
        route_key:
          type: string
      required:
      - success
      - run_id
      - workflow_id
      - route_key
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://cloud.us1.vertesia.io/oauth/authorize
          tokenUrl: https://sts.vertesia.io/oauth/token
          x-scalar-security-query:
            resource: https://api.us1.vertesia.io/api/v1
          x-scalar-security-body:
            resource: https://api.us1.vertesia.io/api/v1
          scopes:
            openid: ''
            profile: ''
            offline_access: ''
            interaction:read: ''
            interaction:write: ''
            interaction:delete: ''
            interaction:execute: ''
            run:read: ''
            run:write: ''
            environment:admin: ''
            app:manage: ''
            project:admin: ''
            project:integration_read: ''
            project:settings_write: ''
            api_key:read: ''
            account:read: ''
            account:write: ''
            account:admin: ''
            audit:read: ''
            account:member: ''
            content:read: ''
            content:read_all: ''
            content:write: ''
            content:delete: ''
            content:admin: ''
            content:superadmin: ''
            workflow:read: ''
            workflow:run: ''
            workflow:admin: ''
            workflow:superadmin: ''
            agent_run:read: ''
            task:read: ''
            task:manage: ''
x-tagGroups:
- name: Authentication
  tags:
  - Token Service
- name: GenAI
  tags:
  - Environments
  - Prompt Templates
  - Interactions
  - Interaction Runs
  - Agent Runs
- name: Content
  tags:
  - Content Object Types
  - Objects
  - Collections
  - Files
  - Rendering
  - Bulk Operations
  - Commands
- name: Data Store
  tags:
  - Data
- name: Workflow
  tags:
  - Processes
  - Tasks
  - Workflow Definitions
  - Workflow Rules
  - Workflow Runs
- name: Administration
  tags:
  - Accounts
  - Projects
  - Audit Trail
  - Costs
- name: Access Control
  tags:
  - Users
  - User Groups
  - Roles
  - Access Control Entries
  - API Keys
- name: Apps & Integrations
  tags:
  - Apps
  - OAuth Providers
  - OAuth Clients
  - OAuth Grants
  - Remote MCP Connections