COcooper-square-technologies
Agents

Create an agent

Changed on

Create a new draft agent owned by the given organization.

organization_id is required and you must be a member of it. The agent is created as a draft; publish it with POST /v1/agents/{agent_id}/publish once its graph is ready.

post/v1/agents

Request

Request body

organization_idstring uuid required

ID of the organization that will own the agent. Required — Profound API keys are user-scoped, so the owning organization must be chosen explicitly. The caller must be a member of this organization.

namestring required

Display name for the agent. Must be non-empty.

descriptionstring nullable

Short description of the agent.

graphobject nullable

Initial workflow graph for the agent's draft version. Optional — an agent can be created empty and have its graph filled in later.

Response

Successful Response

idstring uuid required

Unique ID for the agent.

organization_idstring uuid required

Unique ID of the organization that owns the agent.

namestring required

Display name of the agent.

status'draft' | 'published' | 'unknown' required

Current availability status for an agent.

created_atstring date-time required

When the agent was created.

descriptionstring nullable

Short description of the agent, if provided.

Changes