Discovery

Get Manifest Schema for Agent Configuration

Changed on

Returns the complete manifest schema including all resource types, their JSON schemas, dependency graph, and YAML examples. Use this for programmatic manifest generation and validation.

get/v1/discovery/schema

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/discovery/schema
  • Auth: none required

Response

Successful Response

manifest_versionstring required

Current manifest schema version

resource_typesstring[] required

List of supported resource types

schemasobject required

JSON Schema for each resource type

dependency_graphobject required

Resource dependencies (key depends on values)

examplesobject

YAML example for each resource type

example_manifeststring nullable

One complete manifest in YAML that uses parameters, a storage connection with a bucket sync, a seed, collections, a retriever, a taxonomy, a cluster and an acceptance block. It validates as written once its parameters are supplied.

authoring_loopstring[]

The steps to write, check and apply a manifest, in order

extractor_catalogobject[]

Extractors this plane serves: name, version, input types, the feature URIs they write and their parameters with defaults. Use GET /v1/discovery/extractors for the full schemas.

stage_catalogobject[]

Retriever stage ids with category and parameter names. Use GET /v1/discovery/stages for example configurations.

Example response

{
  "dependency_graph": {
    "bucket": [
      "namespace"
    ],
    "collection": [
      "namespace",
      "bucket"
    ],
    "retriever": [
      "namespace",
      "collection"
    ]
  },
  "examples": {
    "namespace": "namespaces:\n  - name: my_ns\n    feature_extractors:\n      - name: multimodal_extractor"
  },
  "manifest_version": "1.0",
  "resource_types": [
    "namespace",
    "bucket",
    "collection",
    "retriever"
  ],
  "schemas": {
    "namespace": {
      "properties": {},
      "type": "object"
    }
  }
}

Changes

  • 790bc16455f6Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 61a175e8eb9aRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status