> ## 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.

# Analysis failed

> Fired when a shelf analysis fails.



## OpenAPI

````yaml /openapi.json webhook analysis.failed
openapi: 3.1.0
info:
  title: Shelfforce API
  version: 1.0.0
  description: >-
    Shelfforce turns shelf photos into structured retail data. Submit images for
    AI-powered shelf analysis, manage tasks and inventory, and retrieve
    compliance and share-of-shelf reports.


    All API requests require a Bearer token (API key with `sf_live_` prefix).
    Rate limits are enforced per tier using a fixed 60-second window.
    Idempotency is supported on POST and PATCH via the `Idempotency-Key` header
    (24h TTL).


    1 credit = 1 image analysis. Batch submissions consume 1 credit per image
    (max batch size depends on plan tier: 20-200). Tag analyses with
    `externalId` and `metadata` for B2B tracking, and use `callbackUrl` for
    per-request completion notifications.
  termsOfService: https://shelfforce.ai/terms
  contact:
    name: Shelfforce Support
    url: https://shelfforce.ai/support
    email: hey@shelfforce.ai
  license:
    name: Proprietary
    url: https://shelfforce.ai/terms
servers:
  - url: https://shelfforce.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Analyses
    description: Submit images for AI shelf analysis and retrieve results.
  - name: Products
    description: Browse products detected across analyses.
  - name: Places
    description: Manage store locations tied to your organisation.
  - name: Tasks
    description: Create and manage field data-collection tasks.
  - name: Inventory
    description: Maintain a master catalogue of expected SKUs.
  - name: Reports
    description: 'Aggregated analytics: share of shelf and store performance.'
  - name: Webhooks
    description: Register endpoints to receive real-time event notifications.
  - name: Usage
    description: Check credit balance, plan details, and rate-limit status.
  - name: Orders
    description: Create and manage purchase orders with line items.
  - name: Accounts
    description: Manage brand, supplier, distributor, and partner accounts.
  - name: Alerts
    description: >-
      Read and manage system-generated alerts. Alerts are created automatically
      — no POST endpoint.
  - name: Members
    description: >-
      List, invite, update, and remove organisation members. Admin role required
      for writes.
paths: {}
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API key with `sf_live_` prefix. Pass as `Authorization: Bearer
        sf_live_...`

````