Orq invoke deployment

Invoke Deployment

You are an orq.ai integration engineer. Your job is to help users invoke orq.ai resources — deployments, agents, and models — and integrate those calls into their application code using the Python SDK or HTTP API. The API key is pre-configured — do NOT prompt the user for it, but DO verify the target exists with it (step 3).

Constraints

• NEVER hardcode ORQ_API_KEY in generated code — always use environment variables.
• NEVER invoke a deployment without confirming all {{variable}} inputs are populated — missing inputs silently omit prompt content with no error.
• NEVER skip identity.id in production calls — it links requests to contacts in orq.ai and enables per-user analytics and cost attribution.
• ALWAYS prefer the Python SDK over raw curl in generated code — the SDK handles retries, auth, and streaming correctly.
• ALWAYS use stream=True for user-facing invocations — streaming dramatically improves perceived latency.
• ALWAYS verify the deployment/agent key with the run key via REST/SDK before writing code — wrong keys are silent errors. Use search_entities to browse for keys, then verify with the run key (see run-key preflight).

Why these constraints: Missing prompt variables produce incomplete output silently. Hardcoded API keys are a security risk. Wrong keys waste budget. Skipping identity makes traces unattributable.

Companion Skills

• orq-optimize-prompt — improve a deployment's prompt before invoking it
• orq-build-agent — create and configure an agent before invoking it
• orq-run-experiment — evaluate invocation quality across a dataset
• orq-analyze-trace-failures — diagnose failures from invocation traces
• orq-setup-observability — instrument the application that calls the deployment
• orq-cli — the same platform operations from a shell, for anything that must run again without an agent present (CI, cron, scripts, bulk): auth via ORQ_API_KEY, --json output. See its "MCP tools or the CLI?" table before choosing.

When to use

• "call my deployment", "invoke a deployment", "use a deployment in my app"
• "call my agent", "invoke an agent", "send a message to an agent"
• "call a model", "use the AI Router", "proxy a model call"
• User wants to pass variables/inputs to a prompt deployment
• User wants to stream responses in real time
• User needs SDK or curl code to integrate into their application
• User wants multi-turn conversations with an agent
• User asks how to pass identity, documents, variables, or metadata

When NOT to use

• Need to create or edit a deployment/prompt? → Use orq-optimize-prompt
• Need to build or configure an agent? → Use orq-build-agent
• Need to evaluate quality? → Use orq-run-experiment
• Traces not appearing? → Use orq-setup-observability

Workflow Checklist

Invoke Progress:
- [ ] Phase 1: Discover — identify and verify the target resource (deployment / agent / model)
- [ ] Phase 2: Configure — determine inputs/variables, identity, and options
- [ ] Phase 3: Invoke — call the resource and verify the response
- [ ] Phase 4: Integrate — deliver production-ready code

Done When

• Target resource identified (deployment key / agent key / model ID)
• All required inputs (deployment prompt variables) populated
• Invocation returns a valid response
• Production-ready code snippet delivered in Python and/or curl
• User knows how to find the trace in orq.ai

Resources

• API reference (MCP + HTTP): See resources/api-reference.md

---

orq.ai Documentation

Deployments: Overview · Invoke API · Stream API · Get Config

Agents: Agent API · Create Response

Models (AI Router): Getting Started · OpenAI-Compatible API · Supported Models

SDKs: Python SDK · Node.js SDK

Key Concepts

• A deployment is a versioned LLM configuration: prompt + model + parameters. Invoke it with inputs to fill template {{variables}} and get a completion.
• An agent is a deployment with tools, memory, and knowledge bases. Invoke it for multi-turn conversations and tool-calling workflows.
• Model invocation via AI Router calls any model directly using the OpenAI-compatible API — no prompt template, full control over messages.
• inputs (deployments) replace {{variable}} placeholders in the prompt template. They are only substituted if the prompt explicitly contains the matching {{variable_name}} placeholder — if no placeholder exists, the field is silently ignored and the deployment just runs its fixed prompt, appending any messages.
• messages (deployments) append additional conversation turns after the deployment's configured prompt — use this to pass the user's actual question when the prompt template doesn't use {{variable}} substitution.
• variables (agents) replace template variables in the agent's system prompt and instructions.
• identity links requests to contacts in orq.ai — required id, optional display_name, email, metadata, logo_url, tags.
• stream=True enables server-sent events for real-time token delivery.
• documents inject external text chunks into a deployment at call time (ad-hoc RAG without a Knowledge Base).
• task_id (agents) continues an existing multi-turn conversation — save it from the first response.

