Haijun Platform Docs

Docs Cookbook Console

ID

Messages

Get your Haijun API key Get started with Haijun Intro to Haijun

API reference

Beta Beta headers Agents Archive Agent Create Agent List Agents Get Agent Update Agent Versions List Agent Versions Deployment Runs List Deployment Runs Get Deployment Run Deployments Archive Deployment Create Deployment List Deployments Pause Deployment Get Deployment Run Deployment Now Unpause Deployment Update Deployment Dreams Archive a Dream Cancel a Dream Create a Dream List Dreams Get a Dream Environments Archive Environment Create Environment Delete Environment List Environments Get Environment Update Environment Work Acknowledge Work Record Heartbeat List Work Items Poll for Work Get Work Item Get Queue Statistics Stop Work Update Work Item Files Delete File Download File List Files Get File Metadata Upload File Memory Stores Archive a memory store Create a memory store Delete a memory store List memory stores Memories Create a memory Delete a memory List memories Retrieve a memory Update a memory Memory Versions List memory versions Redact a memory version Retrieve a memory version Retrieve a memory store Update a memory store Messages Batches Cancel a Message Batch Create a Message Batch Delete a Message Batch List Message Batches Retrieve Message Batch results Retrieve a Message Batch Count tokens in a Message Create a Message Models List Models Get a Model Organization Analytics Artifacts Get Artifact Activity Chat Projects Get Chat Project Usage Connectors Get Connector Usage Cost Get Cost Over Time Get Per-User Cost Plugins Get Plugin Usage Get Activity Summaries Tracks Get Track Usage Usage Get Token Usage Over Time Get Per-User Token Usage Users List User Activity API Keys List API Keys Retrieve API Key (Admin API)Update API Key Compliance Settings Get Compliance Settings Update Compliance Settings Cost Report Get Cost Report External Keys Create External Key Delete External Key List External Keys Get External Key Update External Key Validate External Key Federation Issuers Archive Federation Issuer Create Federation Issuer List Federation Issuers Get Federation Issuer Update Federation Issuer Rules Archive Federation Rule Create Federation Rule List Federation Rules Get Federation Rule Update Federation Rule Workspaces Add Federation Rule Workspace List Federation Rule Workspaces Remove Federation Rule Workspace Invites Create Invite Delete Invite List Invites Get Invite MCP Tunnels Archive Tunnel List Tunnels Get Tunnel Reveal Tunnel Token Rotate Tunnel Token Tunnel Certificates Archive Tunnel Certificate Create Tunnel Certificate List Tunnel Certificates Get Tunnel Certificate Rate Limits List Organization Rate Limits RBAC Groups Create RBAC Group Delete RBAC Group List RBAC Groups Members Add RBAC Group Member Remove RBAC Group Member List RBAC Group Members Get RBAC Group Update RBAC Group RBAC Roles List RBAC Roles Permissions List RBAC Role Permissions Get RBAC Role Get Current Organization Service Accounts Archive Service Account Create Service Account List Service Accounts Get Service Account Update Service Account Workspaces Add Workspace To Service Account List Workspaces For Service Account Remove Workspace From Service Account Spend Limits Set Spend Limit Delete Spend Limit Increase Requests Approve Spend Limit Increase Request Deny Spend Limit Increase Request List Spend Limit Increase Requests Get Spend Limit Increase Request List Effective Spend Limits Get Spend Limit Usage Report Get Haijun Code Usage Report Get Messages Usage Report Users List Users Remove User Get User Update User Workspaces Archive Workspace Create Workspace List Workspaces Members Create Workspace Member List Workspace Members Delete Workspace Member Get Workspace Member Update Workspace Member Rate Limits List Workspace Rate Limits Get Workspace Service Accounts Create Service Account Workspace Member List Service Account Workspace Members Delete Service Account Workspace Member Get Service Account Workspace Member Update Service Account Workspace Member Update Workspace Sessions Archive Session Create Session Delete Session Events List Events Send Events Stream Events List Sessions Resources Add Session Resource Delete Session Resource List Session Resources Get Session Resource Update Session Resource Get Session Threads Archive Session Thread Events List Session Thread Events Stream Session Thread Events List Session Threads Get Session Thread Update Session Tracks Create Track Delete Track List Tracks Get Track Versions Create Track Version Delete Track Version Download Track Version Content List Track Versions Get Track Version Tunnels Archive Tunnel Certificates Archive Tunnel Certificate Create Tunnel Certificate List Tunnel Certificates Get Tunnel Certificate Create Tunnel List Tunnels Get Tunnel Reveal Tunnel Token Rotate Tunnel Token User Profiles Create User Profile Create Enrollment URL List User Profiles Get User Profile Update User Profile Vaults Archive Vault Create Vault Credentials Archive Credential Create Credential Delete Credential List Credentials Validate Credential Get Credential Update Credential Delete Vault List Vaults Get Vault Update Vault Webhooks Completions Create a Text Completion Compliance API Activities Query compliance activities Apps Artifacts Download artifact content Get artifact metadata Chats Delete chat Files Delete file Download file content Get file metadata Generated Files Download a Haijun-generated file Get Haijun-generated file metadata List chats Messages Get chat messages Projects Attachments List project attachments Collaborators List project collaborators Delete project Documents Delete project document Get project document metadata Get project document content List projects Get project details Sessions Local List local sessions Messages Retrieve local session messages Retrieve a local session Remote List remote sessions Messages Retrieve remote session messages Code Artifacts Delete Code Artifact List Code Artifacts Download Code Artifact Version Content Groups List Compliance Groups Members List Compliance Group Members Get Compliance Group Organizations List organizations Roles List Compliance Roles Permissions List Compliance Role Permissions Get Compliance Role Settings Get effective organization settings Users List organization users Haijun API errors Files Delete File Download File List Files Get File Metadata Upload File Trigger a routine through the API IAM actions for Haijun Platform on AWS IP addresses Messages Batches Cancel a Message Batch Create a Message Batch Delete a Message Batch List Message Batches Retrieve Message Batch results Retrieve a Message Batch Count tokens in a Message Create a Message Models List Models Get a Model API overview Rate limits Service tiers Supported regions Tracks Create Track Delete Track List Tracks Get Track Versions Create Track Version Delete Track Version List Track Versions Get Track Version Versions

