1gateway Docs API
The Docs API from 1gateway — 1 operation(s) for docs.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/1gateway-dev:1gateway-dev-docs-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: 1gateway Docs API
version: 0.1.1
description: '1gateway lets AI agents buy the data and APIs they need, one call at a time: no signup, no API key, paid per request with USDC on Base or Solana via x402. Coverage: company and compliance checks (sanctions, KYB, SEC filings, Korean companies), Korean real estate, trade and macro data, onchain and market data, and agent utilities such as document-to-Markdown. Every response names its source. Failed calls are never charged.'
x-guidance: 'Use this API when an agent needs data as English JSON with pay-per-call access and no signup. Common tasks: Korea apartment sale transactions and district price summaries, Korean public holidays, Korea company KYB (company resolve, profile, NTS business status, DART filings, supplier check), Korean HWP/HWPX to Markdown, web page to Markdown (web read), and document extract (PDF, DOCX, HWP/HWPX or web page to structured JSON). Current coverage is South Korea: apartment sale prices (MOLIT), exports/imports and 10-day export flash (Korea Customs), Bank of Korea statistics (ECOS), weather forecast by lat/lon (KMA), holidays (KASI); more APIs and countries are coming. Base onchain reads: token risk, wallet balances, token info, transaction status. Also: document → Markdown conversion for web pages, PDF, DOCX and Korean HWP/HWPX (price by detected type, decided before payment). Every /v1 endpoint is paid: call it, receive HTTP 402 with PAYMENT-REQUIRED, pay with an x402 client (USDC on Base or Solana, same price) and retry. No charge on failure: settlement happens only on 2xx; 4xx/5xx are never charged. Agent guide: https://1gateway.dev/agents.md. Status: https://1gateway.dev/status. MCP (Streamable HTTP) is available at https://1gateway.dev/mcp: initialize and tools/list are free, tools/call is paid via x402 _meta.'
contact:
email: contact@1gateway.dev
servers:
- url: https://1gateway.dev
tags:
- name: Docs
paths:
/v1/docs/extract:
get:
operationId: docs_extract
summary: 'Document extract: PDF, DOCX, HWP/HWPX or web page to structured JSON with…'
description: 'Use when an agent needs the key facts of a document, not just its text: Korean HWP/HWPX, PDF, DOCX or web page. Input: url via GET, or POST a file (multipart ''file'', raw body, or JSON contentBase64+filename). Output: fixed-schema JSON title, title_en, document_type, date, org, amounts, tables (parsed rows), english_overview. Bad input or model outage refused before payment. Example: ?url=https://example.com/'
x-payment-info:
price:
mode: fixed
currency: USD
amount: '0.009000'
protocols:
- x402: {}
x-x402:
price: $0.009
scheme: exact
network: eip155:8453
networks:
- eip155:8453
- solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp
asset: USDC
kind: single
source: Converted by 1gateway; fields extracted by an open model on Cloudflare Workers AI (Gemma) with a fixed schema, cached by content hash; documents are not stored
parameters:
- name: url
in: query
required: false
description: Public http(s) URL of a PDF, DOCX, HWP, HWPX or web page. For uploads use POST.
schema:
type: string
pattern: ^https?://
maxLength: 2048
example: https://example.com/
- name: type
in: query
required: false
description: Optional expected type; a mismatch is rejected before payment (415, not charged)
schema:
type: string
enum:
- html
- text
- pdf
- docx
- hwp
- hwpx
example: html
responses:
'200':
description: OK (payment settled). Example is a trimmed real output.
content:
application/json:
schema:
type: object
properties:
title:
type: string
title_en:
type:
- string
- 'null'
document_type:
type: string
date:
type:
- string
- 'null'
org:
type:
- string
- 'null'
org_en:
type:
- string
- 'null'
amounts:
type: array
items:
type: object
properties:
label:
type: string
value:
type: string
currency:
type: string
english_overview:
type: string
source_language:
type: string
tables:
type: array
items:
type: object
properties:
rows:
type: array
items:
type: array
items:
type: string
rowCount:
type: integer
truncated:
type: boolean
sourceType:
type: string
chars:
type: integer
contentSha256:
type: string
model:
type: string
generatedAt:
type: string
inputTruncated:
type: boolean
cached:
type: boolean
upstreamCostUsd:
type: number
warnings:
type: array
items: {}
notes:
type: array
items:
type: string
sourceUrl:
type: string
required:
- title
- title_en
- document_type
- date
- org
- org_en
- amounts
- english_overview
- source_language
- tables
- sourceType
- chars
- contentSha256
- model
- generatedAt
- inputTruncated
- cached
- upstreamCostUsd
- warnings
- notes
example:
title: 기초 보고서
title_en: Basics report
document_type: report
date: '2026-10-20'
org: 샘플기관
org_en: Sample Agency
amounts:
- label: Total budget
value: 1.2 billion
currency: KRW
english_overview: A short sample report used to test HWP conversion. It contains a heading, paragraphs and a table.
source_language: ko
tables:
- rows:
- - 과목명
rowCount: 5
truncated: false
sourceType: hwp
chars: 2380
contentSha256: efd25d67822e0523f1643bf7b9f4c6a7492d0627a6b89ee762d89d36b7994c1d
model: '@cf/google/gemma-4-26b-a4b-it'
generatedAt: '2026-10-26T12:00:00.000Z'
inputTruncated: false
cached: false
upstreamCostUsd: 0.000336
warnings: []
notes:
- Fields are machine-extracted (fixed schema) and the overview is a machine paraphrase; check the original before acting. Documents are processed in memory; only…
'400':
description: Invalid or missing parameters, or URL/domain not allowed (validated before payment where possible; not charged)
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Machine-readable error code, e.g. bad_request, not_found, upstream_error, upstream_unreachable, upstream_not_configured
examples:
- bad_request
message:
type: string
description: Human-readable explanation
examples:
- month must be YYYYMM (e.g. 202409)
required:
- error
'402':
description: Payment Required (x402 v2). Returned for every unpaid request. PAYMENT-REQUIRED response header carries base64 JSON PaymentRequired; retry with PAYMENT-SIGNATURE.
'500':
description: Unexpected server error (not charged)
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Machine-readable error code, e.g. bad_request, not_found, upstream_error, upstream_unreachable, upstream_not_configured
examples:
- bad_request
message:
type: string
description: Human-readable explanation
examples:
- month must be YYYYMM (e.g. 202409)
required:
- error
'502':
description: Upstream source returned an error or an unreadable response (not charged)
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Machine-readable error code, e.g. bad_request, not_found, upstream_error, upstream_unreachable, upstream_not_configured
examples:
- bad_request
message:
type: string
description: Human-readable explanation
examples:
- month must be YYYYMM (e.g. 202409)
required:
- error
'503':
description: Endpoint temporarily disabled or upstream not configured on this server; no 402 is issued (not charged). Check /status, retry later
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Machine-readable error code, e.g. bad_request, not_found, upstream_error, upstream_unreachable, upstream_not_configured
examples:
- bad_request
message:
type: string
description: Human-readable explanation
examples:
- month must be YYYYMM (e.g. 202409)
required:
- error
'504':
description: Upstream source timed out or was unreachable (not charged). Retry after 1-5 min with backoff
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Machine-readable error code, e.g. bad_request, not_found, upstream_error, upstream_unreachable, upstream_not_configured
examples:
- bad_request
message:
type: string
description: Human-readable explanation
examples:
- month must be YYYYMM (e.g. 202409)
required:
- error
tags:
- Docs
x-x402-network: eip155:8453
x-billing-policy: 'No charge on failure: payment is settled only after the endpoint returns a 2xx response. Any 4xx or 5xx (bad input, no data, upstream error, timeout, disabled endpoint) is not settled, so the signed payment is never collected. Input is validated before the 402 wherever possible. Over MCP, a tool result with isError is not settled either.'
x-error-codes:
- status: 400
codes:
- bad_request
- url_not_allowed
- bad_checksum
- not_a_contract
meaning: Invalid or missing parameters, or a URL/domain that is not allowed.
retry: Fix the input; do not retry as is.
- status: 402
codes: []
meaning: Payment required (x402 v2). The PAYMENT-REQUIRED header holds the exact price.
retry: Pay with an x402 client and retry with PAYMENT-SIGNATURE.
- status: 403
codes:
- not_bok_authored
meaning: Requested table/resource is not served (e.g. statistics not authored by the Bank of Korea).
retry: Do not retry.
- status: 404
codes:
- not_found
- tx_not_found
- tx_not_mined
meaning: No data for the requested period/code yet.
retry: Try an earlier period or another code.
- status: 413
codes:
- too_large
meaning: Document is larger than this server's conversion cap (checked before payment).
retry: Send a smaller document.
- status: 415
codes:
- unsupported_type
- type_mismatch
meaning: Document type not supported or not matching the declared type (before payment).
retry: Do not retry as is.
- status: 502
codes:
- upstream_error
- upstream_bad_response
- upstream_http_error
- rpc_unavailable
- source_http_error
meaning: The upstream source (government API, RPC, target site) returned an error or unreadable data.
retry: Retry after 30-60 s with backoff.
- status: 503
codes:
- endpoint_disabled
- upstream_not_configured
- payment_not_configured
meaning: Endpoint temporarily disabled on this server, or its upstream is not configured. No 402 is issued.
retry: Check /status; retry later.
- status: 504
codes:
- upstream_unreachable
meaning: The upstream source timed out or was unreachable (Korean public data APIs have occasional outages, esp. holidays).
retry: Retry after 1-5 min with backoff.