zvid-io

zvid-io API Keys API

API key management operations

Documentation GitHub OpenAPI

Operations 5

GET /api/api-keys List API keys #

POST /api/api-keys Create API key #

PUT /api/api-keys/{id} Update API key #

DELETE /api/api-keys/{id} Revoke API key #

GET /api/api-keys/{id}/stats Get API key statistics #

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/zvid-io:zvid-io-api-keys-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 API Keys API
  version: 1.1.0
  contact:
    name: Zvid Support
    url: https://zvid.io/contact
  description: 'Operations tagged API Keys 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: API Keys
  description: API key management operations
paths:
  /api/api-keys:
    get:
      tags:
      - API Keys
      summary: List API keys
      description: Retrieve all active API keys for the authenticated user
      operationId: listApiKeys
      responses:
        '200':
          description: API keys retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyList'
              example:
                apiKeys:
                - id: 789
                  name: Production API Key
                  keyPrefix: zvid_d3f4a1b2c3d
                  createdAt: '2025-01-01T00:00:00.000Z'
                  lastUsedAt: '2025-01-15T10:30:00.000Z'
                  requestsCount: 150
                  isActive: true
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
    post:
      tags:
      - API Keys
      summary: Create API key
      description: Generate a new API key for the authenticated user
      operationId: createApiKey
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 100
                  description: Name for the API key
                  example: Production API Key
            example:
              name: Production automation
      responses:
        '201':
          description: API key created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyCreated'
              example:
                id: 789
                apiKey: zvid_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
                name: Production API Key
                keyPrefix: zvid_d3f4a1b2c3d
                created: true
        '400':
          description: Validation error or business error (e.g. duplicate name)
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ValidationError'
                - $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
    servers:
    - url: https://api.zvid.io
      description: Production server
  /api/api-keys/{id}:
    put:
      tags:
      - API Keys
      summary: Update API key
      description: Rename an active API key belonging to the authenticated user
      operationId: updateApiKey
      parameters:
      - name: id
        in: path
        required: true
        description: API key ID
        schema:
          type: integer
          example: 789
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 100
                  description: New name for the API key
                  example: Production API Key
            example:
              name: Updated automation
      responses:
        '200':
          description: API key updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: API key name updated successfully
                required:
                - success
                - message
                additionalProperties: false
        '400':
          description: Invalid ID, validation error, duplicate name, API key not found, or operation failed
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ValidationError'
                - $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
    delete:
      tags:
      - API Keys
      summary: Revoke API key
      description: Revoke (delete) an API key belonging to the authenticated user
      operationId: revokeApiKey
      parameters:
      - name: id
        in: path
        required: true
        description: API key ID
        schema:
          type: integer
          example: 789
      responses:
        '200':
          description: API key revoked successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: API key revoked successfully
                required:
                - success
                - message
        '400':
          description: Invalid ID, API key not found, or operation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
    servers:
    - url: https://api.zvid.io
      description: Production server
  /api/api-keys/{id}/stats:
    get:
      tags:
      - API Keys
      summary: Get API key statistics
      description: Retrieve usage statistics for a specific API key, based on audit logs, for a given timeframe
      operationId: getApiKeyStats
      parameters:
      - name: id
        in: path
        required: true
        description: API key ID
        schema:
          type: integer
          example: 789
      - name: timeframe
        in: query
        description: 'Timeframe for statistics. Supported values: 24h, 7d, 30d (default: 30d).'
        schema:
          type: string
          enum:
          - 24h
          - 7d
          - 30d
          default: 30d
          example: 30d
      responses:
        '200':
          description: API key statistics retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyStats'
              example:
                timeframe: 30d
                summary:
                  totalRequests: 1500
                  successfulRequests: 1400
                  failedRequests: 100
                  avgResponseTime: 120.5
                dailyStats:
                - date: '2025-01-01'
                  requests: 50
                  successful: 48
                  failed: 2
                - date: '2025-01-02'
                  requests: 75
                  successful: 70
                  failed: 5
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
    servers:
    - url: https://api.zvid.io
      description: Production server
components:
  schemas:
    ApiKey:
      type: object
      properties:
        id:
          type: integer
          example: 729
        name:
          type: string
          example: Production API Key
        keyPrefix:
          type: string
          description: Stored prefix of the key (first characters, used for identification)
          example: zvid_d3f4a1b2c3d
        createdAt:
          type: string
          format: date-time
          example: '2025-01-01T00:00:00.000Z'
        lastUsedAt:
          type:
          - string
          - 'null'
          format: date-time
          example: '2025-01-15T10:30:00.000Z'
        requestsCount:
          type: integer
          description: Total number of requests made with this key
          example: 150
        isActive:
          type: boolean
          description: Whether the key is active (this list only returns active keys)
          example: true
      required:
      - id
      - name
      - keyPrefix
      - createdAt
      - requestsCount
      - isActive
      additionalProperties: false
    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
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error type
        message:
          type: string
          description: Human-readable error message
      required:
      - error
      additionalProperties: true
    ApiKeyList:
      type: object
      properties:
        apiKeys:
          type: array
          items:
            $ref: '#/components/schemas/ApiKey'
      required:
      - apiKeys
      additionalProperties: false
    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
    ApiKeyCreated:
      type: object
      properties:
        id:
          type: integer
          example: 729
        apiKey:
          type: string
          description: Full API key (only shown once)
          example: zvid_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
        name:
          type: string
          example: Production API Key
        keyPrefix:
          type: string
          description: Stored prefix derived from the key
          example: zvid_d3f4a1b2c3d
        created:
          type: boolean
          example: true
      required:
      - id
      - apiKey
      - name
      - keyPrefix
      - created
      additionalProperties: false
    ApiKeyStats:
      type: object
      properties:
        timeframe:
          type: string
          enum:
          - 24h
          - 7d
          - 30d
          example: 30d
        summary:
          type: object
          description: Aggregated statistics for the selected timeframe
          properties:
            totalRequests:
              type: integer
              example: 1500
            successfulRequests:
              type: integer
              example: 1400
            failedRequests:
              type: integer
              example: 100
            avgResponseTime:
              type: number
              example: 120.5
          required:
          - totalRequests
          - successfulRequests
          - failedRequests
          additionalProperties: false
        dailyStats:
          type: array
          description: Daily request breakdown over the last 30 days
          items:
            type: object
            properties:
              date:
                type: string
                format: date
                example: '2025-01-01'
              requests:
                type: integer
                example: 100
              successful:
                type: integer
                example: 95
              failed:
                type: integer
                example: 5
            required:
            - date
            - requests
            - successful
            - failed
            additionalProperties: false
      required:
      - timeframe
      - summary
      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