API Reference

Agents

Create, read, update, and delete AI agents.

List agents

Returns your organization's agents, newest first. Soft-deleted agents are excluded.

Scope: agent:read ยท Rate limit: Read (120/min)

GET/organizations/{organization}/agents
AuthorizationBearer <token>

Bearer API key. Create one in your dashboard (Settings โ†’ API Keys); the full value is shown only once. Requires the organization owner on a premium or active AppSumo plan.

In: header

Path Parameters

organizationstring

Your organization's UUID.

Formatuuid

Query Parameters

status?string

Filter by state.

Value in"active" | "disabled"
id?string

Filter by AI model UUID โ€” returns only agents using that model.

Formatuuid
page?integer

Page number.

Default1
Range1 <= value
per_page?integer

Items per page.

Default25
Range1 <= value <= 100

Response Body

curl -X GET "https://api.assistloop.ai/api/public/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/agents?status=active&id=497f6eca-6276-4993-bfeb-53cbbbba6f08&page=1&per_page=25"
{
  "data": [
    {
      "id": "0c2e0b8a-6c1e-4f7e-9a3a-1b2c3d4e5f60",
      "name": "Support Bot",
      "description": "Answers product questions.",
      "model": {
        "id": "9b1c7e2a-3d4f-4a5b-8c6d-7e8f9a0b1c2d",
        "name": "GPT-4o",
        "slug": "gpt-4o"
      },
      "human_intervention": false,
      "only_human": false,
      "is_disabled": false,
      "disabled_reason": null,
      "created_at": "2026-06-01T10:15:30.000000Z",
      "updated_at": "2026-06-10T08:42:11.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 25,
    "total": 1,
    "last_page": 1,
    "request_id": "b7f0b9c2-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
  },
  "links": {
    "first": "https://api.assistloop.ai/api/public/v1/organizations/ORG/agents?page=1",
    "last": "https://api.assistloop.ai/api/public/v1/organizations/ORG/agents?page=1",
    "prev": null,
    "next": null
  }
}
{
  "message": "Unauthenticated."
}
{
  "error": {
    "code": "insufficient_scope",
    "message": "Token is missing required scope: source:create",
    "details": []
  },
  "meta": {
    "request_id": "b7f0b9c2-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
  }
}
{
  "error": {
    "code": "validation_failed",
    "message": "The content field is required.",
    "details": [
      {
        "field": "content",
        "message": "The content field is required."
      }
    ]
  },
  "meta": {
    "request_id": "b7f0b9c2-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
  }
}

Create an agent

Creates an agent in your organization. If you omit id, the first non-premium model is assigned automatically.

Scope: agent:create ยท Rate limit: Write (60/min)

POST/organizations/{organization}/agents
AuthorizationBearer <token>

Bearer API key. Create one in your dashboard (Settings โ†’ API Keys); the full value is shown only once. Requires the organization owner on a premium or active AppSumo plan.

In: header

Path Parameters

organizationstring

Your organization's UUID.

Formatuuid
namestring

Agent name.

Lengthlength <= 255
description?string | null
Lengthlength <= 5000
id?string

AI model UUID (must exist). A premium model on a non-premium plan returns 422.

Formatuuid

Response Body

curl -X POST "https://api.assistloop.ai/api/public/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/agents" \  -H "Content-Type: application/json" \  -d '{    "name": "Support Bot",    "description": "Answers product questions.",    "id": "9b1c7e2a-3d4f-4a5b-8c6d-7e8f9a0b1c2d"  }'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "model": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string"
    },
    "human_intervention": true,
    "only_human": true,
    "is_disabled": true,
    "disabled_reason": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
  }
}
{
  "message": "Unauthenticated."
}
{
  "error": {
    "code": "insufficient_scope",
    "message": "Token is missing required scope: source:create",
    "details": []
  },
  "meta": {
    "request_id": "b7f0b9c2-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "The name field is required.",
    "details": [
      {
        "field": "name",
        "message": "The name field is required."
      }
    ]
  },
  "meta": {
    "request_id": "b7f0b9c2-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
  }
}

