Console tools

The console home in one read. Queues, money at risk, supplier health, funnel and volume.

Read only.

Resourceresources/read aikonic://console/get_console_home

Arguments

A resource takes no arguments: the agent reads it by its address.

An activity summary of your account.

Read only.

Tool signatureget_console_insights_summary(
  environment?: InsightsEnvironment,
  from?: string,
  supplier?: string,
  to?: string
)
// * required   ? optional

Arguments

• environmentoptional
  InsightsEnvironment Which side of the sandbox/production tenant pairing to read.PRODUCTIONSANDBOXALL
• fromoptional
  string Start of the window: an ISO date (UTC day) or instant.
• supplieroptional
  string Narrow to one supplier code, e.g.
• tooptional
  string End of the window (exclusive): an ISO date (the whole UTC day) or instant.

Your account's orders.

Read only.

Tool signaturelist_console_insights_orders(
  environment?: InsightsEnvironment,
  from?: string,
  limit?: integer,
  state?: string,
  supplier?: string,
  to?: string
)
// * required   ? optional

Arguments

• environmentoptional
  InsightsEnvironment Which side of the sandbox/production tenant pairing to read.PRODUCTIONSANDBOXALL
• fromoptional
  string Start of the window: an ISO date (UTC day) or instant.
• limitoptional
  integer At most this many rows, newest first (1..500, default 100).
• stateoptional
  string Narrow to one order state.
• supplieroptional
  string Narrow to one supplier code, e.g.
• tooptional
  string End of the window (exclusive): an ISO date (the whole UTC day) or instant.

The supplier calls made for your account.

Read only.

Tool signaturelist_console_insights_calls(
  environment?: InsightsEnvironment,
  from?: string,
  limit?: integer,
  operation?: string,
  outcome?: SupplierCallOutcome,
  supplier?: string,
  to?: string
)
// * required   ? optional

Arguments

• environmentoptional
  InsightsEnvironment Which side of the sandbox/production tenant pairing to read.PRODUCTIONSANDBOXALL
• fromoptional
  string Start of the window: an ISO date (UTC day) or instant.
• limitoptional
  integer At most this many rows, newest first (1..500, default 100).
• operationoptional
  string Narrow to one supplier operation, as journalled.
• outcomeoptional
  SupplierCallOutcome Narrow to one call outcome.
• supplieroptional
  string Narrow to one supplier code, e.g.
• tooptional
  string End of the window (exclusive): an ISO date (the whole UTC day) or instant.

One analytics report. Funnel, look-to-book, routes, supplier mix or margin.

Read only.

Tool signatureget_analytics_report(
  credentialSet?: string,
  domain?: string,
  from*: string (date),
  pos?: string,
  report*: ConsoleAnalyticsReportName,
  supplier?: string,
  to*: string (date)
)
// * required   ? optional

Arguments

• credentialSetoptional
  string MONDEE or one of the tenant's own credential-set ids.
• domainoptional
  string Restrict to one product.
• fromrequired
  string (date) First day of the window (inclusive, tenant time zone).
• posoptional
  string Only the bookings of this point-of-sale market.
• reportrequired
  ConsoleAnalyticsReportName The report to read: funnel, l2b, routes, supplier-mix or margin.funnell2broutessupplier-mixmargin
• supplieroptional
  string Only the bookings of this supplier.
• torequired
  string (date) Last day of the window (inclusive); at most 366 days after `from`.

Your usage against your rate limits, per kind of call.

Read only.

Tool signatureget_usage(
  from?: string (date-time),
  granularity*: enum,
  to?: string (date-time)
)
// * required   ? optional

Arguments

• fromoptional
  string (date-time) Default — the last 24 hours (hour) or 30 days (day).
• granularityrequired
  enum The width of each bucket in the series, an hour or a day.hourday
• tooptional
  string (date-time) End of the window; absent means now.

One fulfilment queue, with its claimable items and their deadlines.

Read only.

