> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shelfforce.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Shelfforce API

> Turn shelf photos into structured product data. Detect SKUs, count facings, read prices, and measure brand share — all from a single API call.

Shelfforce is a retail shelf analytics API that transforms shelf photos into structured, actionable product data. Submit an image of a retail shelf, and get back every product detected — with SKU identification, facing counts, pricing, promotional status, and brand-level share-of-shelf metrics.

<Tiles>
  <Tile icon="rocket" title="Quickstart" href="/quickstart">
    Analyze your first shelf image in under 5 minutes.
  </Tile>

  <Tile icon="code" title="API Reference" href="/api-reference">
    Full endpoint documentation with interactive playground.
  </Tile>

  <Tile icon="search" title="Shelf Analysis" href="/guides/shelf-analysis">
    The core workflow: submit, poll, extract.
  </Tile>

  <Tile icon="bot" title="Agent Integration" href="/guides/agent-integration">
    Connect to AI agents and automated pipelines.
  </Tile>
</Tiles>

## Who is Shelfforce for?

<Tabs>
  <Tab title="CPG Brands">
    Monitor shelf presence, share-of-shelf, and pricing compliance across retail locations. Track how your products are displayed relative to competitors.
  </Tab>

  <Tab title="Retailers">
    Automate planogram compliance checks and inventory audits. Verify shelf execution matches corporate standards.
  </Tab>

  <Tab title="Field Teams">
    Equip reps with task-driven workflows and instant shelf analysis from mobile photos. No manual data entry.
  </Tab>

  <Tab title="AI Agents">
    Integrate shelf intelligence into autonomous retail operations pipelines. Full OpenAPI spec, llms.txt, and webhook support.
  </Tab>
</Tabs>

## Key capabilities

<AccordionGroup>
  <Accordion icon="scan-eye" title="Image Analysis">
    Submit shelf photos and receive structured product-level data in seconds. Supports JPEG, PNG, and WebP. Results include every detected SKU with brand, category, size, and confidence score.
  </Accordion>

  <Accordion icon="package" title="Product Detection">
    Identify SKUs, brands, categories, sizes, and facing counts per product. Each detection includes shelf position (top, eye-level, middle, bottom) and fixture type.
  </Accordion>

  <Accordion icon="badge-dollar-sign" title="Price Reading">
    Extract shelf-edge prices and match them to the correct products using spatial reasoning. Detects both regular and promotional pricing.
  </Accordion>

  <Accordion icon="clipboard-list" title="Task Management">
    Create and assign field tasks to specific stores with due dates and compliance criteria. Track task lifecycle from pending through completion.
  </Accordion>

  <Accordion icon="shield-check" title="Compliance Tracking">
    Compare detected shelf state against brand standards and promotions. Get pass/fail results per compliance check with actual vs. expected values.
  </Accordion>

  <Accordion icon="chart-pie" title="Reports">
    Query share-of-shelf, store performance, and pricing reports via API. Filter by date range, brand, category, and location.
  </Accordion>
</AccordionGroup>

## AI agent ready

Shelfforce is designed for machine-to-machine integration from the ground up.

<CardGroup cols={3}>
  <Card icon="file-code-2" title="OpenAPI Spec">
    Full OpenAPI 3.1 spec at [`/openapi.json`](https://docs.shelfforce.ai/openapi.json) for automatic tool discovery.
  </Card>

  <Card icon="file-text" title="llms.txt">
    LLM-friendly context at [`/llms.txt`](https://shelfforce.ai/llms.txt) optimized for agent comprehension.
  </Card>

  <Card icon="bell" title="Webhooks">
    Event-driven notifications for analysis completion, task updates, and more.
  </Card>
</CardGroup>

## Get started

<Steps>
  <Step title="Get your API key">
    Sign up at [shelfforce.ai](https://shelfforce.ai) and generate an API key from [Settings](https://shelfforce.ai/home/developers).
  </Step>

  <Step title="Analyze your first image">
    Follow the [Quickstart](/quickstart) to submit a shelf photo and view the results.
  </Step>

  <Step title="Explore the API">
    Browse the full [API Reference](/api-reference) for every endpoint.
  </Step>
</Steps>