Skip to content

API Reference

NEMAR CLI communicates with the NEMAR API. This reference is for advanced users.

https://api.nemar.org

All authenticated endpoints require:

Authorization: Bearer nemar_your_api_key
MethodEndpointDescription
POST/auth/loginValidate API key
POST/auth/signupRegister new user
POST/auth/resend-verificationResend email verification
POST/auth/retrieve-keyRetrieve API key (email + password)
POST/auth/request-key-regenerationRequest key regeneration
GET/auth/confirm-key-regenerationConfirm key regeneration
MethodEndpointDescription
GET/users/meGet current authenticated user (Bearer token)
GET/users/me/datasetsList the current user’s datasets
MethodEndpointDescription
GET/datasetsList datasets
GET/datasets/searchFull-text and semantic dataset search (?q=)
GET/datasets/resolve/:sourceIdResolve a source ID (e.g. OpenNeuro accession) to a NEMAR dataset
GET/datasets/:idGet dataset details
POST/datasetsCreate dataset
POST/datasets/:id/upload-urlsGet presigned URLs for direct file upload
POST/datasets/:id/upload-credentialsGet temporary S3 credentials for upload
POST/datasets/:id/download-credentialsGet temporary S3 credentials for download
GET/datasets/:id/manifestGet the latest version manifest
GET/datasets/:id/versionsList dataset versions
POST/datasets/:id/publish/requestRequest publication of a dataset
GET/datasets/:id/publish/statusCheck publication request status
MethodEndpointDescription
GET/sandbox/statusCheck sandbox training status
POST/sandbox/completeMark sandbox training complete
POST/sandbox/resetReset sandbox training
MethodEndpointDescription
GET/admin/usersList users (includes pending approvals)
GET/admin/users/:usernameGet a single user
POST/admin/approve/:usernameApprove a pending user
POST/admin/revoke/:usernameRevoke a user’s access
GET/admin/datasets/:id/doiGet DOI info for a dataset
POST/admin/datasets/:id/doi/conceptCreate concept DOI
POST/admin/datasets/:id/doi/updateUpdate DOI metadata
GET/admin/publish/requestsList publication requests
POST/admin/publish/:id/approveApprove and publish a dataset
POST/admin/publish/:id/denyDeny a publication request
DELETE/admin/datasets/:idDelete a dataset and all its resources
{
"error": "Error message",
"details": ["Additional information"]
}
CodeMeaning
200Success
400Bad request
401Unauthorized
403Forbidden
404Not found
500Server error