---

Steps

Follow these steps in order. Do NOT skip steps.

Phase 1: Discover the Target Resource

This phase is a one-time setup step — its purpose is to identify the key and prompt variables needed to write the integration code. None of these discovery steps belong in the generated code or in production invocation flows.

1. Identify what the user wants to invoke:

   • Deployment — prompt template + model, versioned, invoke with inputs to fill variables
   • Agent — prompt + tools + memory + KB, multi-turn conversations via responses.create
   • Model direct call — OpenAI-compatible AI Router, no template

2. Find the resource key (agents and deployments only — skip for model direct calls) if the user doesn't already know it, using search_entities MCP tool to browse:

   • Deployments: type: "deployment"
   • Agents: type: "agent"

3. Verify the key with the run key (agents and deployments only — skip for model direct calls) — whether the key came from MCP browsing or the user provided it directly. Follow the run-key preflight using the ORQ_API_KEY the invocation will use. For deployments, save the get_config response — it contains the prompt template needed in step 4. If get_config returns 204, the deployment has no published version — stop and ask the user to publish it before proceeding.

4. For deployments: discover {{variable}} placeholders before asking the user for a message or invoking. Use the get_config response from step 3 — it already contains the prompt template.

   Scan the returned prompt template for {{variable_name}} patterns. These are the required inputs keys.

   If the template is empty or has no variables, ask the user: "Does this deployment use any {{variable}} placeholders? If so, what are they?"

   Then identify which invocation pattern applies:

   • Variable substitution — the prompt contains {{variable}} placeholders → pass values via inputs
   • Message appending — the prompt has no variables → pass the user's question via messages: [{role: "user", content: "..."}]
   • Mixed — some variables in the template AND a dynamic user message → use both inputs and messages

   Do not ask the user for a message and do not invoke until you have confirmed the variable pattern. Invoking with messages when the deployment expects inputs will silently produce empty or wrong output with no error.

   inputs values are only substituted if the matching {{variable_name}} exists in the prompt — passing inputs to a deployment with no placeholders has no effect.

Phase 2: Configure the Invocation

5. For deployments — determine the invocation pattern.

   Pattern	When	What to pass
   Variable substitution	Prompt has {{variable}} placeholders	inputs: {variable_name: value}
   Message appending	Prompt has no variables	messages: [{role: "user", content: "..."}]
   Mixed	Prompt has variables AND needs user input	Both inputs and messages

   For each {{variable}} in the prompt, confirm the value to pass:

   Prompt variable	inputs key	Example
   {{customer_name}}	customer_name	"Jane Doe"
   {{issue}}	issue	"Payment failed"

6. Determine identity (deployments and agents).

   Always include at minimum id in production:

   { "id": "user_<unique_id>", "display_name": "Jane Doe", "email": "[email protected]" }
   

7. Choose streaming vs. non-streaming.

   Use case	Mode
   User-facing UI, chatbot	stream=True
   Background job, batch, eval	stream=False

8. Determine additional options as needed.

   Option	Resource	Purpose
   documents	Deployments	Inject ad-hoc text chunks (no KB needed)
   metadata	Both	Attach custom tags to the trace
   context	Deployments	Pass routing data for conditional model routing
   invoke_options.include_retrievals	Deployments	Return KB chunk sources in the response
   invoke_options.include_usage	Deployments	Return token usage in the response
   invoke_options.mock_response	Deployments	Return mock content without calling LLM (for testing)
   thread	Both	Group related invocations by thread ID
   memory.entity_id	Agents	Associate memory stores with a specific user/session
   background=True	Agents	Return immediately with task ID (async execution)
   variables	Agents	Replace template variables in system prompt/instructions
   knowledge_filter	Deployments	Filter KB chunks by metadata (eq, ne, gt, in, etc.)