Tool signatureget_queue(
  assignee?: string,
  page?: integer,
  pageSize?: integer,
  queue*: enum,
  slaState?: ConsoleSlaState
)
// * required   ? optional

Arguments

• assigneeoptional
  string `me` for the caller's claimed rows, a userId, or `unassigned`.
• pageoptional
  integer Page number, 1-based.
• pageSizeoptional
  integer Rows per page, 1..200 (console lists).
• queuerequired
  enum One of the fulfilment queues.ON_REQUEST_AGINGRECONCILIATIONDOC_GEN_FAILEDSCHEDULE_CHANGESOFFLINE_SUPPLIER_ACTIONREQUEST_TO_BOOKVOUCHER_REISSUE
• slaStateoptional
  ConsoleSlaState SLA colouring of a queue row — WITHIN, WARNING (last quarter of the SLA), BREACHED (past slaDueAt).WITHINWARNINGBREACHED

Claim a queue item for yourself.

Makes a change that moves no money. It runs only if an Owner of your account has turned it on for agents and you allowed it when you connected the agent.

Tool signatureclaim_queue_item(
  idempotencyKey*: string (uuid),
  itemId*: string,
  queue*: enum
)
// * required   ? optional

Arguments

• idempotencyKeyrequired
  string (uuid) Mandatory on mutations: **48h TTL**; replay with same body-hash returns the original response with Idempotency-Replayed true; same key + different body is 409 ….
• itemIdrequired
  string A queue row id (ConsoleQueueItem.itemId).
• queuerequired
  enum One of the fulfilment queues.ON_REQUEST_AGINGRECONCILIATIONDOC_GEN_FAILEDSCHEDULE_CHANGESOFFLINE_SUPPLIER_ACTIONREQUEST_TO_BOOKVOUCHER_REISSUE

Release a queue item you claimed.

Makes a change that moves no money. It runs only if an Owner of your account has turned it on for agents and you allowed it when you connected the agent.

Tool signaturerelease_queue_item(
  idempotencyKey*: string (uuid),
  itemId*: string,
  queue*: enum
)
// * required   ? optional

Arguments

• idempotencyKeyrequired
  string (uuid) Mandatory on mutations: **48h TTL**; replay with same body-hash returns the original response with Idempotency-Replayed true; same key + different body is 409 ….
• itemIdrequired
  string A queue row id (ConsoleQueueItem.itemId).
• queuerequired
  enum One of the fulfilment queues.ON_REQUEST_AGINGRECONCILIATIONDOC_GEN_FAILEDSCHEDULE_CHANGESOFFLINE_SUPPLIER_ACTIONREQUEST_TO_BOOKVOUCHER_REISSUE

Escalate a case. It stays open with a new deadline.

Makes a change that moves no money. It runs only if an Owner of your account has turned it on for agents and you allowed it when you connected the agent.

Tool signatureescalate_console_case(
  body*: ConsoleCaseEscalateRequest,
  caseId*: string,
  idempotencyKey*: string (uuid)
)
// * required   ? optional

Arguments

• bodyrequired
  ConsoleCaseEscalateRequest The body of :escalate.

  ConsoleCaseEscalateRequest: 2 fields

  • noterequired
    string Why the case is escalated, for the team that picks it up.
  • slaHoursoptional
    integer New SLA from now; default 4.
• caseIdrequired
  string Case_ + 16 hex characters.
• idempotencyKeyrequired
  string (uuid) Mandatory on mutations: **48h TTL**; replay with same body-hash returns the original response with Idempotency-Replayed true; same key + different body is 409 ….

Your account's AI agents, their autonomy level and whether they are paused.

Read only.

Resourceresources/read aikonic://console/list_agents

Arguments

A resource takes no arguments: the agent reads it by its address.

Booking requests filed by agents, waiting for review or decided.

Read only.

Tool signaturelist_agent_proposals(
  agentId?: string,
  orderRef?: string,
  page?: integer,
  pageSize?: integer,
  state?: ConsoleAgentProposalState
)
// * required   ? optional

Arguments

• agentIdoptional
  string Only the proposals of this agent.
