Bandsets

Overview

This endpoint returns all available bandsets, including both custom and default bandsets. You can copy the appropriate bandset_id and use it while placing tasking orders.

• Method: GET

• URL: /v0/bandsets

• Operation: Retrieve a list of available bandsets and their metadata

• Authentication Required: Yes

Authorization

You need the api key which you can get from the API tab in Workspace Settings. The api key is required in almost all the commands

Authorization: <YOUR_API_KEY>

Query Parameters

This endpoint does not require any query parameters.

Path Parameter

This endpoint does not require any path parameters.

Response

The List all bandsets endpoint returns a 200 OK response with a list of available bandset. Each bandset includes metadata like name, id, description, and captures. If the request is malformed (e.g., invalid parameters), a 400 Bad Request is returned. A 500 Internal Server Error may occur due to unexpected server issues. All errors include a structured JSON response with a code, message, and optional details for debugging.

Successful Response – 200 OK

Returns a list of bandsets with all related metadata.

Below is the complete JSON request for listing all bandsets using the List all bandsets endpoint. Customize the values as needed for your search criteria:

{
  "bandsets": [
    {
      "bands": [
        {
          "name": "<string>",
          "wavelength": 123
        }
      ],
      "captures": 1,
      "description": "<string>",
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

Error responses

Occurs when the request is malformed, such as missing or invalid parameters: (400 - Bad Request and 500 - Internal Server Error)

{
  "error": {
    "code": "<string>",
    "details": "<any>",
    "message": "<string>"
  }
}

How to use the endpoint

1. Construct request:

   Add your API key to the Authorization header.

2. Send request:

   Make the GET request to https://api.pixxel.space/v0/bandsets.

3. Examine response:

   A successful 200 OK response returns a JSON object with a list of available bandsets and metadata. Each bandset includes its name, description, id, captures, and related band details. In case of errors (like bad parameters or server issues), you'll receive a structured error message with details and status code.