GET /items

This page covers two item read endpoints.

Purpose	Endpoint
Items in a folder	`GET /v1/folders/{folderId}/items`
A single item	`GET /v1/items/{itemId}`

List items

GET /v1/folders/{folderId}/items

There is no pagination. Every item in the folder is returned at once, and the response carries only count and items.

Query parameters

Parameter	Type	Default	Description
`type`	`string`		Type filter: `file` · `text` · `json`
`search`	`string`		Partial match on the item name
`sort`	`string`	`createdAt`	`name` · `type` · `createdAt`
`order`	`string`	`desc`	`asc` · `desc`

curl "https://client-omni-api.argosidentity.com/v1/folders/fd_9pq2mklt83bx/items?sort=createdAt&order=asc" \
  -H "x-api-key: your-api-key-here"

Response

{
  "count": 3,
  "items": [
    {
      "id": "item_axfkh2noof85",
      "folderId": "fd_9pq2mklt83bx",
      "type": "text",
      "name": "certificate of good standing",
      "content": "STATE OF DELAWARE\nCERTIFICATE OF GOOD STANDING\n\nEntity name: ACME TRADING LLC\nState file number: 7412583 ...",
      "contentType": "text/plain",
      "sizeBytes": 538,
      "url": "https://omni-kb-documents.s3.us-east-1.amazonaws.com/.../extracted.txt",
      "detected": null,
      "metadata": { "doc_type": "certificate_of_good_standing" },
      "status": "ACTIVE",
      "processedAt": "2026-09-10T05:35:38.902Z",
      "rag": "certificate of good standing ACME TRADING LLC state file number 7412583 Delaware ...",
      "createdAt": "2026-09-10T05:35:31.412Z"
    }
  ]
}

Response fields

Field	Type	Description
`count`	`number`	Number of items
`items[].id`	`string`	Item ID (`item_` prefix)
`items[].folderId`	`string`	ID of the folder it belongs to
`items[].type`	`string`	`file` · `text` · `json`
`items[].name`	`string`	Item name
`items[].content`	`string \| object \| null`	The body you sent when adding the item. `null` for the `file` type
`items[].contentType`	`string \| null`	MIME type
`items[].sizeBytes`	`number \| null`	Size in bytes
`items[].url`	`string \| null`	S3 URL of the extracted text. Filled in only while `status` is `ACTIVE`
`items[].detected`	`object \| null`	Auto-detected info (`contentType`, `extension`, `fileCategory`). File type only
`items[].metadata`	`object \| null`	Your own metadata
`items[].status`	`string`	`PENDING` · `ACTIVE` · `FAILED`
`items[].processedAt`	`string \| null`	Time processing finished. `null` while `PENDING`
`items[].rag`	`string \| null`	The extracted, cleaned body the analysis actually uses. Filled in only while `ACTIVE`
`items[].createdAt`	`string`	Creation time

s3OriginalUrl (the original file URL) appears only in the add and update responses, never in a read response.

Get an item

GET /v1/items/{itemId}

Same fields as a list entry, plus a folder object.

curl "https://client-omni-api.argosidentity.com/v1/items/item_axfkh2noof85" \
  -H "x-api-key: your-api-key-here"

Response

{
  "id": "item_axfkh2noof85",
  "folderId": "fd_9pq2mklt83bx",
  "type": "text",
  "name": "certificate of good standing",
  "content": "STATE OF DELAWARE\nCERTIFICATE OF GOOD STANDING\n\nEntity name: ACME TRADING LLC\nState file number: 7412583 ...",
  "contentType": "text/plain",
  "sizeBytes": 538,
  "url": "https://omni-kb-documents.s3.us-east-1.amazonaws.com/.../extracted.txt",
  "detected": null,
  "metadata": { "doc_type": "certificate_of_good_standing" },
  "status": "ACTIVE",
  "processedAt": "2026-09-10T05:35:38.902Z",
  "rag": "certificate of good standing ACME TRADING LLC state file number 7412583 Delaware ...",
  "folder": {
    "id": "fd_9pq2mklt83bx",
    "name": "default"
  },
  "createdAt": "2026-09-10T05:35:31.412Z"
}

Field	Type	Description
`folder.id`	`string`	ID of the folder it belongs to
`folder.name`	`string`	Name of the folder it belongs to

Error codes

Status	Code	Description
404	`OMNI_3009`	Folder not found (list)
404	`OMNI_3006`	Item not found (single item)

Common errors (400 validation · 401 authentication · 403 permission · 500 server) are listed in the API overview.

Overview

API Reference

List items

Query parameters

Response

Response fields

Get an item

Response

Error codes

​List items

​Query parameters

​Response

​Response fields

​Get an item

​Response

​Error codes

List items

Query parameters

Response

Response fields

Get an item

Response

Error codes