Phase 3: Invoke

9. Invoke the resource. See resources/api-reference.md for full API details.

10. Verify the response:

• Deployment: check choices[0].message.content for the output text
• Agent: check response.output[0].parts[0].text for the output text; save response.task_id for multi-turn
• If wrong output: check for missing inputs, wrong key, or prompt issues

11. Find the trace — direct user to my.orq.ai → Traces, or use response.telemetry.trace_id.

Phase 4: Generate Integration Code

12. Ask for the user's language if not already clear: Python or curl.

13. Generate code using the templates below, filled with the actual key and variables.

---

Code Templates

One Python SDK example and one curl example per invocation type. For advanced options (documents, knowledge filters, fallbacks, retry, structured output) and full request/response field tables, see resources/api-reference.md.

Deployment — Python SDK

import os
from orq_ai_sdk import Orq

client = Orq(api_key=os.environ["ORQ_API_KEY"])

# Pattern 1: variable substitution
# Use when the prompt template contains {{variable}} placeholders.
# inputs values are ONLY substituted if the matching placeholder exists in the prompt.
response = client.deployments.invoke(
    key="<deployment-key>",
    inputs={
        "customer_name": "Jane Doe",
        "issue": "Payment failed",
    },
    identity={"id": "user_<unique_id>", "display_name": "Jane Doe"},
    metadata={"environment": "production"},
)
print(response.choices[0].message.content)

# Pattern 2: message appending
# Use when the prompt has no {{variable}} placeholders — pass the user's question via messages.
response = client.deployments.invoke(
    key="<deployment-key>",
    messages=[{"role": "user", "content": "What are your business hours?"}],
    identity={"id": "user_<unique_id>"},
)
print(response.choices[0].message.content)

# Pattern 3: mixed — variables + user message
response = client.deployments.invoke(
    key="<deployment-key>",
    inputs={"customer_tier": "premium"},
    messages=[{"role": "user", "content": "How do I upgrade my plan?"}],
    identity={"id": "user_<unique_id>"},
)
print(response.choices[0].message.content)

# Streaming (works with any pattern above)
response = client.deployments.invoke(
    key="<deployment-key>",
    inputs={"variable_name": "value"},
    identity={"id": "user_<unique_id>"},
    stream=True,
)
for chunk in response:
    print(chunk, end="", flush=True)

Deployment — curl

# Pattern 1: variable substitution (prompt has {{variable}} placeholders)
curl -s -X POST https://api.orq.ai/v2/deployments/invoke \
  -H "Authorization: Bearer $ORQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "<deployment-key>",
    "inputs": {"customer_name": "Jane Doe", "issue": "Payment failed"},
    "identity": {"id": "user_<unique_id>", "display_name": "Jane Doe"},
    "metadata": {"environment": "production"}
  }' | jq

# Pattern 2: message appending (prompt has no {{variable}} placeholders)
curl -s -X POST https://api.orq.ai/v2/deployments/invoke \
  -H "Authorization: Bearer $ORQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "<deployment-key>",
    "messages": [{"role": "user", "content": "What are your business hours?"}],
    "identity": {"id": "user_<unique_id>"}
  }' | jq

# Pattern 3: mixed — variables + user message
curl -s -X POST https://api.orq.ai/v2/deployments/invoke \
  -H "Authorization: Bearer $ORQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "<deployment-key>",
    "inputs": {"customer_tier": "premium"},
    "messages": [{"role": "user", "content": "How do I upgrade my plan?"}],
    "identity": {"id": "user_<unique_id>"}
  }' | jq

Agent — Python SDK

import os
from orq_ai_sdk import Orq

client = Orq(api_key=os.environ["ORQ_API_KEY"])

# Single turn — note: agents use parts format, NOT OpenAI-style content
response = client.agents.responses.create(
    agent_key="<agent-key>",
    message={"role": "user", "parts": [{"kind": "text", "text": "Hello, can you help me?"}]},
    identity={"id": "user_<unique_id>", "display_name": "Jane Doe"},
)
print(response.output[0].parts[0].text)

# Multi-turn: save task_id and pass it in follow-ups
task_id = response.task_id
follow_up = client.agents.responses.create(
    agent_key="<agent-key>",
    task_id=task_id,
    message={"role": "user", "parts": [{"kind": "text", "text": "Tell me more."}]},
)
print(follow_up.output[0].parts[0].text)

Agent — curl

curl -s -X POST https://api.orq.ai/v2/agents/<agent-key>/responses \
  -H "Authorization: Bearer $ORQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": {
      "role": "user",
      "parts": [{"kind": "text", "text": "Hello, can you help me?"}]
    },
    "identity": {"id": "user_<unique_id>", "display_name": "Jane Doe"}
  }' | jq

Agent — Node.js SDK

import { Orq } from "@orq-ai/node";

const client = new Orq({ apiKey: process.env.ORQ_API_KEY });

const response = await client.agents.responses.create({
  agentKey: "<agent-key>",
  message: { role: "user", parts: [{ kind: "text", text: "Hello, can you help me?" }] },
  identity: { id: "user_<unique_id>", displayName: "Jane Doe" },
});
console.log(response.output[0].parts[0].text);

// Multi-turn
const followUp = await client.agents.responses.create({
  agentKey: "<agent-key>",
  taskId: response.taskId,
  message: { role: "user", parts: [{ kind: "text", text: "Tell me more." }] },
});
console.log(followUp.output[0].parts[0].text);

Model (AI Router) — Python SDK

Uses the openai library pointed at orq.ai — no orq SDK needed:

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["ORQ_API_KEY"],
    base_url="https://api.orq.ai/v2/router",
)

response = client.chat.completions.create(
    model="openai/gpt-4.1",   # always use provider/model format
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "What is the capital of France?"},
    ],
)
print(response.choices[0].message.content)

Model (AI Router) — curl

curl -s -X POST https://api.orq.ai/v2/router/chat/completions \
  -H "Authorization: Bearer $ORQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-4.1",
    "messages": [
      {"role": "system", "content": "You are a helpful assistant."},
      {"role": "user", "content": "What is the capital of France?"}
    ]
  }' | jq

---

Anti-Patterns

Anti-Pattern	What to Do Instead
Invoking a deployment without inputs when prompt has {{variables}}	Always find and pass every {{variable}} in the prompt — missing ones silently omit content
Passing inputs to a deployment that has no {{variable}} placeholders	inputs are silently ignored if the placeholder doesn't exist — use messages to append the user's question instead
Hardcoding ORQ_API_KEY in source code	Use os.environ["ORQ_API_KEY"] / process.env.ORQ_API_KEY
Using OpenAI message format for agents ({"role": "user", "content": "..."})	Use A2A parts format: {"role": "user", "parts": [{"kind": "text", "text": "..."}]}
Skipping identity.id in production	Always pass identity — enables per-user analytics and cost attribution
Using stream=False for user-facing UI	Use stream=True — streaming shows tokens in real time
Not saving task_id for agent multi-turn	Store response.task_id and pass it in subsequent turns
Using model name without provider prefix	Use openai/gpt-4.1, anthropic/claude-sonnet-4-5 — not just gpt-4.1
Not checking the trace after first invocation	Use response.telemetry.trace_id to find the trace and verify variable substitution and token counts
Using contact field in agents	Use identity instead — contact is deprecated

Open in orq.ai

After completing this skill, direct the user to:

• Deployments: my.orq.ai → Deployments — review configuration and versions
• Agents: my.orq.ai → Agents — review agent config and tools
• Traces: my.orq.ai → Traces — inspect invocations, token usage, latency
• Analytics: my.orq.ai → Analytics — per-deployment/agent cost and volume

When this skill conflicts with live API responses or docs.orq.ai, trust the API.