Getting Started

This guide walks you through making your first API call to Kimara.

Prerequisites

• A Kimara account (sign up)
• An API key (see Authentication)
• A published app version ID

Step 1: Get App Details

Retrieve the app's input schema to know what parameters it accepts:

curl https://kimara.ai/api/v1/apps/YOUR_APP_VERSION_ID \
  -H "Authorization: Bearer kim_YOUR_API_KEY"

The response includes an inputs array describing each parameter.

Step 2: Run the App

Submit a run with your inputs:

curl -X POST https://kimara.ai/api/v1/apps/YOUR_APP_VERSION_ID \
  -H "Authorization: Bearer kim_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"inputs": {"1:text": "a sunset over mountains"}}'

The response includes a run_id and poll_url.

Step 3: Poll for Results

Check the run status until it completes:

curl https://kimara.ai/api/v1/runs/YOUR_RUN_ID \
  -H "Authorization: Bearer kim_YOUR_API_KEY"

When status is "completed", the outputs array contains download URLs for your generated files.