metadata

Generate adapter metadata

Changed on Sep 9, 2026

Generate adapter Croissant metadata from inline dataset documents, existing server-side dataset metadata files, and/or generated embedded datasets. The endpoint returns metadata without creating a registration.

post/api/v1/metadata/adapters/generate

Request

The document declares no server URL.
Auth: none declared

Request body

namestring required

descriptionstring required

versionstring required

licensestring required

code_repositorystring required

dataset_pathsstring[]

dataset_documentsobject[]

validateboolean

keywordsstring[] required

adapter_idstring nullable

generator'native'

dataset_generator'auto' | 'croissant-baker' | 'native'

Example request

{
  "adapter_id": "people-adapter",
  "code_repository": "https://github.com/example/people-adapter",
  "creators": [
    {
      "affiliation": "Example Lab",
      "creator_type": "Person",
      "email": "creator@example.org",
      "identifier": "https://orcid.org/0000-0000-0000-0000",
      "name": "Example Creator",
      "url": "https://example.org/creator"
    }
  ],
  "dataset_documents": [],
  "dataset_generator": "native",
  "dataset_paths": [],
  "description": "Adapter metadata generated through the API.",
  "generated_datasets": [
    {
      "citation": "https://example.org/people",
      "content_url": "https://example.org/people.csv",
      "creators": [
        {
          "affiliation": "Example Lab",
          "creator_type": "Person",
          "email": "dataset.creator@example.org",
          "identifier": "https://orcid.org/0000-0000-0000-0001",
          "name": "Dataset Creator",
          "url": "https://example.org/dataset-creator"
        }
      ],
      "dataset_version": "1.0.0",
      "date_published": "2026-04-17",
      "description": "Small people dataset.",
      "encoding_format": "text/csv",
      "extra_args": [],
      "filename": "people.csv",
      "input": "/srv/biocypher/examples/adapter-demo",
      "license": "https://opensource.org/licenses/MIT",
      "name": "People Dataset",
      "sha256": "abc123",
      "url": "https://example.org/people",
      "validate": true
    }
  ],
  "generator": "native",
  "keywords": [
    "adapter",
    "biocypher"
  ],
  "license": "https://opensource.org/licenses/MIT",
  "name": "People Adapter",
  "validate": true,
  "version": "1.0.0"
}

Response

Successful Response

metadataobject required

generator'native' required

dataset_generator'auto' | 'croissant-baker' | 'native' required

stdoutstring

stderrstring

warningsstring[]

Changes

Sep 9, 2026e3a3f2ed1d85 Revision changes
- breaking
  added the new required request property //
- breaking
  added the new required request property ////
- breaking
  the / request property type changed from string to object
- breaking
  the /// request property type changed from string to object
- warning
  removed the request property
- warning
  removed the request property
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property
- info
  added the new optional request property //
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
Aug 25, 20265f0a2ae4fe5a Revision changes
- breaking
  the / request property type changed from object to string
- breaking
  the /// request property type changed from object to string
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property
- warning
  removed the request property //
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- info
  added the new optional request property
- info
  added the new optional request property

Operation history (5 revisions)