Skip to main content
POST
Create a new agent

Authorizations

Authorization
string
header
required

Your iwy Service API Key. Find it at app.iwy.ai/settings.

Include it in the Authorization header:

Body

application/json
name
string
required

Human-readable name for the agent

Example:

"Customer Service Bot"

configuration
object
required

Agent behavior and capabilities configuration

publish_status
enum<string>
default:draft

Initial visibility status

Available options:
draft,
private,
public
metadata
object

Additional metadata

Response

Agent created successfully

Complete agent configuration

id
string<uuid>
required

Unique identifier for the agent

user_id
string<uuid>
required

ID of the user who owns this agent

name
string
required

Human-readable name of the agent

configuration
object
required

Agent behavior and capabilities configuration

publish_status
enum<string>
default:draft

Visibility and accessibility status:

  • draft: In development, not accessible
  • private: Active but not publicly discoverable
  • public: Fully active and discoverable
Available options:
draft,
private,
public
metadata
object

Additional metadata for internal use