Faivelo

Faivelo core API

Faivelo core API as documented publicly: 16 operations. Contract generated from the documentation by API Evangelist (2026-11-07); not the provider's own document.

Documentation GitHub OpenAPI

Operations 16

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/faivelo-com:core-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.1.0
info:
  title: Faivelo core API
  version: '2026-11-07'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-07: 16 operation(s) read from 1 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Faivelo has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 9
    documentation: 23
    pages-with-code: 2
    pages-read: 3
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-07'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://faivelo.com/docs/api
  x-docs-section: core
paths:
  /api/partner/customers:
    post:
      operationId: post_api_partner_customers
      tags:
      - Api
      summary: POST /api/partner/customers
      x-source: https://faivelo.com/docs/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiPartnerCustomersRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://faivelo.com/api/partner/customers  -H \"Authorization: Bearer fvl_live_...\" -H \"Content-Type: application/json\"\
          \  -d '{\"email\":\"owner@smiledental.example\",\"companyName\":\"Smile Dental\",\n \"attestation\":{\"firstPartyListsOnly\":true,\"\
          termsAcceptedOnBehalf\":true}}'"
  /api/partner/customers/{customerid}/domains:
    post:
      operationId: post_api_partner_customers_customerid_domains
      tags:
      - Api
      summary: POST /api/partner/customers/{customerId}/domains
      x-source: https://faivelo.com/docs/api
      parameters:
      - name: customerid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiPartnerCustomersCustomeridDomainsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://faivelo.com/api/partner/customers/CUSTOMER_ID/domains  -H "Authorization: Bearer fvl_live_..." -H "Content-Type:
          application/json"  -d ''{"domain":"smiledental.example","brandName":"Smile Dental"}'''
  /api/partner/customers/{customerid}/domains/smiledental.example:
    get:
      operationId: get_api_partner_customers_customerid_domains_smiledental_example
      tags:
      - Api
      summary: GET /api/partner/customers/{customerId}/domains/smiledental.example
      x-source: https://faivelo.com/docs/api
      parameters:
      - name: customerid
        in: path
        required: true
        schema:
          type: string
      - name: verify
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl "https://faivelo.com/api/partner/customers/CUSTOMER_ID/domains/smiledental.example?verify=true"  -H "Authorization: Bearer
          fvl_live_..."'
  /api/partner/customers/{customerid}/domains/smiledental.example/mailboxes:
    post:
      operationId: post_api_partner_customers_customerid_domains_smiledental_example_mailboxes
      tags:
      - Api
      summary: POST /api/partner/customers/{customerId}/domains/smiledental.example/mailboxes
      x-source: https://faivelo.com/docs/api
      parameters:
      - name: customerid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiPartnerCustomersCustomeridDomainsSmiledentalExampleMa'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://faivelo.com/api/partner/customers/CUSTOMER_ID/domains/smiledental.example/mailboxes  -H "Authorization:
          Bearer fvl_live_..." -H "Content-Type: application/json"  -d ''{"localPart":"hello","displayName":"Smile Dental"}''

          The same loop in the SDK: faivelo.partner.customers.create, faivelo.partner.domains.add, faivelo.partner.domains.get(..., { verify:
          true }), faivelo.partner.mail'
  /api/user/api-keys:
    post:
      operationId: post_api_user_api_keys
      tags:
      - Api
      summary: Create an agent API key
      x-source: https://faivelo.com/docs/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiUserApiKeysRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiUserApiKeysResponse'
      x-evidence:
        kind: documentation
  /api/v1/mailboxes:
    post:
      operationId: post_api_v1_mailboxes
      tags:
      - Api
      summary: POST /api/v1/mailboxes
      x-source: https://faivelo.com/docs/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1MailboxesRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://faivelo.com/api/v1/mailboxes  -H "Authorization: Bearer fvl_live_..."  -H "Content-Type: application/json"  -d
          ''{"domain": "yourdomain.com", "localPart": "my-agent", "displayName": "My Agent"}'''
  /api/v1/mailboxes/my-agent:
    post:
      operationId: post_api_v1_mailboxes_my_agent
      tags:
      - Api
      summary: Create a mailbox for the agent named "my-agent"
      x-source: https://faivelo.com/docs/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1MailboxesMyAgentRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1MailboxesMyAgentResponse'
      x-evidence:
        kind: documentation
  /api/v1/mailboxes/my-agent@yourdomain.com/messages:
    get:
      operationId: get_api_v1_mailboxes_my_agent_yourdomain_com_messages
      tags:
      - Api
      summary: GET /api/v1/mailboxes/my-agent@yourdomain.com/messages
      x-source: https://faivelo.com/docs/api
      parameters:
      - name: folder
        in: query
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl "https://faivelo.com/api/v1/mailboxes/my-agent@yourdomain.com/messages?folder=INBOX&limit=10"  -H "Authorization: Bearer
          fvl_live_..."'
  /api/v1/mailboxes/my-agent@yourdomain.com/messages/{messageid}:
    get:
      operationId: get_api_v1_mailboxes_my_agent_yourdomain_com_messages_messageid
      tags:
      - Api
      summary: GET /api/v1/mailboxes/my-agent@yourdomain.com/messages/{messageId}
      x-source: https://faivelo.com/docs/api
      parameters:
      - name: messageid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl "https://faivelo.com/api/v1/mailboxes/my-agent@yourdomain.com/messages/42"  -H "Authorization: Bearer fvl_live_..."

          MCP server

          The same four operations are exposed as MCP tools — create_mailbox, send_message, list_messages, read_message — plus update_mailbox
          to set the name a mailbox sends as, over Streamable HTTP at https://faivelo.com/api/mcp, authenticated with the same API keys (Authoriza'
  /customers/{id}:
    delete:
      operationId: delete_customers_id
      tags:
      - Customers
      summary: Erase a sandbox customer
      x-source: https://faivelo.com/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCustomersIdResponse'
      x-evidence:
        kind: documentation
    get:
      operationId: get_customers_id
      tags:
      - Customers
      summary: Get health and status of a customer
      x-source: https://faivelo.com/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCustomersIdResponse'
      x-evidence:
        kind: documentation
  /customers/{id}/api-keys:
    post:
      operationId: post_customers_id_api_keys
      tags:
      - Customers
      summary: Create a mailbox API key for a customer
      x-source: https://faivelo.com/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCustomersIdApiKeysRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostCustomersIdApiKeysResponse'
      x-evidence:
        kind: documentation
  /customers/{id}/domains/{domain}/plan:
    post:
      operationId: post_customers_id_domains_domain_plan
      tags:
      - Customers
      summary: Change the plan for a specific domain of a customer
      x-source: https://faivelo.com/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: domain
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCustomersIdDomainsDomainPlanRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostCustomersIdDomainsDomainPlanResponse'
      x-evidence:
        kind: documentation
  /customers/{id}/plan:
    post:
      operationId: post_customers_id_plan
      tags:
      - Customers
      summary: Move every domain of a customer to a new plan
      x-source: https://faivelo.com/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCustomersIdPlanRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostCustomersIdPlanResponse'
      x-evidence:
        kind: documentation
  /domains:
    get:
      operationId: get_domains
      tags:
      - Domains
      summary: List domains
      x-source: https://faivelo.com/docs/api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDomainsResponse'
      x-evidence:
        kind: documentation
  /domains/{domain}:
    get:
      operationId: get_domains_domain
      tags:
      - Domains
      summary: Get a domain
      x-source: https://faivelo.com/docs/api
      parameters:
      - name: domain
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDomainsDomainResponse'
      x-evidence:
        kind: documentation
security:
- bearer: []
components:
  schemas:
    PostApiPartnerCustomersRequest:
      type: object
      properties:
        email:
          type: string
        companyName:
          type: string
        attestation:
          type: object
          properties:
            firstPartyListsOnly:
              type: boolean
            termsAcceptedOnBehalf:
              type: boolean
    PostApiPartnerCustomersCustomeridDomainsRequest:
      type: object
      properties:
        domain:
          type: string
        brandName:
          type: string
    PostApiPartnerCustomersCustomeridDomainsSmiledentalExampleMa:
      type: object
      properties:
        localPart:
          type: string
        displayName:
          type: string
    PostApiUserApiKeysRequest:
      type: object
      properties:
        kind:
          type: string
          description: Set to "agent" to create an agent key
      required:
      - kind
    PostApiUserApiKeysResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          description: The newly created API key details
    PostApiV1MailboxesRequest:
      type: object
      properties:
        domain:
          type: string
        localPart:
          type: string
        displayName:
          type: string
    PostApiV1MailboxesMyAgentRequest:
      type: object
      properties:
        domain:
          type: string
          description: Domain for the mailbox
        displayName:
          type: string
          description: Human‑readable name for the mailbox
      required:
      - domain
    PostApiV1MailboxesMyAgentResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          description: Created mailbox details
    DeleteCustomersIdResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
    GetCustomersIdResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          description: Customer health information
    PostCustomersIdApiKeysRequest:
      type: object
      properties:
        scopes:
          type: array
          description: Optional list of scopes for the new key
        mailbox:
          type: string
          description: Optional mailbox to bind the key to
    PostCustomersIdApiKeysResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          description: Details of the created API key
    PostCustomersIdDomainsDomainPlanRequest:
      type: object
      properties:
        plan:
          type: string
          description: The new plan name (STARTER, GROWTH, PRO, BUSINESS)
      required:
      - plan
    PostCustomersIdDomainsDomainPlanResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
    PostCustomersIdPlanRequest:
      type: object
      properties:
        plan:
          type: string
          description: The new plan name to apply to all domains
      required:
      - plan
    PostCustomersIdPlanResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
    GetDomainsResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: array
          description: Array of domain objects
    GetDomainsDomainResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          description: Domain details
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
tags:
- name: Api
- name: Customers
- name: Domains