• orderRefoptional
  string Proposals whose resource is this order.
• pageoptional
  integer Page number, 1-based.
• pageSizeoptional
  integer Rows per page, 1..200 (console lists).
• stateoptional
  ConsoleAgentProposalState Only proposals in this state.OPENEXECUTINGAPPROVEDREJECTEDEXPIREDEXECUTION_UNKNOWN

One booking request filed by an agent.

Read only.

Resourceresources/read aikonic://console/get_console_agent_proposal/{proposalId}

Arguments

• proposalIdrequired
  string An agent proposal id.

The suppliers available to your account.

Read only.

Tool signaturelist_console_suppliers(
  domain?: string
)
// * required   ? optional

Arguments

• domainoptional
  string Only suppliers serving this domain.

Your own supplier credentials. Status, health and expiry, never a secret.

Read only.

Tool signaturelist_credential_sets(
  page?: integer,
  pageSize?: integer,
  status?: ConsoleCredentialSetStatus,
  supplier?: string
)
// * required   ? optional

Arguments

• pageoptional
  integer Page number, 1-based.
• pageSizeoptional
  integer Rows per page, 1..200 (console lists).
• statusoptional
  ConsoleCredentialSetStatus Only credential sets in this status.PENDING_VALIDATIONCERTIFYINGACTIVERATE_LIMITEDEXPIRINGREVOKEDFAILED_HEALTH
• supplieroptional
  string Only the credential sets of this supplier.

The certification results of one set of your supplier credentials.

Read only.

Resourceresources/read aikonic://console/get_credential_set_certification/{credentialSetId}

Arguments

• credentialSetIdrequired
  string One of the tenant's own credential-set ids.

Where the fares of one product come from. Your own supplier credentials, the platform's, or both.

Read only.

Resourceresources/read aikonic://console/get_fare_source_config/{domain}

Arguments

• domainrequired
  string Canonical domain code or a registered alias, e.g.

Your supplier datasets at a glance. Freshness, counts, next run and errors.

Read only.

Tool signaturelist_supplier_datasets(
  credentialSet?: string,
  dataset?: string,
  status?: string,
  supplierId?: string,
  vertical?: string
)
// * required   ? optional

Arguments

• credentialSetoptional
  string Only the datasets synced with this credential set; absent means your default set.
• datasetoptional
  string Only this dataset, across suppliers.
• statusoptional
  string FRESH | STALE | FAILING | PAUSED.
• supplierIdoptional
  string Only the datasets of this supplier.
• verticaloptional
  string Only the suppliers of this product, by its product code (for example HTL).

The settings of one supplier data sync.

Read only.

Resourceresources/read aikonic://console/get_supplier_data_profile/{supplierId}/{dataset}{?credentialSet}

Arguments

• credentialSetoptional
  string The credential set the profile belongs to; absent means your default set.
• datasetrequired
  string The dataset the profile syncs, for example catalog_product.
• supplierIdrequired
  string The supplier the profile syncs.

Change the settings of one supplier data sync.

Makes a change that moves no money. It runs only if an Owner of your account has turned it on for agents and you allowed it when you connected the agent.

Tool signatureupdate_supplier_data_profile(
  body*: SupplierDataProfileUpdate,
  dataset*: string,
  idempotencyKey*: string (uuid),
  ifMatch*: string,
  supplierId*: string
)
// * required   ? optional

Arguments

