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

The Entities API from Ragie — 4 operation(s) for entities.

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

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

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

6 operations 4 paths 4 schemas 1 DELETE3 GET1 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 Entities 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 6

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

Entities 6
POST
/instructions
Create Instruction
createInstruction body → 200401422
GET
/instructions
List Instructions
listInstructions → 200401
PUT
/instructions/{instruction_id}
Update Instruction
updateInstruction 1 param body → 200401
DELETE
/instructions/{instruction_id}
Delete Instruction
deleteInstruction 1 param → 200401
GET
/instructions/{instruction_id}/entities
Get Instruction Extracted Entities
getInstructionExtractedEntities 1 param → 200401
GET
/documents/{document_id}/entities
Get Document Extracted Entities
getDocumentExtractedEntities 1 param → 200401

Schemas 4

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

Entity
object
4 properties
Instruction
object
7 properties
InstructionCreate
object
6 properties 3 required
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Ragie publishes across the network.

Ragie Connections API
Ragie Documents API
Ragie Partitions API
Ragie Retrievals API