Thinkeo API

/publications/{publication_id}

PUT

https://api.thinkeo.io/v0/publications/{publication_id}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

publication_id

string

required

Body Params application/json

attributes

object

required

Sets the attributes values that will influence the generation.

Additional properties

array[string]

optional

blockIds

array[string <uuid>]

optional

Only render this particular block and its descendants.

overwrites

object

optional

Map from block IDs to HTML content. Overwrites some blocks content with the provided HTML.

Default:

{}

Additional properties

string

optional

fastPass

boolean

optional

Does a quicker "fast pass", that does not expand expensive blocks. (e.g. AI blocks, exports...).

Default:

false

stream

boolean

optional

Returns results as a stream of server sent events (SSE) instead.

Default:

false

refresh

object

optional

Map from block IDs to refresh integer. When a block is given a refresh integer greater than 0, its result may change.

Default:

{}

Additional properties

integer <uint64>

optional

>= 0

Example

{
  "attributes": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "blockIds": [],
  "overwrites": {},
  "fastPass": false,
  "stream": false,
  "refresh": {}
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.thinkeo.io/v0/publications/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "attributes": {
        "property1": [
            "string"
        ],
        "property2": [
            "string"
        ]
    },
    "blockIds": [],
    "overwrites": {},
    "fastPass": false,
    "stream": false,
    "refresh": {}
}'

Responses

🟢200OK

application/json

Body

Either

optional

Either a JSON object or a stream of server sent events (SSE), each containing a JSON object.

Any of

RenderBlockResult

SseEvent

Output DTO for the render_block endpoint when stream is false.

publicationId

string <uuid>

required

blocks

object

required

Example

{
  "publicationId": "aac799f4-ea8f-4114-9093-24db2fa60ec5",
  "blocks": {
    "property1": {
      "kind": "html",
      "content": "string"
    },
    "property2": {
      "kind": "html",
      "content": "string"
    }
  }
}

🟠400Bad Request

Modified at 2025-02-21 14:53:31

/publications/{publication_id}