• bodyrequired
  SupplierDataProfileUpdate PUT body — the editable part of a profile; version comes from If-Match.

  SupplierDataProfileUpdate: 6 fields

  • currencyoptional
    string The currency prices are synced in, as an ISO 4217 code.
  • enabledoptional
    boolean False stops scheduled runs of this profile.
  • freshnessoptional
    SupplierDataFreshness How long synced data stays fresh.

    SupplierDataFreshness: 4 fields

    • liveFallbackoptional
      string LIVE_READ | STALE_MARKER | DROP — what search does past maxStaleness.
    • maxStalenessoptional
      string The oldest data may get before it is no longer served, as an ISO 8601 duration.
    • staleWhileRevalidateoptional
      string How long stale data may still be served while a refresh runs, as an ISO 8601 duration.
    • ttloptional
      string How long synced data counts as fresh, as an ISO 8601 duration (for example PT6H).
  • languageoptional
    string The language content is synced in, as a BCP 47 tag.
  • limitsoptional
    object Rate and volume limits for the sync, by name.
  • modesoptional
    array of SupplierDataMode One scheduled mode of a profile.

    SupplierDataMode: 4 fields

    • cronoptional
      string Five-field cron in the profile's time zone; absent for EVENT and ON_DEMAND.
    • moderequired
      string FULL | INCREMENTAL | WINDOW | EVENT | ON_DEMAND; open string.
    • scopeoptional
      object Dataset-specific filters (countries, categories, property ids).
    • windowoptional
      object For WINDOW mode, the days to sync, counted from today.

      3 fields

      • fromOffsetDaysoptional
        integer First day of the window, in days from today.
      • sliceDaysoptional
        integer How many days each request of the run covers.
      • toOffsetDaysoptional
        integer Last day of the window, in days from today.
• datasetrequired
  string The dataset the profile syncs, for example catalog_product.
• idempotencyKeyrequired
  string (uuid) Mandatory on mutations: **48h TTL**; replay with same body-hash returns the original response with Idempotency-Replayed true; same key + different body is 409 ….
• ifMatchrequired
  string The ETag the last read of this profile answered; a stale value changes nothing and answers a conflict.
• supplierIdrequired
  string The supplier the profile syncs.

Start a supplier data sync now.

Makes a change that moves no money. It runs only if an Owner of your account has turned it on for agents and you allowed it when you connected the agent.

Tool signaturestart_supplier_data_run(
  body*: SupplierDataRunRequest,
  idempotencyKey*: string (uuid)
)
// * required   ? optional

Arguments

• bodyrequired
  SupplierDataRunRequest Run now; answers 202 with the run.

  SupplierDataRunRequest: 6 fields

  • credentialSetoptional
    string Absent = MONDEE for an operator, the caller's own set for a tenant.
  • datasetrequired
    string The dataset to sync, for example catalog_product.
  • moderequired
    string How to sync, FULL, INCREMENTAL, WINDOW, EVENT or ON_DEMAND.
  • scopeoptional
    object Dataset-specific filters (countries, categories, property ids).
  • supplierIdrequired
    string The supplier to sync.
  • windowoptional
    DateRange For WINDOW mode, the days to sync.

    DateRange: 2 fields

    • fromrequired
      string (date) First day (inclusive).
    • torequired
      string (date) Last day (inclusive).
• idempotencyKeyrequired
  string (uuid) Mandatory on mutations: **48h TTL**; replay with same body-hash returns the original response with Idempotency-Replayed true; same key + different body is 409 ….

Your supplier data syncs, newest first.

Read only.

Tool signaturelist_supplier_data_runs(
  dataset?: string,
  page?: integer,
  pageSize?: integer,
  status?: string,
  supplierId?: string
)
// * required   ? optional

Arguments

• datasetoptional
  string Only the runs of this dataset.
• pageoptional
  integer Page number, 1-based.
• pageSizeoptional
  integer Rows per page, 1..200 (console lists).
• statusoptional
  string Only runs in this status: QUEUED, RUNNING, PAUSED, SUCCEEDED, PARTIAL, FAILED or CANCELLED.
• supplierIdoptional
  string Only the runs of this supplier.

One supplier data sync. Status, progress and statistics.

Read only.

Resourceresources/read aikonic://console/get_supplier_data_run/{runId}

Arguments

• runIdrequired
  string The run to read, as returned when it started or listed by the run history.

Pause a running supplier data sync.

Makes a change that moves no money. It runs only if an Owner of your account has turned it on for agents and you allowed it when you connected the agent.

Tool signaturepause_supplier_data_run(
  idempotencyKey*: string (uuid),
  runId*: string
)
// * required   ? optional

