Get a document

GET

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

Code sample: Shell / cURL

curl --request GET \
  --url https://api.grepvine.ai/v1/organizations/example/indexes/example/objects/example \
  --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}$/

key

required

string

>= 1 characters <= 1024 characters

Header Parameters

Range

string

<= 128 characters

One HTTP bytes range. Multiple ranges are not supported.

Responses

200

The complete document content.

Media typeapplication/octet-stream

string format: binary

Headers

Accept-Ranges

string

Allowed value: bytes

The range unit accepted for document reads.

Content-Length

integer

The number of content bytes in this response.

Etag

string

The opaque document revision.

X-Grepvine-Metadata

string

The document Metadata object encoded as JSON.

206

The requested document byte range.

Media typeapplication/octet-stream

string format: binary

Headers

Accept-Ranges

string

Allowed value: bytes

The range unit accepted for document reads.

Content-Length

integer

The number of content bytes in this response.

Content-Range

string

The returned range and complete document size, or the complete size for an unsatisfied range.

Etag

string

The opaque document revision.

X-Grepvine-Metadata

string

The document Metadata object encoded as JSON.

404

The resource does not exist or is not visible.

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.

416

The byte range does not overlap the document.

Media typeapplication/json

object

code

required

string

reason

required

string

error

required

string

Example ^generated

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

Headers

Content-Range

string

The returned range and complete document size, or the complete size for an unsatisfied range.

X-Request-Id

string

The request identifier used for support and audit correlation.

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.