/api/v1/ai/explain

GET

/api/v1/ai/explain

const url = 'https://example.com/api/v1/ai/explain?scope=me';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/ai/explain?scope=me'

Parameters

Query Parameters

scope

string

default: me

Allowed values: me location account instance

locationId

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

200

Default Response

application/json

object

actions

required

Array<object>

object

task

required

string

callsPerAction

required

number

tokensTypical

required

number

costTypical

object

currency

required

string

amount

required

string

basis

required

string

Allowed values: history reference

referenceDate

string

projection

required

object

days

required

number

calls

required

number

tokens

required

number

cost

required

Array<object>

object

currency

required

string

amount

required

string

unknownCostCalls

required

number

Example

{
  "actions": [
    {
      "basis": "history"
    }
  ]
}