TRANXACT.AI Help

Platform · Published API

API Studio

One board for the whole of the published API: what is exposed, who holds a key, what each key could not actually do, and every call made in the last few days with the reason for each refusal. Software calls in at <this address>/api/v1 (REST, with an OpenAPI document per key at /api/v1/openapi.json) and /api/v1/mcp (MCP); documented at help.tranxact.ai › Connecting other software.

Type REST6 operationsBase path /api/platform/api-studio

Download specification (OpenAPI 3.1) Screen: API Studio

Overview

PackagePlatform
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Platform › API Studio on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

6 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/platform/api-studio/publishablePublishable

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/api-studio/publishable" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/api-studio/columnsColumns

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/api-studio/columns" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/api-studio/overviewOverview

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/api-studio/overview" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/api-studio/clients/{id}/keyClients key

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/api-studio/clients/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/key" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/api-studio/clients/{id}/revoke-keyClients revoke key

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/api-studio/clients/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/revoke-key" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/api-studio/previewPreview

Request body

The keys this action reads (* = required; "one of" lists the only values):

exposureId, clientId, limit

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/api-studio/preview" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"exposureId":"value","clientId":"value","limit":"value"}'

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Platform › API Studio for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.