Everframe

Everframe API

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

GitHub OpenAPI

Operations 5

POST /api/cart Breadcrumbs #
GET /api/config GET /api/config returns the settings for the app #
POST /api/ingest POST /api/ingest #
POST /api/v1/tickets POST /api/v1/tickets #
POST /api/v1/tickets/{ticketid}/comments POST /api/v1/tickets/{ticketId}/comments #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/everframe-dev/openapi/_ae-authored/everframe-dev-openapi-generated.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/everframe-dev/json-schema/everframe-dev-get-api-config-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/everframe-dev/json-schema/everframe-dev-post-api-ingest-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/everframe-dev/json-schema/everframe-dev-post-api-v1-tickets-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/everframe-dev/json-schema/everframe-dev-post-api-v1-tickets-response-schema.json

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/everframe-dev:everframe-dev-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

everframe-dev-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Everframe API
  version: '2026-11-07'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-07: 5 operation(s) read from 29 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Everframe has published no machine-readable contract that the
    pipeline could find. Engine: oss.'
  x-evidence-tiers:
    code-example: 3
    documentation: 2
    pages-with-code: 2
    pages-read: 29
  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: oss
  x-sources:
  - https://everframe.dev/docs/api/ingest
  - https://everframe.dev/docs/api/tickets
  - https://everframe.dev/learn/bug-reports-in-jira
  - https://everframe.dev/docs/envelope
  - https://everframe.dev/docs/server-config
  - https://everframe.dev/docs/web/configuration
  - https://everframe.dev/docs/web/breadcrumbs
  - https://everframe.dev/docs/web/session-replay
  - https://everframe.dev/docs/web/network-bodies
  - https://everframe.dev/docs/web/replies
  - https://everframe.dev/docs/web/branding
  - https://everframe.dev/docs/react/configuration
  - https://everframe.dev/docs/react/breadcrumbs
  - https://everframe.dev/docs/react/session-replay
  - https://everframe.dev/docs/react/network-bodies
  - https://everframe.dev/docs/react/replies
  - https://everframe.dev/docs/react/branding
  - https://everframe.dev/docs/react-native/breadcrumbs
  - https://everframe.dev/docs/react-native/session-replay
  - https://everframe.dev/docs/react-native/network-bodies
  - https://everframe.dev/docs/react-native/branding
  - https://everframe.dev/docs/ios/breadcrumbs
  - https://everframe.dev/docs/ios/session-replay
  - https://everframe.dev/docs/ios/network-bodies
  - https://everframe.dev/docs/ios/branding
  - https://everframe.dev/docs/android/breadcrumbs
  - https://everframe.dev/docs/android/session-replay
  - https://everframe.dev/docs/android/network-bodies
  - https://everframe.dev/docs/android/branding
paths:
  /api/cart:
    post:
      operationId: post_api_cart
      tags:
      - Api
      summary: Breadcrumbs
      x-source: https://everframe.dev/docs/react/breadcrumbs
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/config:
    get:
      operationId: get_api_config
      tags:
      - Api
      summary: GET /api/config returns the settings for the app
      description: On start, every SDK calls GET /api/config with its SDK key and gets back the settings for that app, including plan entitlements
        and per‑app policy.
      x-source: https://everframe.dev/docs/server-config
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer token containing the SDK key
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiConfigResponse'
      x-evidence:
        kind: documentation
  /api/ingest:
    post:
      operationId: post_api_ingest
      tags:
      - Api
      summary: POST /api/ingest
      x-source: https://everframe.dev/docs/api/ingest
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiIngestResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://everframe.dev/api/ingest  -H \"Authorization: Bearer $EVERFRAME_SDK_KEY\"  -F ' [email protected] ;type=application/json'\
          \  -F ' [email protected] ;type=image/png' \n Limits \n Limit Value Total request size 25 MB Decompressed envelope 5 MB Parts per request\
          \ 6 (envelope + 5 attachments) Rate limit, per SDK key 60 requests / minute Rate limit, per source IP 200 requests / minute \n T"
  /api/v1/tickets:
    post:
      operationId: post_api_v1_tickets
      tags:
      - Api
      summary: POST /api/v1/tickets
      x-source: https://everframe.dev/docs/api/tickets
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1TicketsRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1TicketsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://everframe.dev/api/v1/tickets  -H \"Authorization: Bearer $EVERFRAME_TOKEN\"  -H \"Content-Type: application/json\"\
          \  -d '{\"title\": \"Checkout crashes on iOS 18\"}' \n Get a token \n Settings → API tokens → Create. An organisation admin role is\
          \ required for\nevery token operation — create, list, rename, re-scope, revoke. \n Each token has: \n A name , up to 80 characters.\
          \ This becomes the "
  /api/v1/tickets/{ticketid}/comments:
    post:
      operationId: post_api_v1_tickets_ticketid_comments
      tags:
      - Api
      summary: POST /api/v1/tickets/{ticketId}/comments
      x-source: https://everframe.dev/docs/api/tickets
      parameters:
      - name: ticketid
        in: path
        required: true
        schema:
          type: string
      - name: projectId
        in: query
        required: false
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \"https://everframe.dev/api/v1/tickets/42/comments?projectId=$PROJECT_ID\"  -H \"Authorization: Bearer $EVERFRAME_TOKEN\"\
          \  -H \"Content-Type: application/json\"  -H \"Idempotency-Key: ci-run-${GITHUB_RUN_ID}-comment\"  -d \"{\\\"body\\\": \\\"Reproduced\
          \ on build 812\\\", \\\"attachmentIds\\\": [\\\"$ID\\\"]}\" \n From the CLI \n The everframe CLI wraps the endpoints above, so you can\
          \ file a ticket or add a\nscree"
components:
  schemas:
    GetApiConfigResponse:
      type: object
      properties:
        replayEnabled:
          type: boolean
          description: Session replay enabled
        replayDurationSec:
          type: integer
          description: Rolling buffer length in seconds
        samplingRate:
          type: number
          description: Fraction of sessions that record at all
        crashOnlySamplingRate:
          type: number
          description: Replay coverage for crash‑only sessions
        resources:
          type: object
          description: Report Resource Window block
        breadcrumbs:
          type: object
          description: Breadcrumbs configuration
        networkBodies:
          type: object
          description: Network bodies capture settings
        replies:
          type: object
          description: Two‑way replies block
        identity:
          type: object
          description: Identity signing secret configuration
        branding:
          type: object
          description: Branding configuration
    PostApiIngestResponse:
      type: object
      properties:
        status:
          type: string
        eventId:
          type: string
        deliveryCount:
          type: integer
        idempotent:
          type: boolean
    PostApiV1TicketsRequest:
      type: object
      properties:
        title:
          type: string
    PostApiV1TicketsResponse:
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api