Quick Start Guide

Deploy Your First Agent

Learn how to deploy your first AI agent using Hikigai's config-based deployment. Choose GCP or AWS as the cloud target. No coding required.

Beginner Friendly5 Min SetupNo CodeGCP & AWS

New to Hikigai?

This guide will walk you through deploying a production-ready AI agent in under 5 minutes using our config-based approach.

1

Create Your Account

First, you'll need a Hikigai account to start deploying agents.

•

Visit login and sign in securely with your Google account.

•

Access the developer console immediately.

Free Tier

All new accounts include free credits to deploy and test your agents.

2

Create a Project

Projects organize agents, apps, and MCP servers. Think of them as containers for your AI applications.

1.

Navigate to the Projects page in your console

2.

Click "Create New Project"

3.

Enter a project name and description

4.

Optionally attach BYOC cloud credentials (AWS or GCP) under project Cloud accounts if you want to deploy into your own cloud account

5.

Click "Create Project"

Example:

Name: Healthcare Assistant

Description: AI agents for clinical documentation and patient care

3

Configure Your Agent

Now you'll configure your agent using our simple form-based interface.

1.

Open your project and click "Deploy Agent"

2.

Select "Config-Based" deployment mode

3.

Fill out the configuration form with your agent details

Required Fields:

Agent Name

A unique identifier for your agent (e.g., "clinical-note-summarizer")

Instruction

Tell the agent what it should do. Be specific and clear.

You are a clinical documentation assistant. Convert patient encounter transcripts into structured SOAP notes. Extract key medical information including symptoms, vital signs, diagnoses, and treatment plans.

Model

Choose the AI model (gemini-2.0-flash, gpt-4, etc.)

Input Schema

Define what data your agent accepts (JSON Schema format)

{
  "type": "object",
  "properties": {
    "transcription": {
      "type": "string",
      "description": "Raw patient visit transcript"
    },
    "patient_id": {
      "type": "string",
      "description": "Patient identifier"
    }
  },
  "required": ["transcription"]
}

Output Schema

Define what data your agent returns (JSON Schema format)

{
  "type": "object",
  "properties": {
    "subjective": {
      "type": "string",
      "description": "Patient-reported symptoms"
    },
    "objective": {
      "type": "string",
      "description": "Clinical observations"
    },
    "assessment": {
      "type": "string",
      "description": "Diagnosis and analysis"
    },
    "plan": {
      "type": "string",
      "description": "Treatment plan"
    }
  }
}

Pro Tip

Start with a simple instruction and schema. You can always refine them after testing your agent.

4

Deploy Your Agent

Review your configuration, pick a cloud target (GCP or AWS), and deploy.

1.

Click "Preview Code" to review the generated code

2.

Select a cloud provider — GCP or AWS. Leave credentials empty to use the platform account, or pick a project BYOC credential.

3.

Verify your agent's instruction, schemas, and settings

4.

Click "Deploy"

5.

Wait while your agent is deployed (you'll see real-time progress)

What happens during deployment:

  • Agent code is generated from your configuration
  • Container or managed runtime is provisioned on the selected cloud target
  • Secure endpoint URL is created
  • Agent is registered in your project

Multi-cloud

Agents, apps, and MCP servers share the same catalog-driven cloud targets. See the docs for the full service list.

5

Test & Invoke Your Agent

Once deployed, you can immediately test and invoke your agent.

Using the Console:

1.

Open your project's Playground tab, or navigate to your agent's detail page

2.

Use Form or JSON input (optionally attach multimodal files)

3.

Enter sample input data matching your input schema

4.

View the agent's response and verify it matches your expectations

Using the Python SDK:

from hikigai.appsdk import AppClient

client = AppClient(api_key="your-api-key", project_id="your-project-id")

# Invoke your agent
response = client.agent("clinical-note-summarizer").invoke({
    "transcription": "Patient presents with...",
    "patient_id": "12345"
})

print(response)

Using Platform API:

curl -X POST https://api.hikigai.com/v1/agents/clinical-note-summarizer/invoke \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "transcription": "Patient presents with...",
    "patient_id": "12345"
  }'

API Keys

Generate API keys from the API Keys page in your console.

Next Steps

Deploy an App

Ship full-stack apps from GitHub to GCP or AWS

Deploy MCP Servers

Run tool servers from GitHub; auto-register as connectors

Rooms & Event Bus

Realtime WebSocket rooms and project webhooks

Explore the SDK

AgentSDK, AppSDK, multi-cloud, events, and rooms

Platform API Reference

Complete Platform API documentation

Changelog

Rooms, Event Bus, multi-cloud, and more