Skip to main content
POST
Add a document to a vault

Authorizations

Authorization
string
header
required

API key for authentication. Format: gcai_xxxxxxxxx

Create API keys in the GC AI app under Settings → API.

Path Parameters

id
string<uuid>
required

The vault ID

Body

multipart/form-data
file
file
required

The document to add to the vault. PDF, Word (.doc/.docx), and plain text (.txt) only.

Response

Document added to the vault

id
string<uuid>
required

Unique file identifier for the uploaded document. Poll GET /files/{id} until status is ready.

vault_id
string<uuid>
required

The vault the document was added to

name
string
required

Original filename

size
number
required

File size in bytes

content_type
string
required

MIME type of the document

Example:

"application/pdf"

status
enum<string>
required

Text-extraction status of the document

Available options:
extracting,
embedding,
ready,
failed
created_at
string
required

ISO 8601 creation timestamp