Import an Agent Config

post

{protocol}://{base-url}/ai/api/v1/config/agent/import

Import an Agent Config from a portable export payload.

Body Params

Portable agent configuration for export/import across instances.

name

string

required

Display name of the agent.

description

Description of the agent's purpose.

prompt

string

required

System prompt that defines the agent's behavior.

mode

string

enum

Defaults to tool_call

Execution mode: tool_call or codemode.

Allowed:

skill_names

array of strings

Skill names for codemode agents.

Skill Names

Tags

input_json_schema

object | null

JSON schema for agent input.

output_json_schema

object | null

JSON schema for agent output.

published_status

string

enum

Defaults to draft

Publication status of the agent on the source instance.

Allowed:

llm

object

required

LLM configuration reference.

llm_extra_config

object | null

Provider-specific LLM settings (e.g. reasoning effort, extended thinking).

Applied on import only when the same LLM provider is available on the target.

tools

array of objects

Tool configurations.

Tools

parameter_bindings

array | null

Parameter bindings for each tool, in the same order as tools.

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

201Successful Response

401Authentication required. No valid session cookie or bearer token provided, or authentication failed.

422Validation Error

500Internal server error during request processing.