# InteractiveAI - Documentation

## Agents

- [Interactive Agents](https://docs.interactive.ai/agents/readme.md): Interactive Agents — build, configure, and operate AI agents that hold conversations, run typed automations, call tools, and ground answers in your knowledge base.
- [Architecture](https://docs.interactive.ai/agents/concepts/architecture.md): How an Interactive Agent deployment fits together: the agent server, the InteractiveAI platform, the LLM router, MCP tool servers, storage, and the knowledge base.
- [Conversation lifecycle](https://docs.interactive.ai/agents/concepts/conversation-lifecycle.md): What happens inside the engine on every turn: policy matching, routine advancement, tool execution, the iteration loop, and event emission.
- [Policies](https://docs.interactive.ai/agents/concepts/policies.md): Policies are condition → action rules matched against every turn. They encode safety, compliance, tone, and business rules that apply across all routines.
- [Routines](https://docs.interactive.ai/agents/concepts/routines.md): Routines are graphs of nodes — chat, tool, and routing-only (fork) nodes connected by transitions. This page defines the node types and their runtime completion semantics.
- [Autonomous routines](https://docs.interactive.ai/agents/concepts/autonomous-routines.md): Autonomous routines run end-to-end without a conversation: typed JSON in via trigger endpoint or webhook, typed JSON out via signed callback.
- [Priorities, entailments & prerequisites](https://docs.interactive.ai/agents/concepts/priorities.md): Relationship declarations between routines and policies: priorities resolve conflicts, entailments chain policy activations, and requires keeps entities dormant until a tool has run. Without them, eve
- [Glossaries & macros](https://docs.interactive.ai/agents/concepts/glossaries-and-macros.md): Glossaries inject domain vocabulary into every turn; macros are reusable text blocks interpolated into routine chat nodes via ${macro-id}.
- [Prompts, language & preamble](https://docs.interactive.ai/agents/concepts/prompts.md): The system prompt defines persona and ground rules; the language directive controls reply language; the greeting opens the first turn; the preamble shapes mid-turn filler.
- [Tools](https://docs.interactive.ai/agents/concepts/tools.md): Tools are functions the agent calls — served by your MCP servers, plus three built-ins. Covers namespacing, declaration, auth, reevaluation tools, and tool-event injection.
- [Knowledge base & retrieval](https://docs.interactive.ai/agents/concepts/knowledge-base.md): Retrieval grounding for the agent: managed collections on the platform, or an external HTTP search endpoint you own. Exactly one, selected by type.
- [Models](https://docs.interactive.ai/agents/concepts/models.md): Per-stage model configuration: two lanes — customer-facing and evaluation — each with a default, per-stage overrides, and its own fallback mechanism. The lanes never cross.
- [Sessions, memory & state](https://docs.interactive.ai/agents/concepts/memory-and-state.md): Sessions, customers, context variables, metadata, step outputs, and the storage backends that persist them.
- [Startup evaluation](https://docs.interactive.ai/agents/concepts/startup-evaluation.md): What the engine derives about your routines at boot, which behavioural flags you author instead, and how the routing table is cached.
- [Quickstart](https://docs.interactive.ai/agents/guides/quickstart.md): Build your first agent on the InteractiveAI platform with the iai CLI: author one policy and one routine, stand up a tool server, deploy the agent, and talk to it through the chat UI or the SDK.
- [Authoring policies](https://docs.interactive.ai/agents/guides/authoring-policies.md): How to write policies that match when they should, act as intended, and don't fight your routines — patterns, anti-patterns, and a review checklist.
- [Authoring routines](https://docs.interactive.ai/agents/guides/authoring-routines.md): Building routines node by node: the golden rule, transitions and branching, tool chains, loops, common patterns, anti-patterns, and the pre-submit checklist.
- [Authoring autonomous routines](https://docs.interactive.ai/agents/guides/authoring-autonomous-routines.md): Build a typed automation end to end: schemas, the terminal emit\_output rule, timeouts, webhooks, triggering, and receiving the callback.
- [Connecting tools](https://docs.interactive.ai/agents/guides/connecting-tools.md): Stand up an MCP tool server, secure it, declare it in the manifest, and design tools the agent calls correctly.
- [Setting up the knowledge base](https://docs.interactive.ai/agents/guides/knowledge-base-setup.md): Provision retrieval grounding: a managed collection on the platform, or your own HTTP search endpoint. Includes field/slot contracts and verification steps.
- [Integration overview](https://docs.interactive.ai/agents/guides/integration-overview.md): The map of every way traffic flows between your systems and an agent — SDK conversations, event delivery, autonomous triggers and callbacks, third-party webhooks, and tool calls — with auth and links
- [Integrating the SDK](https://docs.interactive.ai/agents/guides/integrating-the-sdk.md): Connect any channel — a web UI, Zendesk, Slack, an IVR — to a running agent with the InteractiveAI Python SDK: sessions, messages, both event delivery modes, handover, and production patterns.
- [Deploying](https://docs.interactive.ai/agents/guides/deploying.md): The platform deploy lifecycle: prepare content and a manifest, declare the secret bundle, deploy on the InteractiveAI platform, and verify — plus updating, scaling, and a pre-flight checklist.
- [Observability](https://docs.interactive.ai/agents/guides/observability.md): Traces, structured logs, trace naming with your business identifiers, the retry-fallback signals, and the grep recipes that answer "what did the agent do?".
- [Manifest & content schemas](https://docs.interactive.ai/agents/reference/manifest.md): The annotated map of every manifest field, linking each block to its concept page, plus where the exact field-level schema reference lives.
- [HTTP API](https://docs.interactive.ai/agents/reference/http-api.md): The agent server's inbound HTTP surface: auth, health, autonomous trigger, webhooks, tool-event injection, routine graph, and the conversation API.
- [Events & callbacks](https://docs.interactive.ai/agents/reference/events-and-callbacks.md): Exact wire shapes: conversation events (polling and webhook delivery) and the autonomous callback payload, with status and error-code tables.
- [Session metadata](https://docs.interactive.ai/agents/reference/session-metadata.md): The keys the agent reads or writes on session.metadata, who owns each, and how they surface in traces.
- [Environment variables](https://docs.interactive.ai/agents/reference/environment.md): Environment configuration the platform sets on the agent: manifest env-refs (secrets) and fixed-name operator knobs, with defaults.
- [Built-in tools](https://docs.interactive.ai/agents/reference/built-in-tools.md): Call contracts for the built-in tools: emit\_output (terminates autonomous runs), reason (typed think-step inference), initiate\_human\_handoff (human escalation) and current\_datetime (engine-refreshed t
- [Limits & defaults](https://docs.interactive.ai/agents/reference/limits-and-defaults.md): Every default and cap in one table: manifest field defaults, operator env-var defaults, hardcoded model defaults, and behavioural constants.
- [Decisions-only models: activation, traversal, and thinking](https://docs.interactive.ai/agents/operations/jev-experiment.md): Configure decisions-only models for activation, traversal, and thinking, with confidence fallback, tracing, and release verification.
- [Troubleshooting](https://docs.interactive.ai/agents/operations/troubleshooting.md): Symptom-indexed fixes: boot failures, readiness stuck at 503, wrong agent behaviour, tool problems, autonomous failures, and performance issues.
- [Security](https://docs.interactive.ai/agents/operations/security.md): The agent's security model: bearer auth, HMAC webhooks, secret handling and rotation, callback allowlists, and network posture.
- [Versioning & compatibility](https://docs.interactive.ai/agents/operations/versioning.md): The five version axes of an agent deployment, the compatibility matrix, the upgrade procedure, and where machine-readable schemas and docs are published.
- [Shared routine graph lifecycle](https://docs.interactive.ai/agents/operations/routine-graph-lifecycle.md): Immutable shared routine graphs, replica initialization, recovery, and maintenance-only cleanup of obsolete versions.

## CLI

- [iai](https://docs.interactive.ai/cli/iai.md)
- [iai agents](https://docs.interactive.ai/cli/iai_agents.md)
- [iai agents activate](https://docs.interactive.ai/cli/iai_agents_activate.md)
- [iai agents catalog](https://docs.interactive.ai/cli/iai_agents_catalog.md)
- [iai agents compatibility-matrix](https://docs.interactive.ai/cli/iai_agents_compatibility-matrix.md)
- [iai agents create](https://docs.interactive.ai/cli/iai_agents_create.md)
- [iai agents deactivate](https://docs.interactive.ai/cli/iai_agents_deactivate.md)
- [iai agents delete](https://docs.interactive.ai/cli/iai_agents_delete.md)
- [iai agents describe](https://docs.interactive.ai/cli/iai_agents_describe.md)
- [iai agents diff](https://docs.interactive.ai/cli/iai_agents_diff.md)
- [iai agents get](https://docs.interactive.ai/cli/iai_agents_get.md)
- [iai agents list](https://docs.interactive.ai/cli/iai_agents_list.md)
- [iai agents log-fields](https://docs.interactive.ai/cli/iai_agents_log-fields.md)
- [iai agents logs](https://docs.interactive.ai/cli/iai_agents_logs.md)
- [iai agents port-forward](https://docs.interactive.ai/cli/iai_agents_port-forward.md)
- [iai agents replay](https://docs.interactive.ai/cli/iai_agents_replay.md)
- [iai agents restart](https://docs.interactive.ai/cli/iai_agents_restart.md)
- [iai agents revision](https://docs.interactive.ai/cli/iai_agents_revision.md)
- [iai agents revisions](https://docs.interactive.ai/cli/iai_agents_revisions.md)
- [iai agents schema](https://docs.interactive.ai/cli/iai_agents_schema.md)
- [iai agents update](https://docs.interactive.ai/cli/iai_agents_update.md)
- [iai api-keys](https://docs.interactive.ai/cli/iai_api-keys.md)
- [iai api-keys create](https://docs.interactive.ai/cli/iai_api-keys_create.md)
- [iai api-keys delete](https://docs.interactive.ai/cli/iai_api-keys_delete.md)
- [iai api-keys list](https://docs.interactive.ai/cli/iai_api-keys_list.md)
- [iai api-keys update](https://docs.interactive.ai/cli/iai_api-keys_update.md)
- [iai collections](https://docs.interactive.ai/cli/iai_collections.md)
- [iai collections chunks](https://docs.interactive.ai/cli/iai_collections_chunks.md)
- [iai collections chunks bulk-delete](https://docs.interactive.ai/cli/iai_collections_chunks_bulk-delete.md)
- [iai collections chunks count](https://docs.interactive.ai/cli/iai_collections_chunks_count.md)
- [iai collections chunks delete](https://docs.interactive.ai/cli/iai_collections_chunks_delete.md)
- [iai collections chunks get](https://docs.interactive.ai/cli/iai_collections_chunks_get.md)
- [iai collections chunks list](https://docs.interactive.ai/cli/iai_collections_chunks_list.md)
- [iai collections chunks patch](https://docs.interactive.ai/cli/iai_collections_chunks_patch.md)
- [iai collections chunks upsert](https://docs.interactive.ai/cli/iai_collections_chunks_upsert.md)
- [iai collections create](https://docs.interactive.ai/cli/iai_collections_create.md)
- [iai collections delete](https://docs.interactive.ai/cli/iai_collections_delete.md)
- [iai collections describe](https://docs.interactive.ai/cli/iai_collections_describe.md)
- [iai collections documents](https://docs.interactive.ai/cli/iai_collections_documents.md)
- [iai collections documents delete](https://docs.interactive.ai/cli/iai_collections_documents_delete.md)
- [iai collections documents get](https://docs.interactive.ai/cli/iai_collections_documents_get.md)
- [iai collections documents list](https://docs.interactive.ai/cli/iai_collections_documents_list.md)
- [iai collections list](https://docs.interactive.ai/cli/iai_collections_list.md)
- [iai collections patch](https://docs.interactive.ai/cli/iai_collections_patch.md)
- [iai collections schema](https://docs.interactive.ai/cli/iai_collections_schema.md)
- [iai collections search](https://docs.interactive.ai/cli/iai_collections_search.md)
- [iai collections search batch](https://docs.interactive.ai/cli/iai_collections_search_batch.md)
- [iai collections search by-id](https://docs.interactive.ai/cli/iai_collections_search_by-id.md)
- [iai collections search hybrid](https://docs.interactive.ai/cli/iai_collections_search_hybrid.md)
- [iai collections slots](https://docs.interactive.ai/cli/iai_collections_slots.md)
- [iai collections slots add](https://docs.interactive.ai/cli/iai_collections_slots_add.md)
- [iai collections slots delete](https://docs.interactive.ai/cli/iai_collections_slots_delete.md)
- [iai collections slots progress](https://docs.interactive.ai/cli/iai_collections_slots_progress.md)
- [iai collections slots reindex](https://docs.interactive.ai/cli/iai_collections_slots_reindex.md)
- [iai collections slots vacuum](https://docs.interactive.ai/cli/iai_collections_slots_vacuum.md)
- [iai collections stats](https://docs.interactive.ai/cli/iai_collections_stats.md)
- [iai comments](https://docs.interactive.ai/cli/iai_comments.md)
- [iai comments create](https://docs.interactive.ai/cli/iai_comments_create.md)
- [iai comments get](https://docs.interactive.ai/cli/iai_comments_get.md)
- [iai comments list](https://docs.interactive.ai/cli/iai_comments_list.md)
- [iai completion](https://docs.interactive.ai/cli/iai_completion.md)
- [iai completion bash](https://docs.interactive.ai/cli/iai_completion_bash.md)
- [iai completion fish](https://docs.interactive.ai/cli/iai_completion_fish.md)
- [iai completion powershell](https://docs.interactive.ai/cli/iai_completion_powershell.md)
- [iai completion zsh](https://docs.interactive.ai/cli/iai_completion_zsh.md)
- [iai databases](https://docs.interactive.ai/cli/iai_databases.md)
- [iai databases activate](https://docs.interactive.ai/cli/iai_databases_activate.md)
- [iai databases backup](https://docs.interactive.ai/cli/iai_databases_backup.md)
- [iai databases backups](https://docs.interactive.ai/cli/iai_databases_backups.md)
- [iai databases create](https://docs.interactive.ai/cli/iai_databases_create.md)
- [iai databases deactivate](https://docs.interactive.ai/cli/iai_databases_deactivate.md)
- [iai databases delete](https://docs.interactive.ai/cli/iai_databases_delete.md)
- [iai databases describe](https://docs.interactive.ai/cli/iai_databases_describe.md)
- [iai databases list](https://docs.interactive.ai/cli/iai_databases_list.md)
- [iai databases log-fields](https://docs.interactive.ai/cli/iai_databases_log-fields.md)
- [iai databases logs](https://docs.interactive.ai/cli/iai_databases_logs.md)
- [iai databases port-forward](https://docs.interactive.ai/cli/iai_databases_port-forward.md)
- [iai databases restore](https://docs.interactive.ai/cli/iai_databases_restore.md)
- [iai databases update](https://docs.interactive.ai/cli/iai_databases_update.md)
- [iai dataset-items](https://docs.interactive.ai/cli/iai_dataset-items.md)
- [iai dataset-items create](https://docs.interactive.ai/cli/iai_dataset-items_create.md)
- [iai dataset-items delete](https://docs.interactive.ai/cli/iai_dataset-items_delete.md)
- [iai dataset-items get](https://docs.interactive.ai/cli/iai_dataset-items_get.md)
- [iai dataset-items list](https://docs.interactive.ai/cli/iai_dataset-items_list.md)
- [iai dataset-runs](https://docs.interactive.ai/cli/iai_dataset-runs.md)
- [iai dataset-runs delete](https://docs.interactive.ai/cli/iai_dataset-runs_delete.md)
- [iai dataset-runs get](https://docs.interactive.ai/cli/iai_dataset-runs_get.md)
- [iai dataset-runs list](https://docs.interactive.ai/cli/iai_dataset-runs_list.md)
- [iai datasets](https://docs.interactive.ai/cli/iai_datasets.md)
- [iai datasets create](https://docs.interactive.ai/cli/iai_datasets_create.md)
- [iai datasets get](https://docs.interactive.ai/cli/iai_datasets_get.md)
- [iai datasets list](https://docs.interactive.ai/cli/iai_datasets_list.md)
- [iai files](https://docs.interactive.ai/cli/iai_files.md)
- [iai files delete](https://docs.interactive.ai/cli/iai_files_delete.md)
- [iai files download](https://docs.interactive.ai/cli/iai_files_download.md)
- [iai files get](https://docs.interactive.ai/cli/iai_files_get.md)
- [iai files list](https://docs.interactive.ai/cli/iai_files_list.md)
- [iai files restore](https://docs.interactive.ai/cli/iai_files_restore.md)
- [iai files update](https://docs.interactive.ai/cli/iai_files_update.md)
- [iai files upload](https://docs.interactive.ai/cli/iai_files_upload.md)
- [iai glossaries](https://docs.interactive.ai/cli/iai_glossaries.md)
- [iai glossaries create](https://docs.interactive.ai/cli/iai_glossaries_create.md)
- [iai glossaries delete](https://docs.interactive.ai/cli/iai_glossaries_delete.md)
- [iai glossaries diff](https://docs.interactive.ai/cli/iai_glossaries_diff.md)
- [iai glossaries get](https://docs.interactive.ai/cli/iai_glossaries_get.md)
- [iai glossaries list](https://docs.interactive.ai/cli/iai_glossaries_list.md)
- [iai glossaries schema](https://docs.interactive.ai/cli/iai_glossaries_schema.md)
- [iai glossaries update](https://docs.interactive.ai/cli/iai_glossaries_update.md)
- [iai glossaries versions](https://docs.interactive.ai/cli/iai_glossaries_versions.md)
- [iai images](https://docs.interactive.ai/cli/iai_images.md)
- [iai images build](https://docs.interactive.ai/cli/iai_images_build.md)
- [iai images delete](https://docs.interactive.ai/cli/iai_images_delete.md)
- [iai images list](https://docs.interactive.ai/cli/iai_images_list.md)
- [iai images push](https://docs.interactive.ai/cli/iai_images_push.md)
- [iai jobs](https://docs.interactive.ai/cli/iai_jobs.md)
- [iai jobs activate](https://docs.interactive.ai/cli/iai_jobs_activate.md)
- [iai jobs create](https://docs.interactive.ai/cli/iai_jobs_create.md)
- [iai jobs deactivate](https://docs.interactive.ai/cli/iai_jobs_deactivate.md)
- [iai jobs delete](https://docs.interactive.ai/cli/iai_jobs_delete.md)
- [iai jobs describe](https://docs.interactive.ai/cli/iai_jobs_describe.md)
- [iai jobs list](https://docs.interactive.ai/cli/iai_jobs_list.md)
- [iai jobs log-fields](https://docs.interactive.ai/cli/iai_jobs_log-fields.md)
- [iai jobs logs](https://docs.interactive.ai/cli/iai_jobs_logs.md)
- [iai jobs run](https://docs.interactive.ai/cli/iai_jobs_run.md)
- [iai jobs runs](https://docs.interactive.ai/cli/iai_jobs_runs.md)
- [iai jobs runs delete](https://docs.interactive.ai/cli/iai_jobs_runs_delete.md)
- [iai jobs runs describe](https://docs.interactive.ai/cli/iai_jobs_runs_describe.md)
- [iai jobs runs list](https://docs.interactive.ai/cli/iai_jobs_runs_list.md)
- [iai jobs runs logs](https://docs.interactive.ai/cli/iai_jobs_runs_logs.md)
- [iai jobs runs stop](https://docs.interactive.ai/cli/iai_jobs_runs_stop.md)
- [iai jobs update](https://docs.interactive.ai/cli/iai_jobs_update.md)
- [iai login](https://docs.interactive.ai/cli/iai_login.md)
- [iai logout](https://docs.interactive.ai/cli/iai_logout.md)
- [iai macros](https://docs.interactive.ai/cli/iai_macros.md)
- [iai macros create](https://docs.interactive.ai/cli/iai_macros_create.md)
- [iai macros delete](https://docs.interactive.ai/cli/iai_macros_delete.md)
- [iai macros diff](https://docs.interactive.ai/cli/iai_macros_diff.md)
- [iai macros get](https://docs.interactive.ai/cli/iai_macros_get.md)
- [iai macros list](https://docs.interactive.ai/cli/iai_macros_list.md)
- [iai macros schema](https://docs.interactive.ai/cli/iai_macros_schema.md)
- [iai macros update](https://docs.interactive.ai/cli/iai_macros_update.md)
- [iai macros versions](https://docs.interactive.ai/cli/iai_macros_versions.md)
- [iai mcps](https://docs.interactive.ai/cli/iai_mcps.md)
- [iai mcps activate](https://docs.interactive.ai/cli/iai_mcps_activate.md)
- [iai mcps catalog](https://docs.interactive.ai/cli/iai_mcps_catalog.md)
- [iai mcps connect](https://docs.interactive.ai/cli/iai_mcps_connect.md)
- [iai mcps create](https://docs.interactive.ai/cli/iai_mcps_create.md)
- [iai mcps deactivate](https://docs.interactive.ai/cli/iai_mcps_deactivate.md)
- [iai mcps delete](https://docs.interactive.ai/cli/iai_mcps_delete.md)
- [iai mcps describe](https://docs.interactive.ai/cli/iai_mcps_describe.md)
- [iai mcps diff](https://docs.interactive.ai/cli/iai_mcps_diff.md)
- [iai mcps disconnect](https://docs.interactive.ai/cli/iai_mcps_disconnect.md)
- [iai mcps list](https://docs.interactive.ai/cli/iai_mcps_list.md)
- [iai mcps log-fields](https://docs.interactive.ai/cli/iai_mcps_log-fields.md)
- [iai mcps logs](https://docs.interactive.ai/cli/iai_mcps_logs.md)
- [iai mcps port-forward](https://docs.interactive.ai/cli/iai_mcps_port-forward.md)
- [iai mcps restart](https://docs.interactive.ai/cli/iai_mcps_restart.md)
- [iai mcps revisions](https://docs.interactive.ai/cli/iai_mcps_revisions.md)
- [iai mcps run-tool](https://docs.interactive.ai/cli/iai_mcps_run-tool.md)
- [iai mcps tools](https://docs.interactive.ai/cli/iai_mcps_tools.md)
- [iai mcps update](https://docs.interactive.ai/cli/iai_mcps_update.md)
- [iai mcps verify](https://docs.interactive.ai/cli/iai_mcps_verify.md)
- [iai metrics](https://docs.interactive.ai/cli/iai_metrics.md)
- [iai metrics list](https://docs.interactive.ai/cli/iai_metrics_list.md)
- [iai observations](https://docs.interactive.ai/cli/iai_observations.md)
- [iai observations get](https://docs.interactive.ai/cli/iai_observations_get.md)
- [iai observations list](https://docs.interactive.ai/cli/iai_observations_list.md)
- [iai organizations](https://docs.interactive.ai/cli/iai_organizations.md)
- [iai organizations list](https://docs.interactive.ai/cli/iai_organizations_list.md)
- [iai organizations select](https://docs.interactive.ai/cli/iai_organizations_select.md)
- [iai policies](https://docs.interactive.ai/cli/iai_policies.md)
- [iai policies create](https://docs.interactive.ai/cli/iai_policies_create.md)
- [iai policies delete](https://docs.interactive.ai/cli/iai_policies_delete.md)
- [iai policies diff](https://docs.interactive.ai/cli/iai_policies_diff.md)
- [iai policies get](https://docs.interactive.ai/cli/iai_policies_get.md)
- [iai policies list](https://docs.interactive.ai/cli/iai_policies_list.md)
- [iai policies schema](https://docs.interactive.ai/cli/iai_policies_schema.md)
- [iai policies update](https://docs.interactive.ai/cli/iai_policies_update.md)
- [iai policies versions](https://docs.interactive.ai/cli/iai_policies_versions.md)
- [iai projects](https://docs.interactive.ai/cli/iai_projects.md)
- [iai projects list](https://docs.interactive.ai/cli/iai_projects_list.md)
- [iai projects select](https://docs.interactive.ai/cli/iai_projects_select.md)
- [iai prompts](https://docs.interactive.ai/cli/iai_prompts.md)
- [iai prompts create](https://docs.interactive.ai/cli/iai_prompts_create.md)
- [iai prompts delete](https://docs.interactive.ai/cli/iai_prompts_delete.md)
- [iai prompts diff](https://docs.interactive.ai/cli/iai_prompts_diff.md)
- [iai prompts get](https://docs.interactive.ai/cli/iai_prompts_get.md)
- [iai prompts list](https://docs.interactive.ai/cli/iai_prompts_list.md)
- [iai prompts update](https://docs.interactive.ai/cli/iai_prompts_update.md)
- [iai prompts versions](https://docs.interactive.ai/cli/iai_prompts_versions.md)
- [iai queue-items](https://docs.interactive.ai/cli/iai_queue-items.md)
- [iai queue-items create](https://docs.interactive.ai/cli/iai_queue-items_create.md)
- [iai queue-items delete](https://docs.interactive.ai/cli/iai_queue-items_delete.md)
- [iai queue-items get](https://docs.interactive.ai/cli/iai_queue-items_get.md)
- [iai queue-items list](https://docs.interactive.ai/cli/iai_queue-items_list.md)
- [iai queue-items update](https://docs.interactive.ai/cli/iai_queue-items_update.md)
- [iai queues](https://docs.interactive.ai/cli/iai_queues.md)
- [iai queues assign](https://docs.interactive.ai/cli/iai_queues_assign.md)
- [iai queues create](https://docs.interactive.ai/cli/iai_queues_create.md)
- [iai queues delete](https://docs.interactive.ai/cli/iai_queues_delete.md)
- [iai queues get](https://docs.interactive.ai/cli/iai_queues_get.md)
- [iai queues list](https://docs.interactive.ai/cli/iai_queues_list.md)
- [iai queues unassign](https://docs.interactive.ai/cli/iai_queues_unassign.md)
- [iai replicas](https://docs.interactive.ai/cli/iai_replicas.md)
- [iai replicas describe](https://docs.interactive.ai/cli/iai_replicas_describe.md)
- [iai replicas list](https://docs.interactive.ai/cli/iai_replicas_list.md)
- [iai replicas log-fields](https://docs.interactive.ai/cli/iai_replicas_log-fields.md)
- [iai replicas logs](https://docs.interactive.ai/cli/iai_replicas_logs.md)
- [iai router](https://docs.interactive.ai/cli/iai_router.md)
- [iai router info](https://docs.interactive.ai/cli/iai_router_info.md)
- [iai router keys](https://docs.interactive.ai/cli/iai_router_keys.md)
- [iai router keys create](https://docs.interactive.ai/cli/iai_router_keys_create.md)
- [iai router keys delete](https://docs.interactive.ai/cli/iai_router_keys_delete.md)
- [iai router keys list](https://docs.interactive.ai/cli/iai_router_keys_list.md)
- [iai router keys update](https://docs.interactive.ai/cli/iai_router_keys_update.md)
- [iai router models](https://docs.interactive.ai/cli/iai_router_models.md)
- [iai router models get](https://docs.interactive.ai/cli/iai_router_models_get.md)
- [iai router models list](https://docs.interactive.ai/cli/iai_router_models_list.md)
- [iai routines](https://docs.interactive.ai/cli/iai_routines.md)
- [iai routines create](https://docs.interactive.ai/cli/iai_routines_create.md)
- [iai routines delete](https://docs.interactive.ai/cli/iai_routines_delete.md)
- [iai routines diff](https://docs.interactive.ai/cli/iai_routines_diff.md)
- [iai routines get](https://docs.interactive.ai/cli/iai_routines_get.md)
- [iai routines list](https://docs.interactive.ai/cli/iai_routines_list.md)
- [iai routines schema](https://docs.interactive.ai/cli/iai_routines_schema.md)
- [iai routines update](https://docs.interactive.ai/cli/iai_routines_update.md)
- [iai routines versions](https://docs.interactive.ai/cli/iai_routines_versions.md)
- [iai run-items](https://docs.interactive.ai/cli/iai_run-items.md)
- [iai run-items create](https://docs.interactive.ai/cli/iai_run-items_create.md)
- [iai run-items list](https://docs.interactive.ai/cli/iai_run-items_list.md)
- [iai score-configs](https://docs.interactive.ai/cli/iai_score-configs.md)
- [iai score-configs create](https://docs.interactive.ai/cli/iai_score-configs_create.md)
- [iai score-configs get](https://docs.interactive.ai/cli/iai_score-configs_get.md)
- [iai score-configs list](https://docs.interactive.ai/cli/iai_score-configs_list.md)
- [iai score-configs update](https://docs.interactive.ai/cli/iai_score-configs_update.md)
- [iai scores](https://docs.interactive.ai/cli/iai_scores.md)
- [iai scores create](https://docs.interactive.ai/cli/iai_scores_create.md)
- [iai scores delete](https://docs.interactive.ai/cli/iai_scores_delete.md)
- [iai scores list](https://docs.interactive.ai/cli/iai_scores_list.md)
- [iai secrets](https://docs.interactive.ai/cli/iai_secrets.md)
- [iai secrets create](https://docs.interactive.ai/cli/iai_secrets_create.md)
- [iai secrets delete](https://docs.interactive.ai/cli/iai_secrets_delete.md)
- [iai secrets get](https://docs.interactive.ai/cli/iai_secrets_get.md)
- [iai secrets list](https://docs.interactive.ai/cli/iai_secrets_list.md)
- [iai secrets update](https://docs.interactive.ai/cli/iai_secrets_update.md)
- [iai services](https://docs.interactive.ai/cli/iai_services.md)
- [iai services activate](https://docs.interactive.ai/cli/iai_services_activate.md)
- [iai services create](https://docs.interactive.ai/cli/iai_services_create.md)
- [iai services deactivate](https://docs.interactive.ai/cli/iai_services_deactivate.md)
- [iai services delete](https://docs.interactive.ai/cli/iai_services_delete.md)
- [iai services describe](https://docs.interactive.ai/cli/iai_services_describe.md)
- [iai services diff](https://docs.interactive.ai/cli/iai_services_diff.md)
- [iai services list](https://docs.interactive.ai/cli/iai_services_list.md)
- [iai services log-fields](https://docs.interactive.ai/cli/iai_services_log-fields.md)
- [iai services logs](https://docs.interactive.ai/cli/iai_services_logs.md)
- [iai services port-forward](https://docs.interactive.ai/cli/iai_services_port-forward.md)
- [iai services restart](https://docs.interactive.ai/cli/iai_services_restart.md)
- [iai services revision](https://docs.interactive.ai/cli/iai_services_revision.md)
- [iai services revisions](https://docs.interactive.ai/cli/iai_services_revisions.md)
- [iai services sync](https://docs.interactive.ai/cli/iai_services_sync.md)
- [iai services update](https://docs.interactive.ai/cli/iai_services_update.md)
- [iai sessions](https://docs.interactive.ai/cli/iai_sessions.md)
- [iai sessions get](https://docs.interactive.ai/cli/iai_sessions_get.md)
- [iai sessions list](https://docs.interactive.ai/cli/iai_sessions_list.md)
- [iai skills](https://docs.interactive.ai/cli/iai_skills.md)
- [iai skills create](https://docs.interactive.ai/cli/iai_skills_create.md)
- [iai skills delete](https://docs.interactive.ai/cli/iai_skills_delete.md)
- [iai skills diff](https://docs.interactive.ai/cli/iai_skills_diff.md)
- [iai skills get](https://docs.interactive.ai/cli/iai_skills_get.md)
- [iai skills list](https://docs.interactive.ai/cli/iai_skills_list.md)
- [iai skills update](https://docs.interactive.ai/cli/iai_skills_update.md)
- [iai skills versions](https://docs.interactive.ai/cli/iai_skills_versions.md)
- [iai stacks](https://docs.interactive.ai/cli/iai_stacks.md)
- [iai stacks diff](https://docs.interactive.ai/cli/iai_stacks_diff.md)
- [iai stacks get](https://docs.interactive.ai/cli/iai_stacks_get.md)
- [iai stacks list](https://docs.interactive.ai/cli/iai_stacks_list.md)
- [iai stacks sync](https://docs.interactive.ai/cli/iai_stacks_sync.md)
- [iai traces](https://docs.interactive.ai/cli/iai_traces.md)
- [iai traces delete](https://docs.interactive.ai/cli/iai_traces_delete.md)
- [iai traces diff](https://docs.interactive.ai/cli/iai_traces_diff.md)
- [iai traces get](https://docs.interactive.ai/cli/iai_traces_get.md)
- [iai traces list](https://docs.interactive.ai/cli/iai_traces_list.md)
- [iai update](https://docs.interactive.ai/cli/iai_update.md)
- [iai variables](https://docs.interactive.ai/cli/iai_variables.md)
- [iai variables create](https://docs.interactive.ai/cli/iai_variables_create.md)
- [iai variables delete](https://docs.interactive.ai/cli/iai_variables_delete.md)
- [iai variables diff](https://docs.interactive.ai/cli/iai_variables_diff.md)
- [iai variables get](https://docs.interactive.ai/cli/iai_variables_get.md)
- [iai variables list](https://docs.interactive.ai/cli/iai_variables_list.md)
- [iai variables schema](https://docs.interactive.ai/cli/iai_variables_schema.md)
- [iai variables update](https://docs.interactive.ai/cli/iai_variables_update.md)
- [iai variables versions](https://docs.interactive.ai/cli/iai_variables_versions.md)

## SDK

- [Overview](https://docs.interactive.ai/sdk/readme.md)
- [Tracing](https://docs.interactive.ai/sdk/tracing.md)
- [Scoring](https://docs.interactive.ai/sdk/scoring.md)
- [Datasets](https://docs.interactive.ai/sdk/datasets.md)
- [Experiments](https://docs.interactive.ai/sdk/experiments.md)
- [Prompts](https://docs.interactive.ai/sdk/prompts.md)
- [Media](https://docs.interactive.ai/sdk/media.md)
- [Platform](https://docs.interactive.ai/sdk/platform.md)
- [Routines](https://docs.interactive.ai/sdk/routines.md)
- [Policies](https://docs.interactive.ai/sdk/policies.md)
- [Variables](https://docs.interactive.ai/sdk/variables.md)
- [Glossary](https://docs.interactive.ai/sdk/glossary.md)
- [Macros](https://docs.interactive.ai/sdk/macros.md)

## Schemas

- [Schemas 9.6.1](https://docs.interactive.ai/schemas/readme.md)
- [Schemas 9.6.1](https://docs.interactive.ai/schemas/9-6-1.md)
- [Schemas 9.6.0](https://docs.interactive.ai/schemas/9.6.0.md)
- [Schemas 9.5.0](https://docs.interactive.ai/schemas/9.5.0.md)
- [Schemas 9.4.0](https://docs.interactive.ai/schemas/9.4.0.md)
- [Schemas 9.3.0](https://docs.interactive.ai/schemas/9.3.0.md)
- [Schemas 9.2.0](https://docs.interactive.ai/schemas/9.2.0.md)
- [Schemas 9.1.0](https://docs.interactive.ai/schemas/9.1.0.md)
- [Schemas 9.0.0](https://docs.interactive.ai/schemas/9.0.0.md)
- [Schemas 8.4.0](https://docs.interactive.ai/schemas/8.4.0.md)
- [Schemas 8.3.0](https://docs.interactive.ai/schemas/8.3.0.md)
- [Schemas 8.2.0](https://docs.interactive.ai/schemas/8.2.0.md)
- [Schemas 8.1.0](https://docs.interactive.ai/schemas/8.1.0.md)
- [Schemas 8.0.0](https://docs.interactive.ai/schemas/8.0.0.md)
- [Schemas 7.0.0](https://docs.interactive.ai/schemas/7.0.0.md)
- [Schemas 6.1.5](https://docs.interactive.ai/schemas/6.1.5.md)
- [Schemas 6.1.4](https://docs.interactive.ai/schemas/6.1.4.md)
- [Schemas 6.1.3](https://docs.interactive.ai/schemas/6.1.3.md)
- [Schemas 6.1.2](https://docs.interactive.ai/schemas/6.1.2.md)
- [Schemas 6.1.1](https://docs.interactive.ai/schemas/6.1.1.md)
- [Schemas 6.1.0](https://docs.interactive.ai/schemas/6.1.0.md)
- [Schemas 6.0.0](https://docs.interactive.ai/schemas/6.0.0.md)
- [Schemas 5.0.1](https://docs.interactive.ai/schemas/5.0.1.md)
- [Schemas 5.0.0](https://docs.interactive.ai/schemas/5.0.0.md)
- [Schemas 4.0.0](https://docs.interactive.ai/schemas/4.0.0.md)
- [Schemas 3.0.0](https://docs.interactive.ai/schemas/3.0.0.md)
- [Schemas 2.1.0](https://docs.interactive.ai/schemas/2.1.0.md)

## LLM Router

- [Overview](https://docs.interactive.ai/llm-router/api-guides/overview.md): An overview of InteractiveAI's API
- [Streaming](https://docs.interactive.ai/llm-router/api-guides/streaming.md)
- [Embeddings](https://docs.interactive.ai/llm-router/api-guides/embeddings.md): Generate vector embbedings from text
- [Limits](https://docs.interactive.ai/llm-router/api-guides/limits.md): Rate Limits
- [Authentication](https://docs.interactive.ai/llm-router/api-guides/authentication.md): API Authentication
- [Parameters](https://docs.interactive.ai/llm-router/api-guides/parameters.md)
- [Errors and Debugging](https://docs.interactive.ai/llm-router/api-guides/errors-and-debugging.md): API Errors and Debugging
- [Supported Models](https://docs.interactive.ai/llm-router/api-guides/supported-models.md)
- [Load Balancing & Model Fallback](https://docs.interactive.ai/llm-router/api-guides/load-balancing-and-model-fallback.md)
- [Responses](https://docs.interactive.ai/llm-router/api-reference/responses.md)
- [OAuth](https://docs.interactive.ai/llm-router/api-reference/oauth.md)
- [Analytics](https://docs.interactive.ai/llm-router/api-reference/analytics.md)
- [Credits](https://docs.interactive.ai/llm-router/api-reference/credits.md)
- [Embeddings](https://docs.interactive.ai/llm-router/api-reference/embeddings.md)
- [Submit an embedding request](https://docs.interactive.ai/llm-router/api-reference/embeddings/submit-an-embedding-request.md)
- [List all embeddings models](https://docs.interactive.ai/llm-router/api-reference/embeddings/list-all-embeddings-models.md)
- [Generations](https://docs.interactive.ai/llm-router/api-reference/generations.md)
- [Get request & usage metadata for a generation](https://docs.interactive.ai/llm-router/api-reference/generations/get-request-and-usage-metadata-for-a-generation.md)
- [Models](https://docs.interactive.ai/llm-router/api-reference/models.md)
- [Endpoints](https://docs.interactive.ai/llm-router/api-reference/endpoints.md)
- [Parameters](https://docs.interactive.ai/llm-router/api-reference/parameters.md)
- [Providers](https://docs.interactive.ai/llm-router/api-reference/providers.md)
- [API Keys](https://docs.interactive.ai/llm-router/api-reference/api-keys.md)
- [Chat](https://docs.interactive.ai/llm-router/api-reference/chat.md)
- [Completions](https://docs.interactive.ai/llm-router/api-reference/completions.md)

## Platform Documentation

- [InteractiveAI Platform](https://docs.interactive.ai/interactiveai-platform.md)
- [Platform Fundamentals](https://docs.interactive.ai/platform-fundamentals.md)
- [Home](https://docs.interactive.ai/home.md)
- [Policies](https://docs.interactive.ai/context/policies.md)
- [Routines](https://docs.interactive.ai/context/routines.md)
- [Macros](https://docs.interactive.ai/context/macros.md)
- [Prompts](https://docs.interactive.ai/context/prompts.md)
- [Knowledge](https://docs.interactive.ai/context/knowledge.md)
- [How Agents Process a Turn](https://docs.interactive.ai/context/how-agents-process-a-turn.md)
- [Router](https://docs.interactive.ai/connectors/router.md)
- [Integrations](https://docs.interactive.ai/connectors/integrations.md)
- [Services](https://docs.interactive.ai/infrastructure/services.md)
- [Databases](https://docs.interactive.ai/infrastructure/databases.md)
- [Secrets](https://docs.interactive.ai/infrastructure/secrets.md)
- [Observability](https://docs.interactive.ai/governance/observability.md)
- [Analytics](https://docs.interactive.ai/governance/analytics.md)
- [Logs](https://docs.interactive.ai/governance/logs.md)
- [Reports](https://docs.interactive.ai/governance/reports.md)
- [Scores](https://docs.interactive.ai/improvement/scores.md)
- [Evaluators](https://docs.interactive.ai/improvement/evaluators.md)
- [Datasets](https://docs.interactive.ai/improvement/datasets.md)
- [Annotations](https://docs.interactive.ai/improvement/annotations.md)
- [InteractiveAI Copilot](https://docs.interactive.ai/copilot/interactiveai-copilot.md)
- [Protected Prompt Labels](https://docs.interactive.ai/settings/protected-prompt-labels.md)
- [Score Configs](https://docs.interactive.ai/settings/score-configs.md)
- [Members](https://docs.interactive.ai/settings/members.md)
- [Custom LLMs](https://docs.interactive.ai/settings/custom-llms.md)
- [Exports](https://docs.interactive.ai/settings/exports.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.interactive.ai/index.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.