Skip to main content
POST
Register agent environment

Authorizations

Authorization
string
header
required

A VisIQ API key presented as Authorization: Bearer vq_prod_.... Mint harness keys under Settings → Harness Keys and API keys under Settings → API Keys in the dashboard.

Body

application/json
agent_id
string
required
Required string length: 1 - 255
os
string
Maximum string length: 255
hostname
string
Maximum string length: 255
ip
string
Maximum string length: 255
username
string
Maximum string length: 255
kind
enum<string>
Available options:
sdk,
cli_harness
model
string | null

The model the agent runs on

Maximum string length: 255
system_prompt
string | null

The agent's system prompt

Maximum string length: 65536
tool_schemas
any[] | null

The agent's tool definitions, if the harness can read them.

Maximum array length: 256
agent_type
enum<string>
Available options:
langchain,
openclaw,
llamaindex,
autogen,
crewai,
semantic_kernel,
vercel_ai,
mastra,
voltagent,
openai_agents,
claude-code,
unknown

Response

Acknowledgement.

ok
boolean
required
agent_id
string
required