API REFERENCE

Beta

Session API

A session is a workspace that holds one set of data. You stage data into it, then start one or more workflows against that data. Staging is free, and you can re-stage as often as you need — the newest snapshot is what a workflow reads.

A session has no expiry and is never discarded on your behalf. It is not a login session, and holding a sessionId is not permission to use it: every call is authorized on its own.

The path you stage through names the format. /sami stages SAMI, PitchPoint’s own format for describing a loan.

Sessions and Workflows walks through the whole path, from staging to reading the result.

Browse every operation, its schemas and code samples in the API Explorer, or download the OpenAPI specification for your own tools.

Every path below is relative to the base URL:

https://api.pointservices.com/riskinsight-services-ws/resources
Operation Method and path Reference
Start a Session POST /v1/sessions Start a Session
Read a Session GET /v1/sessions/{sessionId} Read a Session
Stage Data POST /v1/sessions/{sessionId}/sami Stage Data
Read the Staged Data GET /v1/sessions/{sessionId}/sami Read the Staged Data
Start a Workflow in a Session POST /v1/sessions/{sessionId}/workflows Start a Workflow in a Session

Starting a session and staging cost nothing. Starting a workflow is billed.


Table of contents


Copyright © Pitchpoint Solutions. All rights reserved.