Catalog

The Catalog is a unified repository of all imagery that has been delivered to you, including both tasked captures and archived data. It provides a consolidated view to help you easily search, track, and manage your purchased images.

Key Endpoints

1. Search Catalog

Use this endpoint to query your image catalog which helps you narrow down the list of delivered images quickly. You can filter by collection, order ids, order item ids, project, use case, date ranges, or other metadata attributes to find specific imagery.

• Endpoint: POST /v0/catalogs/search
• Sample Request:

  {
    "collections": [
      "<string>"
    ],
    "datetime": "2020-04-05T11:56:49.865Z/2023-06-05T11:56:49.865Z",
    "ids": [
      "47435e2b-d8c4-41ff-9de9-2be3bfc92276"
    ],
    "query": {
      "project_id": "<PROJECT_ID>",
      "usecase": "agriculture"
    },
    "limit": 10,
    "offset": 0
  }

2. Get Catalog Details

Retrieve comprehensive details for a specific catalog entry using its Catalog ID. Use this endpoint to inspect individual image details, including metadata, associated order item information, and delivery status.

• Endpoint: GET /v0/catalogs/{id}
• Sample Request:

curl -X GET "https://api.pixxel.space/v0/catalogs/<CATALOG_ID>" \
  -H "Authorization: <YOUR_API_KEY>"

• Response Structure:
  The detailed response includes:

  • Catalog ID: A unique identifier for the catalog entry.
  • Order Item Details: Information linking this catalog entry to its corresponding order item.
  • Metadata: Such as capture date, platform, sensor details, and any custom properties.
  • Delivery Status: Information about the delivery, such as if the image is ready for download.

Use of Catalog IDs

The Catalog ID is a key piece of information in your workflow:

• Download Resources:
  When you want to download an image, you'll use the Catalog ID with the Create Download Resource endpoint. This generates a signed URL for secure image retrieval.
• Delivery Tracking:
  Catalog IDs are used to reference and monitor the delivery status of your orders. You can track when an image has been successfully delivered or if there are any issues that need attention.