Scope3 Impact API
The Impact API from Scope3 — 1 operation(s) for impact.
Operations 1
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
The Impact API from Scope3 — 1 operation(s) for impact.
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/scope3:scope3-impact-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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: 3.2.0
info:
version: 1.0.0
title: AI measurement Impact API
security:
- bearerAuth: []
tags:
- name: Impact
paths:
/v1/impact:
post:
servers:
- url: https://aiapi.scope3.com
description: API server
security:
- bearerAuth: []
summary: Get impact metrics for a task
operationId: getImpact
parameters:
- in: query
name: debug
schema:
type: boolean
description: Return debug information
required: false
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ImpactRequest'
responses:
'200':
description: Impact metrics retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ImpactResponse'
'406':
description: Not acceptable response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too many requests
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'415':
description: Unsupported media type
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Impact
components:
schemas:
Model:
title: Model
type: object
required:
- id
- created_at
- updated_at
- created_by
- customer_id
- aliases
additionalProperties: false
properties:
id:
type: string
example: gpt-4-turbo
aliases:
type: array
maxItems: 100
items:
type: string
description: List of aliases for this model; must be globally-unique with id
example:
- claude-latest
- claude-3-sonnet-current
name:
type: string
example: GPT-4 Turbo
family:
type: string
example: gpt
hugging_face_path:
type: string
example: EleutherAI/gpt-neo-2.7B
benchmark_model_id:
type: string
example: GPTJ-6B
total_params_billions:
type: number
example: 175
format: float
x-go-type: float64
number_of_experts:
type: integer
x-go-type: int64
example: 7
params_per_expert_billions:
type: number
example: 8
format: float
x-go-type: float64
tensor_parallelism:
type: integer
example: 1
datatype:
$ref: '#/components/schemas/DataType'
example: fp8
task:
$ref: '#/components/schemas/Task'
example: text-generation
training_usage_energy_kwh:
type: number
example: 1013.1
format: float
x-go-type: float64
training_usage_emissions_kgco2e:
type: number
example: 1013.1
format: float
x-go-type: float64
training_usage_water_l:
type: number
example: 1013.1
format: float
x-go-type: float64
training_embodied_emissions_kgco2e:
type: number
example: 11013.1
format: float
x-go-type: float64
training_embodied_water_l:
type: number
example: 11013.1
format: float
x-go-type: float64
estimated_use_life_days:
type: number
example: 1013.1
format: float
x-go-type: float64
estimated_requests_per_day:
type: number
example: 1013.1
format: float
x-go-type: float64
fine_tuned_from_model_id:
type: string
example: llama_31_8b
customer_id:
type: integer
x-go-type: int64
description: ID of the customer who owns this node (visible to admins only)
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
created_by:
type: string
description: ID of the user who created the node (admin or owner only)
Image:
type: string
example: 1024x1024
pattern: ^(\d{1,4})x(\d{1,4})$
Node:
allOf:
- $ref: '#/components/schemas/NodeCreateRequest'
- type: object
required:
- created_at
- updated_at
properties:
customer_id:
type: integer
x-go-type: int64
description: ID of the customer who owns this node (visible to admins only)
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
created_by:
type: string
description: ID of the user who created the node (admin or owner only)
ImpactResponse:
title: Impact Response
type: object
additionalProperties: false
required:
- rows
- has_errors
properties:
rows:
maxItems: 1000
type: array
items:
$ref: '#/components/schemas/ModeledRow'
total_energy_wh:
type: number
example: 0.13
format: float
x-go-type: float64
total_gco2e:
type: number
example: 0.81
format: float
x-go-type: float64
total_mlh2o:
type: number
example: 1.32
format: float
x-go-type: float64
has_errors:
type: boolean
example: false
NodeCreateRequest:
type: object
required:
- id
- gpu_id
- gpu_count
- cpu_count
description: 'Create a new node.
Note on permissions:
- cloud_instance_id and managed_service_id can only be set by admins or users who own those resources
- Custom nodes are visible only to their owners
- Global nodes are visible to all users
- Admins can see and manage all nodes
'
properties:
id:
type: string
example: my-custom-node-1
pattern: ^[a-z0-9-]+$
minLength: 3
maxLength: 64
cloud_id:
type: string
example: aws
cloud_instance_id:
type: string
example: a2-highgpu-1g
managed_service_id:
type: string
example: aws-bedrock
gpu_id:
type: string
example: a100_40gb
gpu_count:
type: integer
minimum: 0
maximum: 10000
example: 8
x-go-type: int64
cpu_count:
type: integer
minimum: 1
maximum: 10000
example: 2
x-go-type: int64
idle_power_w_ex_gpu:
type: number
example: 100
minimum: 0
maximum: 10000
format: float
x-go-type: float64
average_utilization_rate:
type: number
example: 0.8
format: float
x-go-type: float64
minimum: 0
maximum: 1
embodied_emissions_kgco2e_ex_gpu:
type: number
example: 2500
minimum: 0
maximum: 100000
format: float
x-go-type: float64
embodied_water_l_ex_gpu:
type: number
example: 2500
minimum: 0
maximum: 100000
format: float
x-go-type: float64
use_life_years:
type: number
example: 5
minimum: 1
maximum: 30
format: float
x-go-type: float64
CountryCode:
type: string
pattern: ^[A-Z]{2}$
minLength: 2
maxLength: 2
description: Two-letter country code as defined by ISO 3166-1 alpha-2
example: US
ModeledRow:
type: object
additionalProperties: false
required:
- total_impact
properties:
inference_impact:
$ref: '#/components/schemas/ImpactMetrics'
training_impact:
$ref: '#/components/schemas/ImpactMetrics'
fine_tuning_impact:
$ref: '#/components/schemas/ImpactMetrics'
total_impact:
$ref: '#/components/schemas/ImpactMetrics'
debug:
$ref: '#/components/schemas/DebugInfo'
error:
$ref: '#/components/schemas/Error'
DataType:
type: string
enum:
- fp8
- fp8-e4m3
- fp8-e5m2
- fp16
- tf32
- fp32
- fp64
- bfloat8
- bfloat16
- bf16
- int4
- int8
- int16
- int32
- int64
- uint4
- uint8
- uint16
- uint32
- uint64
ImpactRequest:
title: Impact Request
type: object
additionalProperties: false
required:
- rows
properties:
rows:
type: array
maxItems: 1000
items:
$ref: '#/components/schemas/ImpactRow'
ImpactMetrics:
type: object
additionalProperties: false
required:
- usage_energy_wh
- usage_emissions_gco2e
- usage_water_ml
- embodied_emissions_gco2e
- embodied_water_ml
properties:
usage_energy_wh:
type: number
example: 0.13
format: float
x-go-type: float64
usage_emissions_gco2e:
type: number
example: 0.81
format: float
x-go-type: float64
usage_water_ml:
type: number
example: 1.32
format: float
x-go-type: float64
embodied_emissions_gco2e:
type: number
example: 0.81
format: float
x-go-type: float64
embodied_water_ml:
type: number
example: 1.32
format: float
x-go-type: float64
Task:
type: string
enum:
- text-generation
- chat
- text-embedding
- text-classification
- sentiment-analysis
- named-entity-recognition
- question-answering
- summarization
- translation
- image-classification
- object-detection
- image-segmentation
- image-generation
- image-to-text
- text-to-image
- style-transfer
- face-detection
- facial-recognition
- speech-to-text
- text-to-speech
- speaker-identification
- audio-classification
- music-generation
- multimodal-embedding
- multimodal-generation
- visual-question-answering
- recommendation-system
- reinforcement-learning
- anomaly-detection
- time-series-forecasting
- clustering
description: 'Common types of AI/ML models and their primary functions:
- Text-based models for natural language processing
- Vision models for image analysis and generation
- Audio models for speech and sound processing
- Multimodal models that combine different types of inputs/outputs
- Specialized models for specific use cases
'
DebugInfo:
type: object
additionalProperties: false
properties:
model:
$ref: '#/components/schemas/Model'
hardware_node:
$ref: '#/components/schemas/Node'
grid_mix:
$ref: '#/components/schemas/GridMix'
steps:
type: array
maxItems: 100
items:
$ref: '#/components/schemas/PredictionStep'
PredictionStep:
type: object
additionalProperties: false
required:
- description
- duration_ms
- inferences
properties:
description:
type: string
duration_ms:
type: number
format: float
x-go-type: float64
inferences:
type: integer
x-go-type: int64
GridMix:
type: object
additionalProperties: false
required:
- country
- gco2e_per_kwh
properties:
country:
$ref: '#/components/schemas/CountryCode'
region:
$ref: '#/components/schemas/RegionCode'
gco2e_per_kwh:
type: number
example: 475
format: float
x-go-type: float64
minimum: 0
maximum: 2000
ImpactRow:
type: object
additionalProperties: false
properties:
utc_datetime:
description: The start time of the request in UTC
type: string
format: date-time
example: '2022-01-01T00:00:00Z'
request_duration_ms:
type: number
format: float
x-go-type: float64
description: The time the request took (as measured by client or proxy)
example: 283
processing_duration_ms:
type: number
format: float
x-go-type: float64
description: The time taken in processing the request (as measured at execution)
example: 238
request_cost:
type: number
format: float
x-go-type: float64
description: The cost to execute this request
example: 0.18
currency:
type: string
description: The currency for the cost data
example: USD
integration_source:
type: string
description: The integration used to source the data
example: litellm
environment:
type: string
description: Environment (prod/production indicates production)
example: staging
session_id:
type: string
description: The ID of the session (multiple requests)
trace_id:
type: string
description: The trace ID of the request (multiple requests in one task)
request_id:
type: string
description: The unique identifier of this request
client_id:
type: string
description: The client to attribute this call to
project_id:
type: string
description: The project to attribute this call to
application_id:
type: string
description: The application to attribute this call to
model_id:
type: string
description: The ID of the model requested
example: llama_31_8b
model_family:
type: string
description: The family of the model
example: llama
model_name:
type: string
description: The name of the model
example: LLaMa v3.1 8B
model_hugging_face_path:
type: string
description: The Hugging Face path of the model
example: meta/llama31_8b
model_used_id:
type: string
description: The ID of the model that did the inference
example: llama_31_8b_0125
cloud_region:
type: string
description: The region of cloud hosting
example: us-central1
managed_service_id:
type: string
description: The ID of a managed service provider
example: aws-bedrock
cloud_id:
type: string
description: The ID of the cloud
example: aws
cloud_instance_id:
type: string
description: The instance type in the cloud
example: p4d.24xlarge
node_id:
type: string
description: The ID of a custom or global node
example: aws:p4d.24xlarge
country:
$ref: '#/components/schemas/CountryCode'
region:
$ref: '#/components/schemas/RegionCode'
task:
$ref: '#/components/schemas/Task'
example: text-generation
input_tokens:
type: integer
x-go-type: int64
description: the number of input (or prompt) tokens
minimum: 0
maximum: 100000000
example: 128
input_audio_seconds:
type: number
format: float
x-go-type: float64
description: the duration of audio input in seconds
minimum: 0
maximum: 100000
example: 60
output_tokens:
type: integer
x-go-type: int64
description: the number of output (or completion) tokens
example: 128
minimum: 0
maximum: 100000000
input_images:
type: array
maxItems: 100
items:
$ref: '#/components/schemas/Image'
input_steps:
type: integer
x-go-type: int64
description: the number of steps to use in the model
minimum: 1
maximum: 10000
example: 50
output_images:
type: array
description: a list of output image sizes
maxItems: 100
items:
$ref: '#/components/schemas/Image'
output_audio_seconds:
type: number
format: float
x-go-type: float64
description: the duration of audio output in seconds
minimum: 0
maximum: 100000
example: 60
output_audio_tokens:
type: integer
x-go-type: int64
description: the number of audio tokens in the output
minimum: 0
maximum: 100000000
example: 2300
output_video_frames:
type: integer
x-go-type: int64
description: the number of video frames (frame rate x duration)
minimum: 0
maximum: 100000000
example: 60
output_video_resolution:
type: integer
x-go-type: int64
description: the resolution of the video in number of lines (for instance, 1080 for 1080p)
example: 1080
Error:
type: object
additionalProperties: false
required:
- message
properties:
code:
type: string
message:
type: string
details:
type: object
properties:
reason:
type: string
field:
type: string
RegionCode:
type: string
pattern: ^[A-Z]{2}$
minLength: 2
maxLength: 2
description: Two-letter region code as defined by ISO 3166-1 alpha-2
example: NY
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT