PRING public API — create kintone documents from an external system

What is the PRING public API?

The PRING plugin creates documents from kintone screens. The public API is the entrance for calling that same processing from an external system. Requests and responses are JSON (UTF-8); only the document file itself is received as binary.

It is for IT departments, system integrators, kintone implementation partners and in-house developers. The API entrance is https://api.pring.tech/api/v1/, and the pages for people are on this site and in the help.

What can it automate?

• Register a record in a kintone app from an external system and create the document (PDF, Excel or Word) in a single call
• Create one document from a record that already exists in kintone
• Register up to 100 records at once and create the documents together (received as one ZIP)
• List the apps that have PRING installed and their templates
• Receive the document file (a link that opens once, for 15 minutes), or save it to an attachment field in kintone

Where does it connect to kintone?

The target is a kintone app that has the PRING plugin installed. Documents are created from the PRING templates registered in that app.

• Create a kintone API token in the app settings (only the three permissions Add records, Edit records and View records) and register it for each app in the "API" tab of the PRING settings screen
• In "Access per app" in the same tab, set the apps to use from the API to "Allow", and choose "Read only" or "Read and write"
• The kintone API token is what PRING uses to call kintone. To call PRING from your own system, you use the PRING API key described next

How does authentication work?

Send a PRING API key as a Bearer token in the Authorization header of every request. You issue the key in the "API" tab of the settings screen. It is shown once when issued, and it starts with prk_live_ for production or prk_test_ for testing.

• A key can carry up to 20 IP addresses that are allowed to call it, which keeps the impact small if a key leaks from a server with a fixed IP address
• You can keep up to 20 keys, one for each connected system. Revoke a key in the "API" tab; to replace one, issue the new key first and then revoke the old one
• Communication is over HTTPS only, and a key placed in the URL is not accepted

What kinds of output can it create?

PDF, Excel (xlsx) and Word (docx). You choose from the formats that the template registered in the app supports. An Excel layout with formulas, merged cells and formatting becomes the document as it is. You receive the document through a link that opens for a short time, or save it to an attachment field in kintone.

What are the usage levels and rates?

• Count: 1 record per request, or up to 100 records at once
• Rate: up to 100 requests per second per API key. There is also a contract-level rate, and above it you receive 429 with Retry-After (seconds to wait)
• Files: the link to a generated file opens once and for 15 minutes. The link to a batch ZIP stays valid for 24 hours
• Pages: documents created through the API count toward the monthly included pages of your plan, in the same way as documents output from the screen
• Record values are not stored on PRING servers; they are handled only in memory while processing

How does it relate to pricing and plans?

Show me a minimal example

This example registers an invoice record in app 19 and creates the PDF of template tpl_invoice in a single call. Keep the key in the environment variable PRING_API_KEY.

curl -sS -X POST "https://api.pring.tech/api/v1/apps/19/records?render=tpl_invoice&format=pdf" \
  -H "Authorization: Bearer $PRING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "record": { "顧客名": { "value": "サンプル商事" }, "請求日": { "value": "2026-11-01" } } }'

{
  "id": "105",
  "revision": "1",
  "file": {
    "id": "fil_01HXY...",
    "url": "https://api.pring.tech/api/v1/files/fil_01HXY...",
    "expires_at": "2026-11-01T09:15:00Z"
  }
}

Errors come back as JSON in the RFC 7807 (Problem Details) shape. The detail field says what to fix.

{
  "type": "https://pring.tech/ja/help/developer/public-api#errors",
  "title": "Forbidden",
  "status": 403,
  "detail": "This API key does not have the render scope.",
  "instance": "/api/v1/apps/19/records/105/render"
}

Where is the documentation?

The implementation steps are in the help guide for developers, "How to use the public API". It explains issuing keys, access per app, examples in curl, Node.js and Python, asynchronous jobs, the list of errors and how to fix them, and the details of usage levels.

How do I choose between the public API and MCP?

What is decided for safety?

• An API key can be narrowed by the operations it may use (scopes), the apps it may use and the IP addresses it may call from
• Each app is allowed one by one in "Access per app" (the default is not allowed). An app that is not allowed is not visible from the API
• The kintone API token is stored encrypted and used only to register and get records
• A key can be revoked, and keys can be replaced without stopping the integration

Read next

• How to use the public API (for developers)Issuing keys, examples in curl, Node.js and Python, asynchronous jobs, fixing errors
• PRING MCPAsk an AI agent to create documents, with the same authentication and levels as the API
• PricingMonthly price and included pages for each plan
• Become a partnerPropose PRING to your customers, including extensions that use the API
• Use casesExamples of creating documents with the business app sets for purchasing, sales and expenses