POST
/
Calculate AI model impact metrics for BigQuery
curl --request POST \
  --url https://aiapi.scope3.com/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "requestId": "124ab1c",
  "caller": "//bigquery.googleapis.com/projects/myproject/jobs/myproject:US.bquxjob_5b4c112c_17961fafeaf",
  "sessionUser": "user@company.com",
  "userDefinedContext": {},
  "calls": [
    [
      "gpt-4-turbo",
      "2024-03-15T10:30:00Z",
      "us-central1",
      "US",
      "CA",
      "text-generation",
      100,
      50,
      null
    ]
  ]
}'
{
  "replies": [
    "<string>"
  ],
  "errorMessage": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
requestId
string
required

Unique identifier for the request

Example:

"124ab1c"

​
caller
string
required

Full resource name of the BigQuery job

Example:

"//bigquery.googleapis.com/projects/myproject/jobs/myproject:US.bquxjob_5b4c112c_17961fafeaf"

​
sessionUser
string
required

Email of the user executing the BigQuery query

Example:

"user@company.com"

​
calls
(string | integer)[][]
required
Maximum length: 1000
​
userDefinedContext
object

User-defined context from BigQuery

Response

Impact metrics calculated successfully

​
replies
string[]
required

Array of impact metric results

Maximum length: 1000
​
errorMessage
string