Schema library b2b-intel

Return an API documentation endpoint from a public page.

Pass this JSON Schema and a public source URL to/extract/json. Capture an endpoint’s method, path, purpose, parameters, authentication notes, and response details from public API documentation.

Use this schema The JSON file

tabstack.ai/pricing

TEXT

MARKDOWN

LINKS

extract.tsTypeScript

const res = await client.extract.json({
  url: 'https://example.com/pricing',
  json_schema: {
    type: 'object',
    properties: {
      plan: { type: 'string' },
      price: { type: 'number' },
    },
  },
})

res = client.extract.json(
    url='https://example.com/pricing',
    json_schema={
        'type': 'object',
        'properties': {
            'plan': {'type': 'string'},
            'price': {'type': 'number'},
        },
    },
)

tabstack extract json https://example.com/pricing \
  --schema '{"type":"object","properties":{"plan":{"type":"string"},"price":{"type":"number"}}}'

What it captures

Fields in this API documentation endpoint.

Schema for individual API endpoint entries extracted from API documentation pages.

Field	Type	What it holds
`company_name`	string, required	Name of the company providing the API.
`company_domain`	string	Website domain of the API provider.
`api_name`	string	Name of the API product.
`api_version`	string	Version of the API (e.g., v1, 2024-01-01).
`endpoint_path`	string, required	URL path of the API endpoint (e.g., /v1/users/{id}).
`http_method`	string, required	HTTP method for the endpoint.
`title`	string	Short title or name for the endpoint.
`description`	string	Description of what the endpoint does.
`auth_type`	string	Authentication type required for this endpoint.
`parameters`	array	List of request parameters for this endpoint.
`request_body_schema`	object	JSON Schema or description of the request body.
`response_codes`	array	HTTP response codes returned by this endpoint.
`rate_limit_requests`	number	Number of requests allowed in the rate limit window.
`rate_limit_window`	string	Time window for the rate limit (e.g., '1 minute', '1 hour').
`is_deprecated`	boolean	Whether this endpoint is deprecated.
`deprecation_date`	string	Date this endpoint was or will be deprecated.
`docs_url`	string	URL of the documentation page for this endpoint.
`page_title`	string	Title of the source page. Tabstack auto-fills this from page metadata when left empty.
`favicon`	string	Favicon URL of the source page. Tabstack auto-fills this from page metadata when left empty.

Example

Inspect and validate the response shape.

The example below is generated from the schema to demonstrate its structure. Edit the object or paste a real response to validate it in your browser.

What it checks

Pass or fail, and the first reason why.

Whether the text parses as JSON, whether the top level is an object, and whether each field the schema requires is present at the declared type. A null is allowed anywhere. Every key you ask for is present. A field the page does not state can come back null, empty, a placeholder number, or a guessed value. Validate values, not just keys.

Example data, not a live response.

Usage

Send the schema with your source URL.

The schema travels with the request rather than living on your account, so the same call can send a trimmed version for one page and the full one for another. Every key you ask for is present. A field the page does not state can come back null, empty, a placeholder number, or a guessed value. Validate values, not just keys.

api.tsTypeScript

import schema from './api-documentation-endpoint.json'

const res = await client.extract.json({
  url: 'https://example.com/pricing',
  json_schema: schema,
})

tabstack extract json 'https://example.com/pricing' \
  --schema @./api-documentation-endpoint.json

Adaptation

Make the schema match your application.

The schema is a starting point, not a guarantee that every source page contains every field. Three things are worth doing before you write one into your system, and the schema-authoring guide covers the rest.

Remove what you do not need

A shorter schema is a smaller response and fewer fields to handle.

Describe the ambiguous ones

A description tells Extract what to look for when a label could mean two things.

Validate before you store

Check the returned object against the schema rather than trusting it.

Related schemas

Other schemas in this category.

Same category: company profile.
Same category: competitor profile.
Same category: funding round.
The job rather than the object: the Extract API.