Skip to content
Everruns Everruns

list_documents

GET
/v1/knowledge-indexes/{index_id}/documents
 
curl --request GET \
  --url https://app.everruns.com/api/v1/knowledge-indexes/example/documents

List documents inside a knowledge index.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
index_id
required
string

Knowledge index ID

Responses

Section titled “ Responses ”

200

Section titled “200 ”

List documents

Media type application/json

Response wrapper for list endpoints. All list endpoints return responses wrapped in a data field.

object
data
required

Array of items returned by the list operation.

Array<object>

Response body for a knowledge index document.

object
chunk_count
required

Denormalized chunk count for this document.

integer format: int32
content_hash

Content hash driving incremental re-embedding.

string | null
created_at
required

Timestamp when this resource was created (RFC 3339).

string format: date-time
id
required

Prefixed public identifier. See ID Schema.

string
index_id
required

Parent index’s prefixed public identifier.

string
last_seen_at

Timestamp this document was last seen during a sync pass (RFC 3339).

string | null format: date-time
mime_type

Document MIME type, if known.

string | null
size_bytes

Document size in bytes, if known.

integer | null format: int64
source_uri
required

Stable per-source locator (e.g. github://owner/repo@main/docs/x.md).

string
title

Document title, if known.

string | null
updated_at
required

Timestamp when this resource was last updated (RFC 3339).

string format: date-time
Example 
{
  "data": [
    {
      "id": "kidoc_01933b5a000070008000000000000001",
      "index_id": "kidx_01933b5a000070008000000000000001"
    }
  ]
}

404

Section titled “404 ”

Knowledge index not found

Media type application/json

Standard error response.

Wire shape is RFC 9457 Problem Details: every error response includes title and status, and may include detail, code, allowed_actions, retry_after_seconds, instance, and type. The content type is rewritten to application/problem+json by [problem_json_content_type].

object
allowed_actions

Recovery actions the caller can take next.

Array<object>

Agent-actionable link describing a follow-up the caller can take. Used in two contexts:

  • Error recovery — ErrorResponse.allowed_actions carries rels like retry, retry-later, unarchive, get-existing so the agent knows the right next call after a 4xx/429.
  • Entity hypermedia — WithUrls<T>.allowed_actions carries state-aware rels like cancel, events, self, update on the entity itself so the agent can follow links instead of reconstructing routes from prose.

The shape is intentionally identical across both contexts; the closed rel vocabulary documented in specs/api-conventions.md distinguishes them.

object
hint

Short, agent-readable hint (e.g. “Shorten ‘name’ to <= 200 chars.”, “Cancel the active turn for this session.”).

string | null
href

Absolute (preferred) or relative URL the caller may invoke directly. Always present on entity hypermedia actions (WithUrls<T>.allowed_actions); optional on error-recovery actions (ErrorResponse.allowed_actions) where the matching operation_id is enough and the URI is implicit from the failed call.

string | null
method

HTTP method to use against href. Required for entity hypermedia actions; usually omitted on error-recovery actions where the same operation is retried with its original method.

string | null
operation_id

OpenAPI operationId the caller should invoke. Lets an MCP client resolve the call without parsing href.

string | null
rel
required

Link relation describing the action. Closed vocabulary documented in specs/api-conventions.md — examples: self, cancel, pause, resume, events, retry, retry-later, unarchive, get-existing, delete, update.

string
schema_ref

OpenAPI $ref to the request-body schema, when the action takes one (e.g. #/components/schemas/UpdateSessionRequest). Lets a tool-calling agent fetch the input shape without scanning the whole spec.

string | null
code

Stable, machine-readable error code (snake_case).

string | null
detail

Human-readable explanation specific to this occurrence.

string | null
instance

Request URI for this occurrence.

string | null
retry_after_seconds

Seconds the caller should wait before retrying (429 / transient 503).

integer | null format: int32
status
required

HTTP status code; mirrors the response status line.

integer format: int32
title
required

Short, human-readable summary of the problem (e.g. “Not Found”).

string
type

RFC 9457 problem type URI. Optional; identifies the problem class.

string | null
Example 
{
  "allowed_actions": [
    {
      "method": "POST"
    }
  ],
  "code": "session_not_found",
  "detail": "Session session_01933b5a000070008000000000000001 not found in org org_01933b5a000070008000000000000001.",
  "instance": "/v1/sessions/session_01933b5a000070008000000000000001",
  "retry_after_seconds": 30,
  "status": 404,
  "title": "Session not found",
  "type": "https://docs.everruns.com/errors/session_not_found"
}