Metadata Schemas

Get a metadata schema

Returns one declaration by id.

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

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/projects/{project_id}/metadata-schemas/{metadata_schema_id}
  • 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)

Path parameters

metadata_schema_idstring required
Example:mdschema_V1StGXR8Z5jdHi6B

Response

The declaration

idstring

Public ID (mdschema_ prefix)

project_idstring
resource_type'document'

The resource whose metadata this declaration governs.

path_prefixstring

The selector, in the field its resource type is addressed by. A document's is the directory it is filed under.

schemaobject

The declared JSON Schema, as written.

created_atstring date-time
updated_atstring date-time

Example response

{
  "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.