Skip to main content

Catalog

Discover available signals, deliverable types, serializer formats, and connector types from the delivery registry. Use the catalog to build valid bindings.

The catalog endpoints expose the four delivery registries. Use them to discover which event types, deliverable resolvers, serializer formats, and connectors are available before creating bindings.

Walk the catalog top-down to build valid binding configurations: start with signals to pick an event type, then check which deliverables are compatible with that signal, which serializers support the deliverable shape, and which connectors accept the serializer format. This ensures every combination passes the compatibility triangle.

GET/v1/delivery/catalog/signals

Response

Response fields

typesarrayArray of all known event type strings.
itemsarrayArray of signal objects with label and description.
items[].typestringEvent type identifier (e.g. `document.extracted`).
items[].labelstringHuman-readable label for the event type.
items[].descriptionstringDescription of when this event fires.

Response

{
  "types": ["document.extracted", "run.dataspace.completed", "record.approved"],
  "items": [
    { "type": "document.extracted", "label": "Document extracted", "description": "Fired when document extraction finishes." },
    { "type": "run.dataspace.completed", "label": "Dataspace run completed", "description": "Fired when a structuring run completes." },
    { "type": "record.approved", "label": "Record approved", "description": "Fired when a record passes review." }
  ]
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.
GET/v1/delivery/catalog/deliverables

Response

Response fields

[].typestringDeliverable resolver identifier (e.g. `document_capture`).
[].compatible_signalsarrayEvent types that can route to this resolver.
[].shapeobjectDeliverable shape descriptor with `kind` (`record`, `blob`, `graph`, `envelope`).
[].labelstringHuman-readable label.
[].descriptionstringDescription of what this deliverable resolves.

Response

[
  {
    "type": "document_capture",
    "compatible_signals": ["document.extracted"],
    "shape": { "kind": "record", "is_collection": false, "columns": [] },
    "label": "Document capture",
    "description": "Raw extracted fields for a single document."
  },
  {
    "type": "run_outcomes",
    "compatible_signals": ["run.dataspace.completed"],
    "shape": { "kind": "record", "is_collection": true, "columns": [] },
    "label": "Run outcomes",
    "description": "All structured rows from a completed run."
  }
]

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.
GET/v1/delivery/catalog/serializers

Response

Response fields

[].formatstringSerializer format identifier (e.g. `json`, `csv`, `xlsx`).
[].supports_kindsarrayArray of `DeliverableShape.kind` values this serializer can handle (`record`, `blob`, `graph`, `envelope`).

Response

[
  { "format": "json", "supports_kinds": ["record", "envelope"] },
  { "format": "csv", "supports_kinds": ["record"] },
  { "format": "xlsx", "supports_kinds": ["record"] },
  { "format": "raw", "supports_kinds": ["blob"] }
]

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.
GET/v1/delivery/catalog/connectors

Response

Response fields

[].typestringConnector type (e.g. `webhook`, `s3`, `google_drive`).
[].capabilitiesobjectConnector capabilities object.
[].capabilities.supported_serializersarraySerializer formats this connector accepts.
[].capabilities.supported_deliverable_kindsarrayDeliverable shape kinds supported.
[].capabilities.auth_typesarraySupported authentication types.
[].capabilities.delivery_semanticsstring`record` (per-event) or `file` (file-drop).
[].capabilities.requires_oauthbooleanWhether this connector requires OAuth authorization.

Response

[
  {
    "type": "webhook",
    "capabilities": {
      "supported_serializers": ["json", "ndjson", "raw"],
      "supported_deliverable_kinds": ["envelope", "record", "blob"],
      "auth_types": ["none", "bearer", "basic", "api_key"],
      "delivery_semantics": "record"
    }
  },
  {
    "type": "s3",
    "capabilities": {
      "supported_serializers": ["json", "ndjson", "csv_file", "xlsx", "md", "txt", "raw"],
      "supported_deliverable_kinds": ["record", "blob", "envelope"],
      "auth_types": ["access_key"],
      "delivery_semantics": "file"
    }
  },
  {
    "type": "google_drive",
    "capabilities": {
      "supported_serializers": ["json", "ndjson", "csv_file", "xlsx", "md", "txt", "raw"],
      "supported_deliverable_kinds": ["record", "blob", "envelope"],
      "auth_types": ["oauth_google"],
      "delivery_semantics": "file"
    }
  }
]

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

Create Binding
List Destinations