Skip to main content

Your First Request to the NeoSpace API

This guide will walk you through creating your first request to the NeoSpace API. We'll use a simple endpoint to verify that everything is set up correctly.

Prerequisites​

Before you begin, make sure you have:

  • An active NeoSpace account
  • An HTTP client like cURL, Postman, or any HTTP request library

Test Endpoint​

Let's start with a simple request to the /v1/status endpoint, which returns information about the current API status:

GET https://api.neospace.ai/v1/status

This endpoint doesn't require additional parameters and can be accessed with a valid API key.

Making the Request​

Choose one of the options below to make your first request:

Using cURL​

curl -X GET \
  https://api.neospace.ai/v1/status \
  -H 'Authorization: Bearer your_api_token_here'

  const fetch = require('node-fetch');

async function checkApiStatus() {
  try {
    const response = await fetch('https://api.neospace.ai/v1/status', {
      method: 'GET',
      headers: {
        'Authorization': 'Bearer your_api_token_here'
      }
    });
    
    const data = await response.json();
    console.log('API Status:', data);
  } catch (error) {
    console.error('Error accessing API:', error);
  }
}

checkApiStatus();

Expected Response​

If everything is set up correctly, you should receive a response similar to this:

{
  "status": "online",
  "version": "1.0.5",
  "serverTime": "2025-07-02T12:34:56Z",
  "maintenance": false
}

Next Steps​

Now that you've confirmed you can successfully access the API, it's time to explore more advanced endpoints:

  • Check the API Reference to see all available endpoints
  • Explore our Practical Guides for more complex usage examples
  • Learn about Usage Limits to avoid throttling issues