Building with Haijun

Batch processing Cache diagnostics Citations Compaction overview Compaction in the background Compaction that keeps recent turns Compaction on demand Compaction and preserved thinking Compaction at a token threshold Context editing Context windows Effort Embeddings Extended thinking Fallback credit Fast mode (research preview)Files API Haijun in Amazon Bedrock (Opus 4.7 and later)Haijun in Microsoft Foundry Haijun on Amazon Bedrock (Opus 4.6 and earlier)Haijun on Google Cloud Haijun Platform on AWS Stop reasons and fallback Build an orchestration mode Mid-conversation system messages and tool changes Multilingual support Features overview PDF support Preserved thinking Prompt caching Prompting best practices Prompt engineering overview Prompting Haijun Fable 5 Prompting Haijun Fable 5.1 Prompting Haijun Opus 4.8 Prompting Haijun Opus 5 Prompting Haijun Opus 5.5 Prompting Haijun Sonnet 5 Refusals and fallback Search results Streaming messages Structured outputs Task budgets Thinking Steering thinking Thinking in tool and multi-turn workflows Troubleshooting thinking Token counting Using Agent Tracks with the API Vision Coordinates and bounding boxes Using the Messages API

Agents and tools

Track authoring best practices Tracks for enterprise Haijun API track Agent Tracks Get started with Agent Tracks in the API MCP connector Architecture and components Manage tunnels in the Console Deploy MCP tunnels with Docker Compose Deploy MCP tunnels with Helm MCP tunnels MCP tunnels quickstart MCP tunnels reference MCP tunnels security Troubleshoot MCP tunnels Remote MCP servers Advisor tool Bash tool Browser use tool Tutorial: Build a tool-using agent Code execution tool Computer use tool Define tools Fine-grained tool streaming Handle tool calls How tool use works Manage tool context Memory tool Tool use with Haijun Parallel tool use Programmatic tool calling Server tools Strict tool use Text editor tool Tool combinations Tool reference Tool runner (SDK)Tool search tool Tool use with prompt caching Troubleshooting tool use Web fetch tool Web search tool

