Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ragie Documents API

The Documents API from Ragie — 10 operation(s) for documents.

Ragie Documents API is one of 5 APIs that Ragie publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 13 operations across 10 paths, and defines 4 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.ragie.ai.

13 operations 10 paths 4 schemas 1 DELETE7 GET1 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.ragie.ai
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Ragie Documents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Ragie API key passed as a Bearer token in the Authorization header.

Paths & Operations 13

Across 10 paths, the API surfaces 13 operations — 1 DELETE, 7 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Documents 13
POST
/documents
Create Document
createDocument body → 200401402422429
GET
/documents
List Documents
listDocuments 4 params → 200401
POST
/documents/raw
Create Document Raw
createDocumentRaw body → 200401422
POST
/documents/from-url
Create Document From URL
createDocumentFromUrl body → 200401422
GET
/documents/{document_id}
Get Document
getDocument 1 param → 200401404
PUT
/documents/{document_id}
Update Document File
updateDocumentFile 1 param body → 200401
DELETE
/documents/{document_id}
Delete Document
deleteDocument 1 param → 200401404
PATCH
/documents/{document_id}/metadata
Patch Document Metadata
patchDocumentMetadata 1 param body → 200401
GET
/documents/{document_id}/content
Get Document Content
getDocumentContent 1 param → 200401
GET
/documents/{document_id}/summary
Get Document Summary
getDocumentSummary 1 param → 200401
GET
/documents/{document_id}/source
Get Document Source
getDocumentSource 1 param → 200401
GET
/documents/{document_id}/chunks
Get Document Chunks
getDocumentChunks 3 params → 200401
GET
/documents/{document_id}/chunks/{chunk_id}
Get Document Chunk
getDocumentChunk 2 params → 200401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Document (10 properties), Chunk (5 properties), Error (2 properties), DocumentList (2 properties). Each schema is shown below with its type and property counts.

DocumentList
object
2 properties
Chunk
object
5 properties
Document
object
10 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ragie-ai-documents-api-openapi.yml Raw ↑

Other APIs Ragie publishes across the network.

Ragie Connections API
Ragie Entities API
Ragie Partitions API
Ragie Retrievals API