Retrieve an agent

Scope: agent:read ยท Rate limit: Read (120/min)

GET/agents/{agent}
AuthorizationBearer <token>

Bearer API key. Create one in your dashboard (Settings โ†’ API Keys); the full value is shown only once. Requires the organization owner on a premium or active AppSumo plan.

In: header

Path Parameters

agentstring

The agent's UUID.

Formatuuid

Response Body

curl -X GET "https://api.assistloop.ai/api/public/v1/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "model": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string"
    },
    "human_intervention": true,
    "only_human": true,
    "is_disabled": true,
    "disabled_reason": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
  }
}
{
  "message": "Unauthenticated."
}
{
  "error": {
    "code": "insufficient_scope",
    "message": "Token is missing required scope: source:create",
    "details": []
  },
  "meta": {
    "request_id": "b7f0b9c2-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
  }
}
{
  "error": {
    "code": "resource_not_found",
    "message": "Source not found.",
    "details": []
  },
  "meta": {
    "request_id": "b7f0b9c2-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
  }
}

Update an agent

Partial update โ€” send only the fields you want to change. Changing the model or the intervention settings on a disabled agent returns 423 agent_unavailable; requesting a premium model or premium-only setting without a premium plan returns 422 premium_plan_required.

Scope: agent:edit ยท Rate limit: Write (60/min)

PATCH/agents/{agent}
AuthorizationBearer <token>

Bearer API key. Create one in your dashboard (Settings โ†’ API Keys); the full value is shown only once. Requires the organization owner on a premium or active AppSumo plan.

In: header

Path Parameters

agentstring

The agent's UUID.

Formatuuid
name?string
Lengthlength <= 255
description?string | null
Lengthlength <= 5000
id?string

New AI model UUID (must exist).

Formatuuid
human_intervention?boolean

Toggle human-intervention mode. Requires a premium plan.

only_human?boolean

Toggle human-only mode. Requires a premium plan.

Response Body

curl -X PATCH "https://api.assistloop.ai/api/public/v1/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "name": "Support Bot v2",    "human_intervention": true  }'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "model": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string"
    },
    "human_intervention": true,
    "only_human": true,
    "is_disabled": true,
    "disabled_reason": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
  }
}
{
  "message": "Unauthenticated."
}
{
  "error": {
    "code": "insufficient_scope",
    "message": "Token is missing required scope: source:create",
    "details": []
  },
  "meta": {
    "request_id": "b7f0b9c2-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
  }
}
{
  "error": {
    "code": "resource_not_found",
    "message": "Source not found.",
    "details": []
  },
  "meta": {
    "request_id": "b7f0b9c2-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "The name field must not be greater than 255 characters.",
    "details": [
      {
        "field": "name",
        "message": "The name field must not be greater than 255 characters."
      }
    ]
  },
  "meta": {
    "request_id": "b7f0b9c2-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
  }
}

{
  "error": {
    "code": "agent_unavailable",
    "message": "Agent is currently disabled.",
    "details": []
  },
  "meta": {
    "request_id": "b7f0b9c2-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
  }
}

Delete an agent

Soft-deletes the agent. Returns 204 No Content with an empty body.

Scope: agent:delete ยท Rate limit: Write (60/min)

DELETE/agents/{agent}
AuthorizationBearer <token>

Bearer API key. Create one in your dashboard (Settings โ†’ API Keys); the full value is shown only once. Requires the organization owner on a premium or active AppSumo plan.

In: header

Path Parameters

agentstring

The agent's UUID.

Formatuuid

Response Body

curl -X DELETE "https://api.assistloop.ai/api/public/v1/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty
{
  "message": "Unauthenticated."
}
{
  "error": {
    "code": "insufficient_scope",
    "message": "Token is missing required scope: source:create",
    "details": []
  },
  "meta": {
    "request_id": "b7f0b9c2-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
  }
}
{
  "error": {
    "code": "resource_not_found",
    "message": "Source not found.",
    "details": []
  },
  "meta": {
    "request_id": "b7f0b9c2-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
  }
}