Scope3

Scope3 Status API

The Status API from Scope3 — 1 operation(s) for status.

GitHub OpenAPI

Specifications

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

OpenAPI Specification

scope3-status-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  version: 1.0.0
  title: AI Impact Measurement Status API
security:
- bearerAuth: []
tags:
- name: Status
paths:
  /status:
    get:
      servers:
      - url: https://aiapi.scope3.com
        description: API server
      operationId: status
      responses:
        '200':
          description: Server is behaving normally
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Status
components:
  schemas:
    Error:
      type: object
      additionalProperties: false
      required:
      - message
      properties:
        code:
          type: string
        message:
          type: string
        details:
          type: object
          properties:
            reason:
              type: string
            field:
              type: string
    StatusResponse:
      title: Status Response
      type: object
      additionalProperties: false
      required:
      - ready
      properties:
        ready:
          type: boolean
        reason:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT