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

# One known catalog URL, straight to the extraction agent — no fan-out

> Not yet available — planned (the whole /extractions surface, including the urls[] batch form, answers 501 not_implemented). https://docs.fiveninelabs.com/guides/extractions. urls[] batches up to 50 — max_spend_usd reserves PER URL (worst case N × cap, stated in the batch response); validation is all-or-nothing. SSE via Accept, as with sessions (single-url form only).




## OpenAPI

````yaml /api-reference/openapi.yaml post /extractions
openapi: 3.1.0
info:
  title: Five Nine Agent API
  version: '2026-08-26'
  description: >
    Live catalogs from the open web, under signed receipts.

    Conventions (versioning via the dated `fn-version` header, request IDs,

    idempotency, rate limits, pagination, money) are documented across this

    reference; the error envelope at https://docs.fiveninelabs.com/errors; the

    event vocabulary at https://docs.fiveninelabs.com/guides/events; webhooks at

    https://docs.fiveninelabs.com/guides/webhooks.


    Honesty marker: operations tagged `x-fn-status: planned` are specced but NOT

    yet served by the live API — on any method they answer 501 not_implemented
    with

    a `surface` member naming what is missing, never 404. Everything unmarked is

    live. The changelog says when a planned surface ships.
servers:
  - url: https://api.fiveninelabs.com/v1
security:
  - bearerKey: []
paths:
  /extractions:
    post:
      summary: One known catalog URL, straight to the extraction agent — no fan-out
      description: >
        Not yet available — planned (the whole /extractions surface, including
        the urls[] batch form, answers 501 not_implemented).
        https://docs.fiveninelabs.com/guides/extractions. urls[] batches up to
        50 — max_spend_usd reserves PER URL (worst case N × cap, stated in the
        batch response); validation is all-or-nothing. SSE via Accept, as with
        sessions (single-url form only).
      parameters:
        - $ref: '#/components/parameters/FnVersion'
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExtractionCreate'
      responses:
        '201':
          description: Extraction running — or, for urls[], the created batch
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/Extraction'
                  - $ref: '#/components/schemas/ExtractionBatch'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/Payment'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/Declined'
components:
  parameters:
    FnVersion:
      name: fn-version
      in: header
      required: false
      schema:
        type: string
        example: '2026-08-26'
      description: >-
        Dated API version; defaults to the account pin. Honesty note: with one
        version in existence the gateway echoes any value back as effective
        WITHOUT validating it — validation against the known-versions set is
        planned, so send only real dated versions from
        https://docs.fiveninelabs.com/changelog
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
        maxLength: 255
      description: 24h replay window; a retry never bills twice
  schemas:
    ExtractionCreate:
      type: object
      required:
        - entity
        - max_spend_usd
      properties:
        url:
          type: string
          format: uri
          description: the catalog page (or use urls[])
        urls:
          type: array
          maxItems: 50
          items:
            type: string
            format: uri
        entity:
          type: string
          description: what one row IS — https://docs.fiveninelabs.com/guides/extractions
        guidance:
          type: string
          maxLength: 2000
          description: steering text; data, never instructions (fail-closed)
        max_spend_usd:
          type: number
        webhook_url:
          type: string
          format: uri
        metadata:
          type: object
          additionalProperties:
            type: string
    Extraction:
      type: object
      required:
        - id
        - object
        - status
        - url
      properties:
        id:
          type: string
          example: ext_6b1st
        object:
          type: string
          const: extraction
        status:
          type: string
          description: running | delivered | abstained | error | stopped (open enum)
        url:
          type: string
        entity:
          type: string
        claim:
          type: string
          description: complete | partial — the receipt's claim, stated
        records:
          type: integer
        spend_usd:
          type: number
        receipt_id:
          type: string
        refresh_of:
          type: string
          description: set when created by …/refresh
        served_from:
          type: string
          description: record — when max_age_s satisfied the refresh at $0
        diff:
          type: object
          description: refreshes only — vs the refreshed-from delivery
          properties:
            added:
              type: integer
            removed:
              type: integer
            changed:
              type: integer
        created_at:
          type: string
          format: date-time
    ExtractionBatch:
      type: object
      required:
        - object
        - data
        - total_reserved_usd
      properties:
        object:
          type: string
          const: extraction_batch
        data:
          type: array
          items:
            $ref: '#/components/schemas/Extraction'
        total_reserved_usd:
          type: number
          description: N × max_spend_usd — the batch's worst case, stated
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - doc_url
            - request_id
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
            doc_url:
              type: string
              format: uri
            request_id:
              type: string
          additionalProperties: true
  responses:
    Unauthorized:
      description: 401 invalid_key | key_revoked — key missing, unknown, or revoked
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Payment:
      description: 402 insufficient_credit — balance, reserves, top_up_url in context
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        403 missing_scope — or a cap forbids this (session_cap_exceeded |
        monthly_cap_exceeded; caps are permissions, not rates)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Declined:
      description: >-
        422 declined_to_spend — RESERVED, not emitted today: a query we refuse
        to spend on returns 201 and ends as a $0 `abstained` run (reservation
        released); the pre-spend signal is estimate.would_run:false. See
        https://docs.fiveninelabs.com/errors/declined_to_spend
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerKey:
      type: http
      scheme: bearer
      description: 'fn_live_… or fn_test_… — Authorization: Bearer'

````