Arguments

• idempotencyKeyrequired
  string (uuid) Mandatory on mutations: **48h TTL**; replay with same body-hash returns the original response with Idempotency-Replayed true; same key + different body is 409 ….
• runIdrequired
  string The run to pause, as returned when it started or listed by the run history.

Resume a paused supplier data sync from where it stopped.

Makes a change that moves no money. It runs only if an Owner of your account has turned it on for agents and you allowed it when you connected the agent.

Tool signatureresume_supplier_data_run(
  idempotencyKey*: string (uuid),
  runId*: string
)
// * required   ? optional

Arguments

• idempotencyKeyrequired
  string (uuid) Mandatory on mutations: **48h TTL**; replay with same body-hash returns the original response with Idempotency-Replayed true; same key + different body is 409 ….
• runIdrequired
  string The paused run to resume, as returned when it started or listed by the run history.

Cancel a queued, running or paused supplier data sync. What already arrived stays.

Makes a change that moves no money. It runs only if an Owner of your account has turned it on for agents and you allowed it when you connected the agent.

Tool signaturecancel_supplier_data_run(
  idempotencyKey*: string (uuid),
  runId*: string
)
// * required   ? optional

Arguments

• idempotencyKeyrequired
  string (uuid) Mandatory on mutations: **48h TTL**; replay with same body-hash returns the original response with Idempotency-Replayed true; same key + different body is 409 ….
• runIdrequired
  string The run to cancel, as returned when it started or listed by the run history.

The versions of a supplier dataset, newest first.

Read only.

Tool signaturelist_supplier_data_snapshots(
  credentialSet?: string,
  dataset*: string,
  page?: integer,
  pageSize?: integer,
  supplierId*: string
)
// * required   ? optional

Arguments

• credentialSetoptional
  string Only the snapshots synced with this credential set; absent means your default set.
• datasetrequired
  string The dataset whose snapshots are listed, for example catalog_product.
• pageoptional
  integer Page number, 1-based.
• pageSizeoptional
  integer Rows per page, 1..200 (console lists).
• supplierIdrequired
  string The supplier whose snapshots are listed.

What changed between two versions of a supplier dataset.

Read only.

Tool signaturediff_supplier_data_snapshots(
  dataset*: string,
  from*: string,
  page?: integer,
  pageSize?: integer,
  supplierId*: string,
  to*: string
)
// * required   ? optional

Arguments

• datasetrequired
  string The dataset compared, for example catalog_product or property_content.
• fromrequired
  string The older snapshot (its snapshotId).
• pageoptional
  integer Page number, 1-based.
• pageSizeoptional
  integer Rows per page, 1..200 (console lists).
• supplierIdrequired
  string The supplier whose dataset is compared.
• torequired
  string The newer snapshot (its snapshotId).

Every version of your markup rules, newest first.

Read only.

Tool signaturelist_rule_set_versions(
  page?: integer,
  pageSize?: integer
)
// * required   ? optional

Arguments

• pageoptional
  integer Page number, 1-based.
• pageSizeoptional
  integer Rows per page, 1..200 (console lists).

One version of your markup rules, in full.

Read only.

Resourceresources/read aikonic://console/get_rule_set_version/{version}

Arguments

• versionrequired
  integer An immutable rule-set version number.

Send a signed test event to your webhook endpoint.

Makes a change that moves no money. It runs only if an Owner of your account has turned it on for agents and you allowed it when you connected the agent.

Tool signaturetest_webhook(
  body?: ConsoleWebhookTestRequest,
  idempotencyKey*: string (uuid),
  webhookId*: string
)
// * required   ? optional

Arguments

• bodyoptional
  ConsoleWebhookTestRequest Which event to send as the test.

  ConsoleWebhookTestRequest: 1 field

  • typeoptional
    string Webhook.test, or one of the subscription's event types to deliver a fixture sample of (data carries test true).
