Aroai
Get started

Preview tool · Open data

New Zealand dataset details

Preview: Read a New Zealand public dataset listing, including its publisher, licence, available formats and access links.

Use Aroai for freeConnect your client

Published tool ID

nz_dataset_get

Preview: Read a New Zealand public dataset listing, including its publisher, licence, available formats and access links.

PreviewNew ZealandOpen data1 credit
ServerNew Zealand
Information categoryPublic government dataset listings
Credit behavior1 credit
AccessWorkspace permissions

Inputs and outputs

Published input schema

Use the discovered runtime schema for the workspace you are connected to.

Public catalog
nz_dataset_get input schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "detail": {
      "default": "standard",
      "type": "string",
      "enum": [
        "summary",
        "standard",
        "full"
      ]
    },
    "fields": {
      "maxItems": 30,
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[a-zA-Z][a-zA-Z0-9_.-]*$"
      }
    }
  },
  "required": [
    "id",
    "detail"
  ],
  "additionalProperties": false
}

Published output shape

Tool results return structured data or a stable error object.

Shared Aroai tool output schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "summary": {
          "type": "string"
        },
        "data": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {}
        },
        "executionId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([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)$"
        },
        "creditsCharged": {
          "type": "number",
          "minimum": 0
        }
      },
      "required": [
        "summary",
        "data",
        "creditsCharged"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "code": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "retryable": {
              "type": "boolean"
            }
          },
          "required": [
            "code",
            "message",
            "retryable"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "error"
      ],
      "additionalProperties": false
    }
  ]
}

Source and usage notes

Understand the result boundary

  • Costs one credit per lookup, with either Aroai's connection or an eligible workspace key.
  • Use an identifier returned by New Zealand dataset search.
  • Returns listing details and access links, not the dataset file contents.
Explore AU/NZ toolkits

Use this capability

Build on your next business question.

Explore related tools or connect your AI client to get started.

Explore toolsClient setup

Local intelligence. Ready to build.

Put your AI to work.

Create a free workspace and bring local business context into your AI tools.

Use Aroai for freeExplore tools