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 Retrievals API

The Retrievals API from Ragie — 2 operation(s) for retrievals.

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

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

This API exposes 2 operations across 2 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.

2 operations 2 paths 4 schemas 2 POST

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 Retrievals 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 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Retrievals 2
POST
/retrievals
Retrieve
retrieve body → 200401402422429
POST
/responses
Create Response
createResponse body → 200401422

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are RetrievalRequest (7 properties), ScoredChunk (6 properties), Error (2 properties), RetrievalResponse (1 property). Each schema is shown below with its type and property counts.

RetrievalRequest
object
7 properties 1 required
RetrievalResponse
object
1 property
ScoredChunk
object
6 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Ragie publishes across the network.

Ragie Connections API
Ragie Documents API
Ragie Entities API
Ragie Partitions API