Skip to content
prismletAPI docs

API reference

Prismlet API 1.0.0

Section titled “Prismlet API 1.0.0”

Prismlet answers typed questions about a text. A prism is a named set of fields, optional context and questions, built and versioned in the Prismlet app. Send a text to a prism and the answers come back in the same response. Every answered call is saved as a result, which you can read again by its id, and retry if it failed.

Responses are snake_case JSON by default, with one answer per column of the prism’s Lens. format switches to the stored answers, or to the result as a CSV, TSV or JSON Lines row.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
POST
/prisms/{prism}/results
GET
/results/{result_id}
POST
/results/{result_id}/retry

Authentication

Section titled “ Authentication ”

api_key

Section titled “api_key”

An account API key, sent as Authorization: Bearer pl_.... Create one on the API keys page of the app; the full key is shown once. A key works for every prism in its account.

No header, or one that is not Bearer <key>, answers 401 Authentication required. Bearer is case-sensitive. A key that does not start with pl_, is unknown or was revoked answers 401 Invalid API key. A revoked key stops working on its next request.

Security scheme type: http

Bearer format: pl_ followed by 32 characters