API

Agentix API endpoints

Documented Agentix API routes, parameters, and response examples.

Available endpoints

List collections

GET /api/public/v1/collections. Lists every collection available to the site identified by the API key.

json

{
  "collections": [
    {
      "name": "Posts",
      "slug": "posts",
      "fields": [
        {
          "key": "title",
          "type": "text",
          "required": true
        }
      ],
      "is_system": false
    }
  ]
}

List collection items

GET /api/public/v1/collections/{collection_slug}. Lists items in one collection, including drafts, with offset pagination.

Parameter	Location	Required	Description
`collection_slug`	path	Yes	The collection API slug.
`limit`	query	No	Items to return, from 1 to 1000.
`offset`	query	No	Items to skip.

json

{
  "collection": {
    "name": "Posts",
    "slug": "posts",
    "fields": [
      {
        "key": "title",
        "type": "text",
        "required": true
      }
    ],
    "is_system": false
  },
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "title": "Welcome",
      "is_published": true,
      "created_at": "2026-10-01T12:00:00Z",
      "updated_at": "2026-10-01T12:00:00Z"
    }
  ],
  "limit": 100,
  "offset": 0
}

Get collection item

GET /api/public/v1/collections/{collection_slug}/{item_id}. Returns one collection item by UUID.

Parameter	Location	Required	Description
`collection_slug`	path	Yes	The collection API slug.
`item_id`	path	Yes	The UUID of the collection item.

json

{
  "item": {
    "id": "00000000-0000-4000-8000-000000000001",
    "title": "Welcome",
    "is_published": true,
    "created_at": "2026-10-01T12:00:00Z",
    "updated_at": "2026-10-01T12:00:00Z"
  }
}

Write endpoints

Create collection item

POST /api/public/v1/collections/{collection_slug}. Creates an item in a non-system collection.

Parameter	Location	Required	Description
`collection_slug`	path	Yes	The collection API slug.
`data`	body	Yes	A JSON object containing fields defined by the collection.
`is_published`	body	No	Whether the item is publicly published.

json

{
  "item": {
    "id": "00000000-0000-4000-8000-000000000001",
    "title": "Welcome",
    "is_published": true,
    "created_at": "2026-10-01T12:00:00Z",
    "updated_at": "2026-10-01T12:00:00Z"
  }
}

Update collection item

PATCH /api/public/v1/collections/{collection_slug}/{item_id}. Merges fields into an existing item in a non-system collection.

Parameter	Location	Required	Description
`collection_slug`	path	Yes	The collection API slug.
`item_id`	path	Yes	The UUID of the collection item.
`data`	body	Yes	A JSON object containing fields defined by the collection.
`is_published`	body	No	Whether the item is publicly published.

json

{
  "item": {
    "id": "00000000-0000-4000-8000-000000000001",
    "title": "Welcome",
    "is_published": true,
    "created_at": "2026-10-01T12:00:00Z",
    "updated_at": "2026-10-01T12:00:00Z"
  }
}

Delete collection item

DELETE /api/public/v1/collections/{collection_slug}/{item_id}. Deletes an item from a non-system collection.

Parameter	Location	Required	Description
`collection_slug`	path	Yes	The collection API slug.
`item_id`	path	Yes	The UUID of the collection item.

json

{
  "ok": true
}