How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle AI Service Document API

The AIServiceDocument API from Oracle — 19 operation(s) for aiservicedocument.

Oracle AI Service Document API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 27 operations across 19 paths, and defines 63 schemas. It is described by OpenAPI 3.2.0, at version 20221109.

Requests are made against 2 base URLs: http://127.0.0.1/20221109, https://127.0.0.1/20221109.

27 operations 19 paths 63 schemas 3 DELETE10 GET1 PATCH11 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20221109
Base URL
https://{host}:{port}/ords/
Resource Areas
1

Paths & Operations 27

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

AIServiceDocument 27
POST
/actions/analyzeDocument
Perform document analysis.
AnalyzeDocument 2 params body → 200400401404409412413429
GET
/modelTypes/{modelType}
Retrieves model information like versions and capabilities
GetModelType 4 params → 200400401404429500default
GET
/models
Gets a list of all models in a compartment
ListModels 10 params → 200400401404429500default
POST
/models
Creates a new model .
CreateModel 2 params body → 201400401404409429500default
DELETE
/models/{modelId}
Delete a model.
DeleteModel 4 params → 202400401404412429500default
GET
/models/{modelId}
Get a model.
GetModel 2 params → 200400401404429500default
PATCH
/models/{modelId}
Updates the model metadata only selected path parameter.
PatchModel 3 params body → 202400401404405412429500
PUT
/models/{modelId}
Update the metadata about the model.
UpdateModel 4 params body → 202400401404405412429500
POST
/models/{modelId}/actions/addLock
Adds a lock to a resource.
AddModelLock 6 params → 200401404409412429500default
POST
/models/{modelId}/actions/changeCompartment
Moves a model into a different compartment.
ChangeModelCompartment 4 params body → 204401404409412429500
POST
/models/{modelId}/actions/removeLock
Remove a lock from a resource.
RemoveModelLock 6 params → 200401404409412429500default
POST
/processorJobs
Create a processor job for document analysis.
CreateProcessorJob 2 params body → 201400401404409429500default
GET
/processorJobs/{processorJobId}
Get the details of a processor job.
GetProcessorJob 2 params → 200400401404429500default
POST
/processorJobs/{processorJobId}/actions/cancel
Cancel a processor job.
CancelProcessorJob 3 params → 202400401404412429500default
GET
/projects
Gets a list of all the projects in a compartment.
ListProjects 9 params → 200400401404429500default
POST
/projects
Creates a new project.
CreateProject 2 params body → 201400401404409429500default
DELETE
/projects/{projectId}
Delete a project.
DeleteProject 4 params → 202400401404412429500default
GET
/projects/{projectId}
Get a project.
GetProject 2 params → 200400401404429500default
PUT
/projects/{projectId}
Update the metadata about the project.
UpdateProject 4 params body → 202400401404405412429500
POST
/projects/{projectId}/actions/addLock
Adds a lock to a resource.
AddProjectLock 6 params → 200401404409412429500default
POST
/projects/{projectId}/actions/changeCompartment
Move a project into a different compartment.
ChangeProjectCompartment 4 params body → 204401404409412429500
POST
/projects/{projectId}/actions/removeLock
Remove a lock from a resource.
RemoveProjectLock 6 params → 200401404409412429500default
GET
/workRequests
A list of work requests.
ListWorkRequests 9 params → 200400401404429500default
DELETE
/workRequests/{workRequestId}
Cancel the work request.
CancelWorkRequest 3 params → 202400401404429409412500
GET
/workRequests/{workRequestId}
Get the work request status.
GetWorkRequest 2 params → 200400401404429500default
GET
/workRequests/{workRequestId}/errors
Lists the work request errors.
ListWorkRequestErrors 6 params → 200400401404429500default
GET
/workRequests/{workRequestId}/logs
Lists work request logs.
ListWorkRequestLogs 6 params → 200400401404429500default

Schemas 63

The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are Model (30 properties), ModelSummary (24 properties), CreateModelDetails (18 properties), Project (12 properties). Each schema is shown below with its type and property counts.

