grabbit-live Grabs API

openapi: 3.2.0
info:
  title: Grabbit Live Grabs API
  version: 1.0.0
  contact:
    name: Grabbit support
    email: support@grabbit.live
    url: https://www.grabbit.live/contact
  termsOfService: https://www.grabbit.live/terms
  description: 'Operations tagged Grabs across 2 of this provider''s published API definitions: grabbit-live-openapi.json, www.grabbit.live_openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.grabbit.live/v1
  description: Production
- url: https://www.grabbit.live/api/v1
  description: Production (same API on the web origin)
security:
- bearerAuth: []
- oauth2:
  - grabs
tags:
- name: Grabs
  description: Capture and retrieve screenshots.
paths:
  /grabs:
    post:
      operationId: createGrab
      summary: Capture a screenshot of a URL
      description: 'Renders a public web page in a real Chromium browser and returns a hosted image URL. Synchronous by default (the render times out after 25 seconds). With a live key, send `Prefer: respond-async` or `?async=true` to get a 202 with a grab id, then poll GET /grabs/{id}. Live keys spend one credit per successful grab. sk_test_ keys always return a synchronous 200 placeholder, even when async is requested.'
      tags:
      - Grabs
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        description: Optional. Retries with the same key return the original response.
        schema:
          type: string
      - name: Prefer
        in: header
        required: false
        description: Optional for live keys. `respond-async` queues the grab and returns 202. Test keys still return a synchronous 200 placeholder.
        schema:
          type: string
      - name: async
        in: query
        required: false
        description: 'Optional for live keys. Same as `Prefer: respond-async`; test keys still return a synchronous 200 placeholder.'
        schema:
          type: boolean
      security:
      - bearerAuth: []
      - oauth2:
        - grabs
      x-codeSamples:
      - lang: Shell
        label: curl
        source: "curl https://api.grabbit.live/v1/grabs \\\n  -H \"Authorization: Bearer sk_test_...\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"url\": \"https://example.com\", \"full_page\": true}'"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGrabRequest'
      responses:
        '200':
          description: Captured. image_url is ready.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Grab'
        '202':
          description: Queued (async). Poll GET /grabs/{id}.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Grab'
        '400':
          description: Invalid input (`bad_request`, `invalid_viewport`, `ssrf_detected`, `idempotency_mismatch`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid Bearer token (`unauthorized`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: No live credits left (`credits_exhausted`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Same Idempotency-Key still in flight (`idempotency_conflict`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The target site blocked the capture (`render_blocked`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: '`rate_limit_exceeded` or `queue_limit_exceeded`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: The page could not be rendered (`render_failed`, `internal_error`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    get:
      operationId: listGrabs
      summary: List recent grabs
      description: Lists the calling key's grabs, newest first, scoped to the key's team and environment.
      tags:
      - Grabs
      parameters:
      - name: limit
        in: query
        required: false
        description: 1 to 100. Default 25.
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 25
      - name: status
        in: query
        required: false
        description: Optional status filter.
        schema:
          type: string
          enum:
          - pending
          - processing
          - done
          - failed
      security:
      - bearerAuth: []
      - oauth2:
        - grabs
      x-codeSamples:
      - lang: Shell
        label: curl
        source: 'curl "https://api.grabbit.live/v1/grabs?limit=10" -H "Authorization: Bearer sk_test_..."'
      responses:
        '200':
          description: A page of grabs, newest first.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrabList'
        '400':
          description: Unknown status filter (`bad_request`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid Bearer token (`unauthorized`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.grabbit.live/v1
      description: Production
    - url: https://www.grabbit.live/api/v1
      description: Production (same API on the web origin)
  /grabs/{id}:
    get:
      operationId: getGrab
      summary: Fetch one grab
      description: Returns a single grab. Poll this after an async create until status is done or failed.
      tags:
      - Grabs
      parameters:
      - name: id
        in: path
        required: true
        description: The grab id.
        schema:
          type: string
          format: uuid
      security:
      - bearerAuth: []
      - oauth2:
        - grabs
      x-codeSamples:
      - lang: Shell
        label: curl
        source: 'curl https://api.grabbit.live/v1/grabs/GRAB_ID -H "Authorization: Bearer sk_test_..."'
      responses:
        '200':
          description: The grab.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Grab'
        '401':
          description: Missing or invalid Bearer token (`unauthorized`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No grab with that id for this key (`not_found`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.grabbit.live/v1
      description: Production
    - url: https://www.grabbit.live/api/v1
      description: Production (same API on the web origin)
components:
  schemas:
    GrabList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Grab'
        has_more:
          type: boolean
      required:
      - data
      - has_more
      additionalProperties: {}
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
              enum:
              - unauthorized
              - bad_request
              - invalid_viewport
              - ssrf_detected
              - credits_exhausted
              - not_found
              - idempotency_conflict
              - idempotency_mismatch
              - rate_limit_exceeded
              - queue_limit_exceeded
              - render_blocked
              - render_failed
              - internal_error
              description: Stable machine-readable code. Branch on this, not the message.
            message:
              type: string
              description: Human-readable explanation.
    Grab:
      type: object
      properties:
        id:
          description: Grab id.
          type: string
          format: uuid
        status:
          description: Lifecycle state. Only done grabs have an image_url.
          type: string
          enum:
          - pending
          - processing
          - done
          - failed
        target_url:
          description: The captured URL.
          type: string
          format: uri
        image_url:
          description: Hosted image URL once status is done (relative for sk_test_ placeholders).
          anyOf:
          - type: string
          - type: 'null'
        width:
          description: Viewport width in pixels.
          anyOf:
          - type: integer
            minimum: 0
          - type: 'null'
        height:
          description: Viewport height in pixels (3240 in the response for full_page captures).
          anyOf:
          - type: integer
            minimum: 0
          - type: 'null'
        format:
          description: Image format.
          anyOf:
          - type: string
            enum:
            - png
            - jpeg
            - webp
          - type: 'null'
        bytes:
          description: Image size in bytes.
          anyOf:
          - type: integer
            minimum: 0
          - type: 'null'
        execution_ms:
          description: Render time in milliseconds.
          anyOf:
          - type: integer
            minimum: 0
          - type: 'null'
        error_message:
          description: Why a failed grab failed.
          anyOf:
          - type: string
          - type: 'null'
        created_at:
          description: ISO 8601 creation time.
          type: string
          format: date-time
      required:
      - id
      - status
      - created_at
      additionalProperties: {}
    CreateGrabRequest:
      type: object
      required:
      - url
      properties:
        url:
          type: string
          format: uri
          description: Absolute http(s) URL.
        width:
          type: integer
          minimum: 320
          maximum: 1920
          default: 1280
        height:
          type: integer
          minimum: 240
          maximum: 1080
          default: 720
        format:
          type: string
          enum:
          - png
          - jpeg
          - webp
          default: png
        full_page:
          type: boolean
          default: false
        delay_ms:
          type: integer
          minimum: 0
          maximum: 10000
          default: 0
        selector:
          type:
          - string
          - 'null'
          description: CSS selector to capture one element.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key from https://grabbit.live/app/api-keys. sk_live_ keys render real screenshots and spend credits; sk_test_ keys return free placeholders.
    oauth2:
      type: oauth2
      description: OAuth 2.1 authorization code + PKCE with dynamic client registration (RFC 7591). Used by MCP clients such as claude.ai.
      flows:
        authorizationCode:
          authorizationUrl: https://www.grabbit.live/oauth/authorize
          tokenUrl: https://www.grabbit.live/api/v1/oauth/token
          refreshUrl: https://www.grabbit.live/api/v1/oauth/token
          scopes:
            grabs: Create, list, and read screenshots and read the team's credit balance.
externalDocs:
  description: API reference
  url: https://www.grabbit.live/docs
x-refined-from:
- grabbit-live-openapi.json
- www.grabbit.live_openapi.json