• idempotencyKeyrequired
  string (uuid) Mandatory on mutations: **48h TTL**; replay with same body-hash returns the original response with Idempotency-Replayed true; same key + different body is 409 ….
• webhookIdrequired
  string The webhookId returned by POST /v1/webhooks.

Send one webhook delivery again, signed with the current secret.

Makes a change that moves no money. It runs only if an Owner of your account has turned it on for agents and you allowed it when you connected the agent.

Tool signaturereplay_webhook_delivery(
  deliveryId*: string,
  idempotencyKey*: string (uuid),
  webhookId*: string
)
// * required   ? optional

Arguments

• deliveryIdrequired
  string The delivery to send again, as the subscription's delivery log lists it.
• idempotencyKeyrequired
  string (uuid) Mandatory on mutations: **48h TTL**; replay with same body-hash returns the original response with Idempotency-Replayed true; same key + different body is 409 ….
• webhookIdrequired
  string The webhookId returned by POST /v1/webhooks.

Your team's users, their roles and status.

Read only.

Tool signaturelist_team_members(
  page?: integer,
  pageSize?: integer,
  status?: enum
)
// * required   ? optional

Arguments

• pageoptional
  integer Page number, 1-based.
• pageSizeoptional
  integer Rows per page, 1..200 (console lists).
• statusoptional
  enum Filter by status (absent = every member).ACTIVEDEACTIVATEDLOCKED

One team member. Roles, permissions and status.

Read only.

Resourceresources/read aikonic://console/get_team_member/{userId}

Arguments

• userIdrequired
  string A tenant user's id (AccessContext.userId).

Outstanding and recent invitations.

Read only.

Tool signaturelist_team_invites(
  page?: integer,
  pageSize?: integer,
  status?: enum
)
// * required   ? optional

Arguments

• pageoptional
  integer Page number, 1-based.
• pageSizeoptional
  integer Rows per page, 1..200 (console lists).
• statusoptional
  enum Only invitations in this status.PENDINGACCEPTEDEXPIREDREVOKED

Your site's brand. Names, logos and colours.

Read only.

Resourceresources/read aikonic://console/get_branding

Arguments

A resource takes no arguments: the agent reads it by its address.

Your console feature flags for one environment.

Read only.

Resourceresources/read aikonic://console/get_feature_flags{?environment}

Arguments

• environmentoptional
  string SANDBOX | PRODUCTION (case-insensitive).

Go-live sign-offs and promotion state.

Read only.

Resourceresources/read aikonic://console/get_go_live

Arguments

A resource takes no arguments: the agent reads it by its address.

A statement for one period, derived from your orders and payments.

Read only.

Tool signatureget_statement(
  model*: ConsoleMoneyModel,
  page?: integer,
  pageSize?: integer,
  period*: string
)
// * required   ? optional

Arguments

• modelrequired
  ConsoleMoneyModel The money model to report: MERCHANT (markup lines), AGENCY (commission lines) or PASS_THROUGH (platform-fee lines).MERCHANTAGENCYPASS_THROUGH
• pageoptional
  integer Page number, 1-based.
• pageSizeoptional
  integer Rows per page, 1..200 (console lists).
• periodrequired
  string Calendar month, YYYY-MM (tenant time zone).

Check a console job, such as a ledger export, until it finishes.

Read only.

Resourceresources/read aikonic://console/get_job/{jobId}

Arguments

• jobIdrequired
  string The job to read, as the call that started it returned it.

Your account's audit log.

Read only.

Tool signaturelist_audit_records(
  action?: string,
  actor?: string,
  from?: string (date-time),
  page?: integer,
  pageSize?: integer,
  ref?: string,
  to?: string (date-time)
)
// * required   ? optional

Arguments

• actionoptional
  string Closed-registry verb, e.g.
• actoroptional
  string Actor.id — a userId, agentId or `system`.
• fromoptional
  string (date-time) Only records at or after this time.
• pageoptional
  integer Page number, 1-based.
• pageSizeoptional
  integer Rows per page, 1..200 (console lists).
• refoptional
  string Resource.ref — an orderRef, credential_set id, ruleset version ….