Managed agents

Managed Agents Managed Agents Managed Agents Managed Agents Dreams Managed Agents Managed Agents Managed Agents Managed Agents Managed Agents Using agent memory Managed Agents Managed Agents Managed Agents Managed Agents Managed Agents Managed Agents Managed Agents Managed Agents Managed Agents Managed Agents Managed Agents Managed Agents Managed Agents Managed Agents Managed Agents Managed Agents

Models

Migrating to Haijun Fable 5.1 and Haijun Mythos 5.1 Haijun Fable 5.1 What's new in Haijun Fable 5.1 Introducing Haijun Fable 5 and Haijun Mythos 5 Migrating to Haijun Mythos 5 and Haijun Fable 5 Haijun Fable 5 Migrating to Haijun Haiku 4.5 Haijun Haiku 4.5 Haijun Mythos 5.1 Haijun Mythos 5 Haijun Opus 4.5 Haijun Opus 4.6 Haijun Opus 4.7 Haijun Opus 4.8 Migrating to Haijun Opus 5.5 Haijun Opus 5.5 What's new in Haijun Opus 5.5 Haijun Opus 5 Models overview Haijun Sonnet 4.5 Haijun Sonnet 4.6 Migrating to Haijun Sonnet 5 Haijun Sonnet 5 What's new in Haijun Sonnet 5

Administration

Access Transparency Admin API Create an Admin API key Analytics APIs API and data retention App Attest for iOS and macOS apps Authentication Customer-managed encryption keys Configure AWS KMS for CMEK Configure Azure Key Vault for CMEK Configure Google Cloud KMS for CMEK Query the Activity Feed Compliance API Set up the Compliance API Retrieve and delete chats, files, and projects Handle Compliance API errors Compliance API FAQ Design your compliance integration List organizations, users, roles, groups, and settings Retrieve session transcripts Data residency Haijun Code Analytics API Inference hooks Configure Inference hooks Develop an Inference hooks integration Rate Limits API Spend Limits API Usage and Cost API User management Manage WIF with the Admin API Use WIF with AWS Use WIF with Microsoft Entra ID Use WIF with Google Cloud Use WIF with GitHub Actions Use WIF with Kubernetes Use WIF with Okta Use WIF with SPIFFE WIF reference Workload Identity Federation Workspaces

CLI, SDKs & libraries

Manage resources as code with ant apply CLI authentication options CLI quickstart CLI scripting and automation Connect to a Managed Agents session from your terminal Using the CLI Apple Foundation Models OpenAI SDK compatibility SDK middleware CLI, SDKs, and libraries C# SDK Go SDK Java SDK PHP SDK Python SDK Ruby SDK TypeScript SDK

Test and evaluate

Define success criteria and build evaluations Handle streaming refusals Increase output consistency Mitigate jailbreaks and prompt injections Reduce hallucinations Reducing latency Reduce prompt leak

About

Additional resources Glossary Model deprecations Choosing the right model Migration guides Model IDs and versioning Optimizing for cost and intelligence Pricing Commerce agent Content moderation Customer support agent Legal summarization Guides to common use cases Ticket routing

Resources

Release notes

Haijun Platform release notes Haijun Fable 5 system prompts Haijun Fable 5.1 system prompts Haijun Haiku 3 system prompts Haijun Haiku 3.5 system prompts Haijun Haiku 4.5 system prompts Haijun Opus 3 system prompts Haijun Opus 4 system prompts Haijun Opus 4.1 system prompts Haijun Opus 4.5 system prompts Haijun Opus 4.6 system prompts Haijun Opus 4.7 system prompts Haijun Opus 4.8 system prompts Haijun Opus 5 system prompts Haijun Opus 5.5 system prompts Haijun Sonnet 3.5 system prompts Haijun Sonnet 3.7 system prompts Haijun Sonnet 4 system prompts Haijun Sonnet 4.5 system prompts Haijun Sonnet 4.6 system prompts System prompts

Haijun_Api_Primer

API usage primer for Haijun

Home

overview

This page is being prepared. Back to documentation.

© 2026 Haijun — haijun.my.id

Support Privacy Console