ReadMe

ReadMe Images API

Upload and manage images

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.readme.com/main/reference/intro-to-the-readme-api
📖
Authentication
https://docs.readme.com/main/reference/authentication
📖
Documentation
https://docs.readme.com/main/docs/sending-api-logs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/openapi/readme-images-api-openapi.yml

Other Resources

🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/readme/refs/heads/main/graphql/readme-graphql.md
🔗
SDKs
https://github.com/readmeio/metrics-sdks

OpenAPI Specification

readme-images-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: ReadMe Developer Metrics Analytics Images API
  description: The ReadMe Developer Metrics API powers the Developer Dashboard. It accepts API request logs from Metrics SDKs (Node.js, Python, Ruby, PHP, .NET) and exposes analytics including page quality scores, page view statistics, and search analytics so teams can investigate API usage by key or email and debug requests in real time.
  version: '1.0'
  contact:
    name: ReadMe Support
    url: https://docs.readme.com
servers:
- url: https://metrics.readme.io/v1
  description: ReadMe Metrics API
security:
- basicAuth: []
tags:
- name: Images
  description: Upload and manage images
paths:
  /images:
    post:
      tags:
      - Images
      summary: Upload An Image
      responses:
        '201':
          description: Image uploaded
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic auth using your ReadMe API key as the username (password blank).