Zum Hauptinhalt springen
GET
Get a document

Autorisierungen

Authorization
string
header
erforderlich

A key from conare.ai/dashboard/keys with full access, some namespaces, or models only (/embed, /rerank, /v1, /v2/rerank, /parse).

Pfadparameter

namespace
string
erforderlich

The namespace name. 1-64 characters of a-z 0-9 _ -, starting with a letter or digit.

Pattern: ^[a-z0-9][a-z0-9_-]{0,63}$
Beispiele:

"docs"

"user-42"

id
string
erforderlich

The document id. 1-256 characters of A-Z a-z 0-9 . _ : -, starting with a letter or digit.

Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{0,255}$
Beispiele:

"refunds"

"hubspot:contacts:1042"

Antwort

The whole document.

id
string
erforderlich

1-256 characters of A-Z a-z 0-9 . _ : -, starting with a letter or digit.

Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{0,255}$
Beispiele:

"refunds"

"hubspot:contacts:1042"

text
string
erforderlich
metadata
object
erforderlich

Strings, numbers, booleans or string arrays, for filtering; else 400 invalid_metadata.

  • At most 256 indexed values: an array item or a boolean counts one, a number or a string up to 222 bytes two.
updated_at
string<date-time>
erforderlich
version
integer<int64>
erforderlich

Changes on every write that stores something new; compare for equality only.

Erforderlicher Bereich: x >= 1
user
string

A user id of yours, with at most 8 :; group users with : (tenant-7:u_42) and query a group by user_prefix.

Pattern: ^[A-Za-z0-9][A-Za-z0-9._:@-]{0,127}$
Beispiel:

"tenant-7:u_42"

seq
integer<int64>