Skip to main content
POST
/
installs
/
{id}
/
renders
Create install render
curl --request POST \
  --url https://api.akua.dev/v1/installs/{id}/renders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "<string>",
  "skip_unchanged": true,
  "extra_annotations": {}
}
'
{
  "id": "<string>",
  "workspace_id": "<string>",
  "install_id": "<string>",
  "render_hash": "<string>",
  "created_at": 1,
  "updated_at": 1,
  "operation_id": "<string>",
  "repository_change_request_id": "<string>",
  "commit_sha": "<string>",
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://akua-1dce587a.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

Headers

​
akua-context
string

Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens — a workspace-owned token implies its workspace.

Required string length: 1 - 53
Example:

"ws_j572abc123def456"

​
idempotency-key
string

Caller-supplied idempotency key. Repeated requests with the same key return the existing resource instead of creating a duplicate. Safe to retry after a timed-out or interrupted request.

Required string length: 1 - 64
Example:

"create-prod-2026-05-07"

Path Parameters

​
id
string
required

Install ID

Required string length: 1 - 55
Example:

"inst_j572abc123def456"

Body

application/json
​
message
string
Maximum string length: 255
​
skip_unchanged
boolean | null
default:true
​
extra_annotations
object

Response

Render artifact created

​
id
string
required
Required string length: 1 - 54
​
workspace_id
string
required
Required string length: 1 - 53
​
install_id
string
required
Required string length: 1 - 55
​
render_hash
string | null
required
​
state
enum<string>
required
Available options:
running,
deployed,
skipped,
failed
​
created_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
​
updated_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
​
operation_id
string | null
Required string length: 1 - 53
​
repository_change_request_id
string | null
Required string length: 1 - 54
​
commit_sha
string | null
​
message
string | null