Metadata Schemas

List metadata schemas

Returns the declarations in scope, oldest first. resource_type narrows them to one governed resource.

get/v1/projects/{project_id}/metadata-schemas

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/projects/{project_id}/metadata-schemas
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.naturali.ai/authorize, token URL https://api.naturali.ai/token, scopes: mcp:access)

Query parameters

resource_type'document'

Return only the declarations governing this resource.

limitinteger

Results per page, 1 to 100 (default 50). Above 100 it is clamped; below 1 or not an integer it is 400.

offsetinteger

Results to skip. Negative or not an integer it is 400.

Response

The declarations in scope

totalinteger required
limitinteger required
offsetinteger required

Example response

{
  "data": [
    {
      "id": "mdschema_V1StGXR8Z5jdHi6B",
      "project_id": "proj_V1StGXR8Z5jdHi6B",
      "resource_type": "document",
      "path_prefix": "/reports",
      "schema": {
        "type": "object",
        "required": [
          "quarter"
        ],
        "properties": {
          "quarter": {
            "type": "string"
          }
        }
      },
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-01T00:00:00.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.