Examples of Neurelo Auto-Generated REST API endpoints


Neurelo auto-generates a rich set of REST API endpoints from your schema for the project.

The API endpoints comprise of -

  1. GET method endpoints to retrieve data

  2. POST method endpoints to add new data

  3. PATCH method endpoints to update data

  4. DELETE method endpoints to delete data

These endpoints support a rich set of filters, aggregation, sorting, pagination and other operations.

These endpoints allow you to take action on a single object or across multiple objects in a single call, using any specified references between them (e.g. relationships, embedded documents).

The endpoints are reachable at https://$ENV_API_URL/rest/

  • $ENV_API_URL can be retrieved from the Neurelo environment in the project you want to use. This path will be different depending on the region where the runners for your environment have been instantiated.

  • You will need an api key to use these endpoints.

    • API Keys can be generated within the settings of your Neurelo Environment.

    • An api key needs to be provided in the X-API-KEY header for your HTTPs calls and will look something like this

      —header 'X-API-KEY: neurelo_9wAFBp854Z5xFw....q3S4++ktfGmelrcQI='
  • You can download the OpenAPI spec for your auto-generated endpoints and a Postman collection to get you started from the API documentation page.


The following pages cover examples for using the auto-generated REST APIs for 3 different sample schemas -

Last updated