UpdateProjectDetails
object
The metadata that can be edited after project creation.
4 properties
Error
object
Error Information.
2 properties 2 required
TableRow
object
A single row in a table.
1 property 1 required
ChangeProjectCompartmentDetails
object
Which compartment the project should be moved to.
1 property 1 required
InputLocation
object
The location of the inputs.
1 property 1 required
ModelCollection
object
The results of a model search.
1 property 1 required
WorkRequestSummaryCollection
object
The results of a workRequest search.
1 property 1 required
ProcessorJob
object
Details of a processor job.
12 properties 6 required
Model
object
Machine-learned Model.
30 properties 7 required
ModelSummary
object
The metadata about the model.
24 properties 7 required
WorkRequestSummary
object
A summary of the status of a work request.
9 properties 7 required
Dimensions
object
The width and height of a page.
3 properties 3 required
ModelTypeInfo
object
Model information like versions and capabilities
2 properties 1 required
CreateProcessorJobDetails
object
The details used to create a processor job.
5 properties 4 required
NormalizedVertex
object
An (x, y) coordinate in the image with dimensions normalized from zero to one. The origin is at top left, with the positive x-axis pointing right and the posit…
2 properties 2 required
ComponentModel
object
The custom model selected for Composition.
1 property
ProjectCollection
object
The results of a project search.
1 property 1 required
Cell
object
A single cell in a table.
6 properties 6 required
AddProjectLockDetails
object
Request payload to add lock to the resource.
3 properties 1 required
Capabilities
object
Capabilities supported
1 property
PatchModelOperation
object
The metadata which can be edited after model creation.
3 properties
DocumentDetails
object
The details of a document to analyze.
1 property 1 required
ModelSubType
object
Sub type model based on the model type.
1 property 1 required
ProjectSummary
object
the metadata about the project.
11 properties 4 required
DocumentFeature
object
The type of document analysis.
1 property 1 required
DocumentField
object
Form field.
4 properties 2 required
BoundingPolygon
object
The object-bounding polygon box.
1 property 1 required
FieldValue
object
The value of a form field.
5 properties 4 required
WorkRequestLogEntry
object
A log message from the execution of a work request.
2 properties 2 required
DetectedDocumentType
object
The detected document type.
3 properties 2 required
Dataset
object
The base entity which is the input for creating and training a model.
1 property 1 required
WorkRequest
object
The workrequest status details.
9 properties 7 required
ProcessingError
object
The error in document processing.
2 properties 2 required
RemoveModelLockDetails
object
Request payload to remove lock to the resource.
1 property 1 required
OutputLocation
object
The object storage location where to store analysis results.
3 properties 3 required
AnalyzeDocumentDetails
object
The details of how to analyze a document.
7 properties 2 required
ProcessorConfig
object
The configuration of a processor.
1 property 1 required
PatchModelDetails
object
The model parameters to be updated using patch operation.
1 property
Line
object
The line of text.
4 properties 4 required
CreateModelDetails
object
The information needed to create a new model.
18 properties 3 required
Capability
object
Capability supported
1 property
WorkRequestResource
object
A resource created, or operated on, by a work request.
5 properties 3 required
UpdateModelDetails
object
The metadata which can be edited after model creation.
5 properties
AnalyzeDocumentResult
object
The document analysis results.
11 properties 2 required
Page
object
One page document analysis result.
8 properties 1 required
FieldLabel
object
The label in a field.
2 properties 1 required
WorkRequestError
object
An error encountered while executing a work request.
3 properties 3 required
CreateProjectDetails
object
The information needed to create a new project.
5 properties 1 required
RemoveProjectLockDetails
object
Request payload to remove lock to the resource.
1 property 1 required
DocumentMetadata
object
The document information.
2 properties 2 required
ResourceLock
object
Resource locks prevent certain APIs from being called for the resource. A full lock prevents both updating and deleting the resource. A lock delete prevents de…
5 properties 2 required
DatasetSummary
object
Summary of count of samples used during model training.
3 properties
Project
object
A Document Project containing models.
12 properties 4 required
PatchResponseMessage
object
The response containing the details of the patch operation status.
3 properties 1 required
DetectedLanguage
object
The language detected in a document.
2 properties 2 required
WorkRequestErrorCollection
object
The results of a workRequestError search.
1 property 1 required
ChangeModelCompartmentDetails
object
The compartment the model should be moved to.
1 property 1 required
Word
object
A single word.
3 properties 3 required
Table
object
The table extracted from a document.
7 properties 7 required
FieldName
object
The name of a form field.
4 properties 1 required
AddModelLockDetails
object
Request payload to add lock to the resource.
3 properties 1 required
WorkRequestLogEntryCollection
object
The results of a workRequestLog search.
1 property 1 required
ModelMetrics
object
Trained Model Metrics.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-aiservicedocument-api-openapi.yml Raw ↑

Other APIs Oracle publishes across the network.

Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
Where this information came from

This is an independent, third-party profile of Oracle AI Service Document API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.