omniyond-com Utility API

Standalone paid utility endpoints.

Operations 9

GET /v1/hello Paid hello-world #
POST /v1/qr Generate a QR code (SVG) #
POST /v1/og-image Render a social (OG) image #
POST /v1/pdf Render a PDF #
POST /v1/screenshot Take a screenshot #
POST /v1/extract Extract a web page #
GET /v1/files/{token} Fetch a generated file #

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/omniyond-com:omniyond-com-utility-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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

omniyond-com-utility-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Omniyond Com Utility API
  version: 1.0.0
  contact:
    name: Omniyond
    url: https://omniyond.com
  description: 'Operations tagged utility across 2 of this provider''s published API definitions: omniyond-com-openapi.yml, omniyond.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://omniyond.com
  description: Production
security:
- ApiKeyAuth: []
- x402: []
tags:
- name: Utility
  description: Standalone paid utility endpoints.
paths:
  /v1/hello:
    get:
      tags:
      - Utility
      operationId: hello
      summary: Paid hello-world
      description: Minimal paid endpoint for testing the payment flow. $0.001 per call.
      responses:
        '200':
          description: Greeting.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: hello, agent
                  payer:
                    type: string
                  paidWith:
                    type: string
                    enum:
                    - credits
                    - x402
                  timestamp:
                    type: string
                    format: date-time
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://omniyond.com
      description: Production
  /v1/qr:
    post:
      tags:
      - Utility
      operationId: qr
      summary: Generate a QR code (SVG)
      description: Returns an SVG QR code (image/svg+xml). $0.01 per call.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: string
                  maxLength: 2048
                  description: Text or URL to encode.
                ecc:
                  type: string
                  enum:
                  - L
                  - M
                  - Q
                  - H
                  default: M
                  description: Error-correction level.
                border:
                  type: integer
                  minimum: 0
                  maximum: 20
                  default: 2
                  description: Quiet-zone border in modules.
      responses:
        '200':
          description: SVG QR code.
          content:
            image/svg+xml:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/ValidationError'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://omniyond.com
      description: Production
  /v1/og-image:
    post:
      tags:
      - Utility
      operationId: ogImage
      summary: Render a social (OG) image
      description: Renders a PNG (default 1200x630) from a title, description and theme; returns a hosted URL. $0.01 per call.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - title
              properties:
                title:
                  type: string
                  maxLength: 200
                description:
                  type: string
                  maxLength: 300
                theme:
                  type: string
                  enum:
                  - dark
                  - light
                  default: dark
                width:
                  type: integer
                  minimum: 400
                  maximum: 2000
                  default: 1200
                height:
                  type: integer
                  minimum: 200
                  maximum: 2000
                  default: 630
      responses:
        '200':
          description: Hosted image URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoredFile'
        '400':
          $ref: '#/components/responses/ValidationError'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://omniyond.com
      description: Production
  /v1/pdf:
    post:
      tags:
      - Utility
      operationId: pdf
      summary: Render a PDF
      description: Renders a PDF from raw HTML or a URL (SSRF-protected); returns a hosted URL. $0.02 per call.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                html:
                  type: string
                  maxLength: 500000
                  description: Raw HTML. Provide exactly one of html or url.
                url:
                  type: string
                  format: uri
                  description: URL to render. Provide exactly one of html or url.
                format:
                  type: string
                  enum:
                  - A4
                  - Letter
                  - Legal
                  default: A4
                landscape:
                  type: boolean
                  default: false
      responses:
        '200':
          description: Hosted PDF URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoredFile'
        '400':
          $ref: '#/components/responses/ValidationError'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/HostUnresolvable'
    servers:
    - url: https://omniyond.com
      description: Production
  /v1/screenshot:
    post:
      tags:
      - Utility
      operationId: screenshot
      summary: Take a screenshot
      description: Takes a PNG screenshot of a URL (SSRF-protected) or raw HTML, either the viewport or the full scrollable page; returns a hosted URL. $0.01 per call.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                html:
                  type: string
                  maxLength: 500000
                  description: Raw HTML. Provide exactly one of html or url.
                url:
                  type: string
                  format: uri
                  maxLength: 2048
                  description: URL to capture. Provide exactly one of html or url.
                width:
                  type: integer
                  minimum: 200
                  maximum: 2000
                  default: 1280
                  description: Viewport width in pixels.
                height:
                  type: integer
                  minimum: 200
                  maximum: 2000
                  default: 800
                  description: Viewport height in pixels.
                fullPage:
                  type: boolean
                  default: false
                  description: Capture the whole scrollable page instead of only the viewport.
      responses:
        '200':
          description: Hosted image URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoredFile'
        '400':
          $ref: '#/components/responses/ValidationError'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/HostUnresolvable'
    servers:
    - url: https://omniyond.com
      description: Production
  /v1/extract:
    post:
      tags:
      - Utility
      operationId: extract
      summary: Extract a web page
      description: Renders a URL in a real headless browser (handles JS-heavy pages) and extracts it as clean markdown, rendered HTML, or a list of links. SSRF-protected. $0.01 per call.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - url
              properties:
                url:
                  type: string
                  format: uri
                  maxLength: 2048
                format:
                  type: string
                  enum:
                  - markdown
                  - content
                  - links
                  default: markdown
                  description: markdown = clean LLM-ready markdown; content = rendered HTML; links = list of links.
                visibleLinksOnly:
                  type: boolean
                  default: false
                  description: 'For format=links: only links visible on the page.'
                excludeExternalLinks:
                  type: boolean
                  default: false
                  description: 'For format=links: exclude links to external domains.'
      responses:
        '200':
          description: Extracted page. Fields depend on format.
          content:
            application/json:
              schema:
                type: object
                properties:
                  format:
                    type: string
                    enum:
                    - markdown
                    - content
                    - links
                  url:
                    type: string
                    format: uri
                  markdown:
                    type: string
                    description: Present when format=markdown.
                  html:
                    type: string
                    description: Present when format=content.
                  title:
                    type: string
                    description: Present when format=content.
                  status:
                    type: integer
                    description: Rendered page HTTP status; present when format=content.
                  links:
                    type: array
                    items:
                      type: string
                    description: Present when format=links.
        '400':
          $ref: '#/components/responses/ValidationError'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/HostUnresolvable'
    servers:
    - url: https://omniyond.com
      description: Production
  /v1/link:
    post:
      tags:
      - Utility
      operationId: createLink
      summary: Create a short link
      description: Creates a short link that 302-redirects to the target (SSRF-protected) and counts clicks. Redirect served at /l/{slug}. $0.01 per call.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - url
              properties:
                url:
                  type: string
                  format: uri
                  maxLength: 2048
                slug:
                  type: string
                  pattern: ^[a-zA-Z0-9_-]{3,40}$
                  description: Optional custom slug; random if omitted.
                expiresInDays:
                  type: integer
                  minimum: 1
                  maximum: 365
      responses:
        '200':
          description: Short link created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  slug:
                    type: string
                  url:
                    type: string
                    format: uri
                  target:
                    type: string
                    format: uri
                  expiresAt:
                    type: string
                    format: date-time
                    nullable: true
        '400':
          $ref: '#/components/responses/ValidationError'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '409':
          description: Slug already taken.
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://omniyond.com
      description: Production
  /v1/link/{slug}:
    get:
      tags:
      - Utility
      operationId: getLink
      summary: Get a short link's stats
      description: Returns the target, total click count and expiry for a short link you created. API key only — the link must belong to your project.
      security:
      - ApiKeyAuth: []
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Link details.
          content:
            application/json:
              schema:
                type: object
                properties:
                  slug:
                    type: string
                  url:
                    type: string
                    format: uri
                  target:
                    type: string
                    format: uri
                  clicks:
                    type: integer
                  createdAt:
                    type: string
                    format: date-time
                  expiresAt:
                    type: string
                    format: date-time
                    nullable: true
        '404':
          $ref: '#/components/responses/NotFound'
    servers:
    - url: https://omniyond.com
      description: Production
  /v1/files/{token}:
    get:
      tags:
      - Utility
      operationId: getFile
      summary: Fetch a generated file
      description: Fetches a file produced by og-image, pdf or screenshot. The token is the capability — no auth required. Cached 24h.
      security: []
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The stored file (image/png or application/pdf).
        '404':
          description: File not found or expired.
    servers:
    - url: https://omniyond.com
      description: Production
