List documents

GET

/organizations/{organization}/indexes/{index}/objects

Code sample: Shell / cURL

curl --request GET \
  --url 'https://api.grepvine.ai/v1/organizations/example/indexes/example/objects?amount=50' \
  --cookie __Host-grepvine-session=<__Host-grepvine-session>

Authorizations

• cookieAuth
• apiKeyAuth

Parameters

Path Parameters

organization

required

An account or organization name. Accounts and organizations share one namespace. A name keeps the case it was created with, and any spelling that differs only in case refers to it; no other account or organization can take such a spelling.

string

/^[A-Za-z][A-Za-z0-9-]{2,62}$/

index

required

An index name, unique in its organization. A name keeps the case it was created with, and any spelling that differs only in case refers to it; no other index in the organization can take such a spelling.

string

/^[A-Za-z][A-Za-z0-9-]{0,62}$/

Query Parameters

amount

integer

default: 50 >= 1 <= 200

page

string

<= 4096 characters

prefix

string

<= 1024 characters

delimiter

string

>= 1 characters <= 16 characters

Folds documents that share the substring through the first delimiter after prefix into one common prefix.

Responses

200

A page of documents and folded common prefixes.

Media typeapplication/json

object

results

required

Array<object>

object

key

required

string

revision

required

string

content_bytes

required

integer

metadata

required

object

<= 64 properties

key

additional properties

One of: discriminator: type

object

object

type

required

string

Allowed value: string

value

required

string

<= 8192 characters

object

object

type

required

string

Allowed value: integer

value

required

integer format: int64

object

object

type

required

string

Allowed value: number

value

required

number format: double

object

object

type

required

string

Allowed value: boolean

value

required

boolean

object

object

type

required

string

Allowed value: timestamp

value

required

string format: date-time

updated_at

required

When the document’s current revision was stored.

string format: date-time

searchable

required

Whether a search can match this document. False for content that is not valid UTF-8 or is over 100 MiB; such a document is stored and served but never returned by a query.

boolean

common_prefixes

required

Array<string>

pagination

required

A page may hold fewer results than the requested amount, possibly none, while has_next is true; a query page stops at the server’s soft time budget and next_page_id resumes exactly after the last candidate it examined. Clients continue while has_next is true.

object

next_page_id

required

string

has_next

required

boolean

Example

{
  "results": [
    {
      "metadata": {
        "additionalProperty": {
          "type": "string"
        }
      }
    }
  ]
}

default

The request failed. A 429 carries Retry-After; the index is busy absorbing recent writes or is out of request capacity, and clients must slow down and retry after the interval. A 403 with code organization_suspended refuses every operation on a suspended organization’s members, indexes, documents and searches; reading the organization itself still answers and reports suspended, and the client should contact support.

Media typeapplication/json

object

code

required

string

reason

required

string

error

required

string

Example ^generated

{
  "code": "example",
  "reason": "example",
  "error": "example"
}

Headers

X-Request-Id

string

The request identifier used for support and audit correlation.

Retry-After

integer

Seconds to wait before retrying. Sent with every 429 so a client slows down instead of failing.