Quickstart

This guide will get you all set up and ready to use the Neurodeploy API. We'll cover how to get started using one of our API clients and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.

Choose your client

Before making your first API request, you need to pick which API client you will use. In addition to good ol' cURL HTTP requests, Neurodeploy offers clients for Python. In the following example, you can see how to install each client.

# cURL is most likely already installed on your machine
curl --version

Making your first API request

After picking your preferred client, you are ready to make your first call to the Neurodeploy API. Below, you can see how to send a GET request to the Models endpoint to get a list of all your models. In the cURL example, results are limited to ten models, the default page length for each client.

curl --location 'https://user-api.neurodeploy.com/ml-models' \
--header 'Authorization: Bearer BEARER_TOKEN'

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the Neurodeploy API:

• Grab your API key from the Neurodeploy dashboard to access via sdk
• Create a new session to access Neurodeploy via Rest API
• Check out the Models endpoint
• Learn about the different error messages in Neurodeploy