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/zvid-io:zvid-io-user-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: Zvid Io User API
  version: 1.1.0
  contact:
    name: Zvid Support
    url: https://zvid.io/contact
  description: 'Operations tagged User across 2 of this provider''s published API definitions: openapi.yaml, zvid-io-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.zvid.io
  description: Production server
security:
- ApiKeyAuth: []
tags:
- name: User
  description: User profile operations
paths:
  /api/user/profile:
    get:
      tags:
      - User
      summary: Get user profile
      description: Retrieve the authenticated user's profile information and credit balance
      operationId: getUserProfile
      responses:
        '200':
          description: User profile retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserProfile'
              example:
                user:
                  id: 123
                  email: user@example.com
                  firstName: John
                  lastName: Doe
                  emailVerified: true
                  profileCompleted: true
                  pendingRedirect: null
                  isAdmin: false
                  createdAt: '2025-01-01T00:00:00.000Z'
                credits:
                  balance: 1800
                  subscriptionCredits: 1200
                  addonCredits:
                    balance: 600
                    totalEarned: 1000
                    totalSpent: 400
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
              example:
                error: Unauthorized
                message: Invalid or missing API key
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserNotFoundError'
              example:
                error: User not found
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Failed to get user profile
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
    servers:
    - url: https://api.zvid.io
      description: Production server
  /api/mcp/preferences:
    get:
      tags:
      - User
      operationId: getMcpPreferences
      summary: Get MCP preferences
      description: Read account defaults used by the hosted MCP service. Change defaults in the dashboard; this REST operation is read-only.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/McpPreferences'
        '400':
          description: Invalid input or semantic validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '404':
          description: Not found for this account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
    servers:
    - url: https://api.zvid.io
      description: Production server
components:
  schemas:
    ValidationError:
      type: object
      properties:
        error:
          type: string
          example: Validation failed
        message:
          type: string
          example: Please check your input and try again
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
                example: name
              message:
                type: string
                example: Name is required
            required:
            - field
            - message
            additionalProperties: false
        planLimits:
          type: object
          description: Present on render validation errors; contains the authenticated user's current render limits.
          additionalProperties: true
      required:
      - error
      additionalProperties: true
    UserNotFoundError:
      type: object
      properties:
        error:
          type: string
          description: Error type
          example: User not found
      required:
      - error
      additionalProperties: false
    UserProfile:
      type: object
      properties:
        user:
          type: object
          properties:
            id:
              type: integer
              example: 123
            email:
              type: string
              format: email
              example: user@example.com
            firstName:
              type: string
              example: John
            lastName:
              type: string
              example: Doe
            emailVerified:
              type: boolean
              example: true
            profileCompleted:
              type: boolean
              example: true
            pendingRedirect:
              type:
              - string
              - 'null'
              example: null
            isAdmin:
              type: boolean
              example: false
            createdAt:
              type: string
              format: date-time
              example: '2025-01-01T00:00:00.000Z'
          required:
          - id
          - email
          - emailVerified
          - createdAt
          additionalProperties: false
        credits:
          $ref: '#/components/schemas/CreditBalance'
        plan:
          type: object
          description: Current plan and enforced account allowances. A null count means unlimited; absent values are unavailable.
          properties:
            name:
              type: string
            isPaid:
              type: boolean
            uploadStorageBytes:
              type:
              - integer
              - 'null'
            maxProjects:
              type:
              - integer
              - 'null'
            maxDesigns:
              type:
              - integer
              - 'null'
            maxApiKeys:
              type:
              - integer
              - 'null'
            maxTemplates:
              type:
              - integer
              - 'null'
            outputRetentionDays:
              type:
              - integer
              - 'null'
            outputRetentionMonths:
              type:
              - integer
              - 'null'
            apiRequestsLimitPerHour:
              type:
              - integer
              - 'null'
            apiRequestsLimitPerMinute:
              type:
              - integer
              - 'null'
          additionalProperties: true
      required:
      - user
      - credits
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error type
        message:
          type: string
          description: Human-readable error message
      required:
      - error
      additionalProperties: true
    AuthenticationError:
      type: object
      properties:
        error:
          type: string
          description: Error type
          example: API key required
        message:
          type: string
          description: Human-readable error message
          example: Please provide an API key in the X-API-Key header or Authorization header
      required:
      - error
      additionalProperties: false
    McpPreferences:
      type: object
      properties:
        defaultProfile:
          enum:
          - creator
          - readonly
          - automation
          - developer
        defaultMaxRenderCredits:
          type: integer
          minimum: 1
          maximum: 10000
        profiles:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              description:
                type: string
            required:
            - id
            - name
            - description
            additionalProperties: true
      required:
      - defaultProfile
      - defaultMaxRenderCredits
      - profiles
      additionalProperties: true
    CreditBalance:
      type: object
      properties:
        balance:
          type: integer
          description: Total available credits from subscription and add-on pools
          example: 1800
        subscriptionCredits:
          type: integer
          description: Credits remaining in the current subscription period
          example: 1200
        addonCredits:
          type: object
          description: Add-on credit pool and historical add-on totals
          properties:
            balance:
              type: integer
              description: Available add-on credits
              example: 600
            totalEarned:
              type: integer
              description: Total add-on credits earned over all time
              example: 1000
            totalSpent:
              type: integer
              description: Total add-on credits spent over all time
              example: 400
          required:
          - balance
          - totalEarned
          - totalSpent
          additionalProperties: false
      required:
      - balance
      - subscriptionCredits
      - addonCredits
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Create one in your dashboard.
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Dashboard JWT in Authorization: Bearer <token>, only on operations that explicitly list this scheme. Prefer x-api-key for REST integrations. OAuth for hosted MCP is a separate connection at https://mcp.zvid.io/mcp.'
x-refined-from:
- openapi.yaml
- zvid-io-openapi.yaml