inklet docs

List contents

GET/api/sdk/v1/contents

Newest first. q searches the library: every whitespace-separated term must appear on the same Content — in its title, or in an asset's text, link, or filename, or in what inklet read out of an image or file. Matching is case-insensitive and by substring, so CJK text matches without word breaks. Paging and ordering are the same as without q.

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
state?string

Value in

  • "pending"
  • "ready"
  • "failed"
q?string

Search terms. Leading and trailing whitespace is ignored, and a blank value means no filter. Longer than 200 characters is 400 invalid_request.

Lengthlength <= 200

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/sdk/v1/contents"
{  "nextCursor": "string",  "hasMore": true,  "items": [    {      "id": "string",      "title": "string",      "state": "pending",      "assets": [        {          "assetIndex": 0,          "type": "text",          "text": "string",          "url": "http://example.com",          "filename": "string",          "contentType": "string",          "sizeBytes": 0,          "uploadState": "pending"        }      ],      "failedAssetIndexes": [        0      ],      "analysisIds": [        "string"      ],      "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"    }  ]}

Advance to the next queued presentation POST

Rotates to the next queued presentation, highest priority first and oldest first within a priority. An empty queue answers `200` with `changed: false` and changes nothing — that is a normal result, not an error.

Create content POST

Stores one submission and returns presigned upload tickets for its binary assets. Nothing is processed here and no quota is spent — create an Analysis to do anything with the content.