inklet docs

Create content

POST/api/sdk/v1/contents

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.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Header Parameters

Idempotency-Key*string

8–128 printable ASCII characters without spaces. Required. Replaying a key with the same body returns the original response verbatim; reusing it with a different body is 409 idempotency_conflict, and reusing it while the first call is still in flight is 409 invalid_state. Keys are remembered for 24 hours, and a rejected request releases its key.

Match^[!-~]+$
Length8 <= length <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Binary assets are declared by metadata only — the bytes go to the presigned upload ticket returned with the response.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/sdk/v1/contents" \  -H "Idempotency-Key: stringst" \  -H "Content-Type: application/json" \  -d '{    "assets": [      {        "type": "text",        "text": "string"      }    ]  }'
{  "content": {    "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"  },  "uploadTickets": [    {      "assetIndex": 0,      "url": "http://example.com",      "fields": {        "property1": "string",        "property2": "string"      },      "expiresAt": "2019-08-24T14:15:22Z"    }  ]}

List contents GET

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`.

Retrieve content GET

Next Page