components:
  responses:
    ValidationError:
      description: Invalid request (bad schedule, SSRF-blocked URL, missing callbackUrl, etc.). A body that fails the schema gets this before any charge or 402 challenge, with `statusMessage` "Validation Error" and the issues in `message`.
      content:
        application/json:
          schema:
            type: object
            properties:
              statusMessage:
                type: string
              message:
                type: string
    HostUnresolvable:
      description: The URL's host could not be resolved (DNS lookup failed or returned nothing). Transient — retry.
      content:
        application/json:
          schema:
            type: object
            properties:
              statusMessage:
                type: string
                example: Could not resolve the URL host; retry shortly.
    PaymentRequired:
      description: 'Payment required. For x402, the payment requirements are in the

        `payment-required` response header and the body links the docs. For an

        API key with insufficient credits, the body is an InsufficientCredits

        object. Either way the body links this spec and /llms.txt.

        '
      headers:
        payment-required:
          description: Base64-encoded x402 PaymentRequirements (x402 path only).
          schema:
            type: string
      content:
        application/json:
          schema:
            oneOf:
            - $ref: '#/components/schemas/DiscoveryLinks'
            - $ref: '#/components/schemas/InsufficientCredits'
    NotFound:
      description: Job not found, or not owned by this API key.
      content:
        application/json:
          schema:
            type: object
            properties:
              statusMessage:
                type: string
                example: Job not found
    RateLimited:
      description: Too many requests. Retry after the `Retry-After` header.
      headers:
        Retry-After:
          schema:
            type: integer
      content:
        application/json:
          schema:
            type: object
            properties:
              statusMessage:
                type: string
              data:
                type: object
                properties:
                  retryAfterSeconds:
                    type: integer
  schemas:
    PaymentReceipt:
      type: object
      description: Present on x402-paid responses.
      properties:
        payer:
          type: string
        transaction:
          type: string
        network:
          type: string
    StoredFile:
      type: object
      description: A generated file hosted at /v1/files/{token}.
      properties:
        url:
          type: string
          format: uri
        width:
          type: integer
        height:
          type: integer
        payment:
          $ref: '#/components/schemas/PaymentReceipt'
    DiscoveryLinks:
      type: object
      properties:
        docs:
          type: string
          format: uri
          example: https://omniyond.com/llms.txt
        openapi:
          type: string
          format: uri
          example: https://omniyond.com/openapi.yaml
    InsufficientCredits:
      allOf:
      - $ref: '#/components/schemas/DiscoveryLinks'
      - type: object
        properties:
          error:
            type: string
            example: insufficient_credits
          message:
            type: string
          requiredMicrousd:
            type: integer
          balanceMicrousd:
            type: integer
          buyCreditsUrl:
            type: string
            format: uri
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: omni_*
      description: Prepaid-credit API key. Create one in the Omniyond dashboard.
    x402:
      type: apiKey
      in: header
      name: X-PAYMENT
      description: 'x402 pay-per-call. Omit the API key to receive a `402` with payment

        requirements in the `payment-required` response header, then pay and

        resend with the `X-PAYMENT` header. USDC on Base.

        '
x-refined-from:
- omniyond-com-openapi.yml
- omniyond.yaml