Pixxel
Documentation
Developer Guide
Pixxel API
Getting Started
IntroductionAuthentication & SecuritySetting Up
Identity and Access
Projects
Order Desk
BandsetsTasking

Orders & Order Items

Search
List supported satellitesSearch satellite images
AOIs
Create a new AOIList all AOIsGet AOI
Assets
List Assets for an AOIDownload Assets of an AOIGet status of Download request
Indices
Create IndexList all Indices
Visualizations
Create VisualizationList all Visualizations
Blocks
List BlocksGet Block VersionsGet Block by Version
Insights
Create InsightsList InsightsDownload InsightsDelete Insights
Workflows
List WorkflowsGet WorkflowGet Workflow Cost EstimateList Blocks - Workflows
Jobs
About Jobs and TasksCreate JobList JobsGet JobDownload JobDownload Task
Reference
Data Types
Tasks
Download Tasks
Pixxel
Documentation
Developer Guide
Pixxel API
Getting Started
IntroductionAuthentication & SecuritySetting Up
Identity and Access
Projects
Order Desk
BandsetsTasking

Orders & Order Items

Search
List supported satellitesSearch satellite images
AOIs
Create a new AOIList all AOIsGet AOI
Assets
List Assets for an AOIDownload Assets of an AOIGet status of Download request
Indices
Create IndexList all Indices
Visualizations
Create VisualizationList all Visualizations
Blocks
List BlocksGet Block VersionsGet Block by Version
Insights
Create InsightsList InsightsDownload InsightsDelete Insights
Workflows
List WorkflowsGet WorkflowGet Workflow Cost EstimateList Blocks - Workflows
Jobs
About Jobs and TasksCreate JobList JobsGet JobDownload JobDownload Task
Reference
Data Types
Tasks
Download Tasks
  1. Getting Started
  2. Setting Up

Setting Up

Base URL & Request Format

  • Base URL:

    All API endpoints are accessed securely via our base URL:

    https://api.pixxel.space
  • Request Headers:

    Every API request must include the following headers:

    • Content-Type: application/json
    • Authorization: <YOUR_API_KEY>
  • JSON Format:

    Our API accepts and returns data in JSON format. Ensure that all requests are properly formatted as JSON.

Testing the API

  • Ping the Server:

    Use the /ping endpoint to check if the API is reachable. A successful response will return a simple message indicating that the server is active.

Error Handling & Best Practices

  • Error Codes:

    Our API returns standardized HTTP status codes along with detailed error messages. For example:

    • 400 Bad Request: Indicates invalid input or malformed requests.
    • 403 Forbidden: Authentication errors or insufficient permissions.
    • 500 Internal Server Error: Issues on the server side.
  • Tips for Success:

    • Verify that all required parameters are included.
    • Use the provided sample request bodies as a starting point.
    • Consult the Developer Docs for practical implementation guides and real-world examples.
Authentication & SecurityProjects
On this page
Base URL & Request FormatTesting the APIError Handling & Best Practices