inklet docs

List analyses

GET/api/sdk/v1/analyses

Authorization

bearerAuth
AuthorizationBearer <token>

A personal access token created in the inklet portal. Server-side use only.

In: header

Query Parameters

cursor?string

Opaque cursor returned by the previous page.

Length1 <= length
limit?integer

Number of items to return.

Range1 <= value <= 50
Default20
contentId?string

Only analyses that named this content in contentIds.

Length1 <= length
state?string

Value in

  • "queued"
  • "running"
  • "completed"
  • "failed"
trigger?string

Value in

  • "api"
  • "scheduled"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/sdk/v1/analyses"
{  "nextCursor": "string",  "hasMore": true,  "items": [    {      "id": "string",      "mode": "ai",      "trigger": "api",      "state": "queued",      "outcome": "presentations",      "noChangeReason": "string",      "contentIds": [        "string"      ],      "context": "submitted",      "scope": {        "since": "string",        "sinceAt": "2019-08-24T14:15:22Z"      },      "intent": "string",      "title": "string",      "target": {        "displayId": "string",        "displayIds": [          "string"        ],        "output": {          "formats": [            "scene"          ],          "preset": "string",          "viewport": {            "width": 1,            "height": 1          },          "colorMode": "color",          "pixelRatio": 1        }      },      "presentationIds": [        "string"      ],      "failure": {        "code": "string",        "message": "string",        "stage": "string",        "retryable": true,        "assetIndex": 0      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Refresh upload tickets POST

Issues new presigned upload tickets for selected binary asset indexes. A content that failed because its upload window closed (`failure.code` of `upload_expired`) returns to `pending` once new tickets are issued.

Create an analysis POST

Starts an agent run over the named contents, the user's earlier contents, or both. Accepted work is returned immediately with `state: "queued"`; follow it with the event stream or by re-reading the analysis. `mode: "ai"` requires an active Pro subscription. `mode: "direct"` shows one uploaded PNG or JPEG without AI and is available on every plan. Omitting `target` asks the agent to choose the displays — which needs at least one usable display on the account, or the request is refused with `422 no_compatible_display` before anything is created.