• tooptional
  string (date-time) Only records before this time.

The seven-check trace of one agent request.

Read only.

Tool signatureget_agent_request_trace(
  requestId*: string
)
// * required   ? optional

Arguments

• requestIdrequired
  string The request id of the traffic row, the X-Request-Id of the call (req_ followed by 26 characters).

One registered agent with versions, keys and domain proof.

Read only.

Tool signatureget_registered_agent(
  agentId*: string
)
// * required   ? optional

Arguments

• agentIdrequired
  string A registered agent id, agt_ followed by a 26-character ULID.

One endpoint, key, rate class or status code over a usage window — the Usage tab's detail.

Read only.

Tool signatureget_usage_detail(
  dimension*: enum,
  from?: string (date-time),
  granularity*: enum,
  id*: string,
  to?: string (date-time)
)
// * required   ? optional

Arguments

• dimensionrequired
  enum What `id` names, an endpoint, an API key, a rate class or a status code.endpointkeyclassstatus
• fromoptional
  string (date-time) Default — the last 24 hours (hour) or 30 days (day).
• granularityrequired
  enum The width of each bucket in the series, an hour or a day.hourday
• idrequired
  string Endpoint — `"METHOD /route/template"` (as ConsoleUsageEndpoint names it); key — the `keyId` of ConsoleUsageKey; class — search | money | reference | account; status — an HTTP status code.
• tooptional
  string (date-time) End of the window; absent means now.

Agent traffic on the tenant's own keys and grants.

Read only.

Tool signaturelist_agent_traffic(
  agentId?: string,
  cursor?: string,
  from?: string (date-time),
  limit?: integer,
  proof?: enum,
  tier?: enum,
  to?: string (date-time)
)
// * required   ? optional

Arguments

• agentIdoptional
  string Only requests stamped with this agent.
• cursoroptional
  string Opaque cursor from the previous page nextCursor; omit for the first page.
• fromoptional
  string (date-time) Start of the window, an ISO 8601 instant; default 24 hours before to.
• limitoptional
  integer Rows per page, 1 to 100; the default is 50.
• proofoptional
  enum Only requests carrying this proof: web-bot-auth, cimd, ans or dns.web-bot-authcimdansdns
• tieroptional
  enum Only requests stamped with this tier, T0 to T3.T0T1T2T3
• tooptional
  string (date-time) End of the window, an ISO 8601 instant; default now.

The tenant's registered agents, newest first.

Read only.

Tool signaturelist_registered_agents(
  cursor?: string,
  limit?: integer,
  suspended?: boolean,
  tier?: enum
)
// * required   ? optional

Arguments

• cursoroptional
  string Opaque cursor from the previous page nextCursor; omit for the first page.
• limitoptional
  integer Rows per page, 1 to 100; the default is 50.
• suspendedoptional
  boolean True lists only suspended agents; false lists only active ones; omitted lists both.
• tieroptional
  enum Only agents at this tier, T0 to T3.T0T1T2T3

Every endpoint, key or 429 burst of a usage window — searchable, filterable, sorted and paged.

Read only.

Tool signaturelist_usage_rows(
  class?: enum,
  cursor?: string,
  dimension*: enum,
  from?: string (date-time),
  limit?: integer,
  q?: string,
  sort?: enum,
  to?: string (date-time)
)
// * required   ? optional

Arguments

• classoptional
  enum Only rows of this rate class.searchmoneyreferenceaccount
• cursoroptional
  string The nextCursor of the previous page; absent for the first page.
• dimensionrequired
  enum What each row is, an endpoint, an API key or a rate-limit event.endpointkeyevent
• fromoptional
  string (date-time) Default — the last 24 hours.
• limitoptional
  integer How many rows to return per page.
• qoptional
  string Only rows whose id matches this text, ignoring case.
• sortoptional
  enum Default — requests (endpoint, key) or recent (event).requestsrateLimitedserverErrorslatencyrecent
• tooptional
  string (date-time) End of the window; absent means now.