Skip to main content
GET
/
v1
/
embed
/
renders
List embed renders
curl --request GET \
  --url https://api.craftkit.dev/v1/embed/renders \
  --header 'Authorization: Bearer <token>'
{
  "renders": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source": "<string>",
      "templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "inputData": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "templateName": "<string>",
      "downloadUrl": "<string>",
      "errorMessage": "<string>",
      "durationMs": 123,
      "completedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 123,
  "offset": 123
}

Authorizations

​
Authorization
string
header
required

Project API key (ck_live_… or ck_test_…) presented as a bearer token. For embed partner endpoints this is the partner secret key, which is the same credential type.

Query Parameters

​
limit
integer
default:100

Page size (1–500).

Required range: 1 <= x <= 500
​
offset
integer
default:0
Required range: x >= 0
​
templateId
string<uuid>

Filter by Craftkit template UUID.

​
status
enum<string>

Filter by render status.

Available options:
queued,
rendering,
succeeded,
failed,
cancelled

Response

Renders.

​
renders
object[]
required
​
limit
integer
required
​
offset
integer
required