Oracle Generative AI Agent API
The generativeAiAgent API from Oracle — 23 operation(s) for generativeaiagent.
Oracle Generative AI Agent API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include generativeAiAgent. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 44 operations across 23 paths, and defines 68 schemas. It is described by OpenAPI 3.2.0, at version 20240531.
Requests are made against 2 base URLs: http://127.0.0.1/20240531, https://127.0.0.1/20240531.
44 operations
23 paths
68 schemas
8 DELETE19 GET11 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 44
Across 23 paths, the API surfaces 44 operations — 8 DELETE, 19 GET, 11 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.
generativeAiAgent 44
GET
/agentEndpoints
Gets a list of endpoints.
POST
/agentEndpoints
Creates an endpoint.
DELETE
/agentEndpoints/{agentEndpointId}
Deletes an AgentEndpoint.
GET
/agentEndpoints/{agentEndpointId}
Get AgentEndpoint
PUT
/agentEndpoints/{agentEndpointId}
Updates an AgentEndpoint.
POST
/agentEndpoints/{agentEndpointId}/actions/changeCompartment
Moves an AgentEndpoint into a different compartment.
GET
/agents
Gets a list of Agents.
POST
/agents
Creates an Agent.
DELETE
/agents/{agentId}
Deletes an Agent.
GET
/agents/{agentId}
Get Agent
PUT
/agents/{agentId}
Updates an Agent.
POST
/agents/{agentId}/actions/changeCompartment
Moves an agent into a different compartment.
GET
/dataIngestionJobs
Gets a list of data ingestion jobs.
POST
/dataIngestionJobs
Creates a data ingestion job.
DELETE
/dataIngestionJobs/{dataIngestionJobId}
Deletes a data ingestion job.
GET
/dataIngestionJobs/{dataIngestionJobId}
Get DataIngestionJob
GET
/dataIngestionJobs/{dataIngestionJobId}/logs/content
Gets the raw logs for a Data Ingestion job.
GET
/dataSources
Gets a list of data sources.
POST
/dataSources
Creates a DataSource.
DELETE
/dataSources/{dataSourceId}
Deletes a DataSource.
GET
/dataSources/{dataSourceId}
Get DataSource
PUT
/dataSources/{dataSourceId}
Updates a data source.
GET
/knowledgeBases
Gets a list of knowledge bases.
POST
/knowledgeBases
Creates a KnowledgeBase.
DELETE
/knowledgeBases/{knowledgeBaseId}
Deletes a KnowledgeBase.
GET
/knowledgeBases/{knowledgeBaseId}
Get KnowledgeBase
PUT
/knowledgeBases/{knowledgeBaseId}
Updates a knowledge base.
POST
/knowledgeBases/{knowledgeBaseId}/actions/changeCompartment
Moves a KnowledgeBase into a different compartment.
GET
/provisionedCapacities
Gets a list of provisioned capacities.
POST
/provisionedCapacities
Creates a ProvisionedCapacity.
DELETE
/provisionedCapacities/{provisionedCapacityId}
Deletes a ProvisionedCapacity.
GET
/provisionedCapacities/{provisionedCapacityId}
Get ProvisionedCapacity
PUT
/provisionedCapacities/{provisionedCapacityId}
Updates a provisioned capacity.
POST
/provisionedCapacities/{provisionedCapacityId}/actions/changeCompartment
Moves a ProvisionedCapacity into a different compartment.
GET
/tools
Gets a list of Tools.
POST
/tools
Creates a Tool.
DELETE
/tools/{toolId}
Deletes a Tool.
GET
/tools/{toolId}
Get Tool
PUT
/tools/{toolId}
Updates a Tool.
GET
/workRequests
List work requests
DELETE
/workRequests/{workRequestId}
Cancel work request
GET
/workRequests/{workRequestId}
Get work request status
GET
/workRequests/{workRequestId}/errors
List work request errors
GET
/workRequests/{workRequestId}/logs
List work request logs
Schemas 68
The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are AgentEndpointSummary (23 properties), AgentEndpoint (23 properties), CreateAgentEndpointDetails (17 properties), DataIngestionJob (15 properties). Each schema is shown below with its type and property counts.
DataIngestionJobStatistics
object
The statistics of data ingestion job.
4 properties
PersonallyIdentifiableInformationGuardrailConfig
object
The configuration details for Personally Identifiable Information.
2 properties
LlmCustomization
object
Configuration to customize LLM.
3 properties
WorkRequestSummary
object
Summary information about an asynchronous work request.
10 properties
7 required
CreateKnowledgeBaseDetails
object
The data to create a knowledge base.
6 properties
2 required
KnowledgeBaseCollection
object
Results of a knowledge base search. Contains both KnowledgeBaseSummary items and other information, such as metadata.
1 property
1 required
AgentEndpointCollection
object
Results of an agentEndpoint search. Contains both AgentEndpointSummary items and other information, such as metadata.
1 property
1 required
DataSourceSummary
object
Summary information about a data source.
12 properties
8 required
CreateToolDetails
object
The data to create a Tool.
8 properties
4 required
CreateDataIngestionJobDetails
object
The data to create a data ingestion job.
6 properties
2 required
Agent
object
An agent is an LLM-based autonomous system that understands and generates human-like text, enabling natural-language processing interactions. OCI Generative AI…
14 properties
4 required
DataIngestionJobCollection
object
Results of a data ingestion job search. Contains both DataIngestionJobSummary items and other information, such as metadata.
1 property
1 required
KnowledgeBase
object
A knowledge base is the base for all the data sources that an agent can use to retrieve information for its responses. To use any of the API operations, you mu…
13 properties
8 required
SessionConfig
object
Session Configuration on AgentEndpoint.
1 property
AgentCollection
object
Results of an agent search. Contains both AgentSummary items and other information, such as metadata.
1 property
1 required
WorkRequestSummaryCollection
object
A list of work requests. Can contain both work requests and other information, such as metadata.
1 property
1 required
DataSourceCollection
object
Results of a dataSource search. Contains both DataSourceSummary items and other information, such as metadata.
1 property
1 required
CreateDataSourceDetails
object
The data to create a data source.
8 properties
3 required
ProvisionedCapacityConfig
object
The configuration includes the provisioned capacity id and component runtime (tool versions, and other relevant information).
3 properties
1 required
ContentModerationGuardrailConfig
object
The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from r…
2 properties
DataIngestionJob
object
When you create a data source, you specify the location of the data files. To make those files usable by an agent, you must download them into the agent's asso…
15 properties
10 required
OutputConfig
object
Configuration to store results generated by agent.
2 properties
1 required
WorkRequestErrorCollection
object
A list of work request errors. Can contain both errors and other information, such as metadata.
1 property
1 required
HumanInputConfig
object
Human Input Configuration for an AgentEndpoint.
1 property
1 required
UpdateProvisionedCapacityDetails
object
The data to update a provisioned capacity.
5 properties
WorkRequestError
object
An error encountered while performing an operation that is tracked by a work request.
3 properties
3 required
ToolRuntimeConfig
object
Configuration for the tool.
2 properties
1 required
AgentEndpoint
object
The endpoint to access a deployed agent. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an admini…
23 properties
5 required
CreateProvisionedCapacityDetails
object
The data to create a provisioned capacity.
6 properties
3 required
DataIngestionJobType
object
DataIngestionJob type.
1 property
KnowledgeBaseStatistics
object
Statistics for Default Knowledge Base.
2 properties
IndexConfig
object
The index configuration of Knowledge bases.
1 property
1 required
AgentSummary
object
Summary information about an agent.
14 properties
4 required
WorkRequestLogEntry
object
A log message from performing an operation that is tracked by a work request.
2 properties
2 required
UpdateAgentEndpointDetails
object
The data to update an endpoint.
14 properties
UpdateAgentDetails
object
The data to update an agent.
7 properties
UpdateDataSourceDetails
object
The data to update a data source.
6 properties
ChangeProvisionedCapacityCompartmentDetails
object
The configuration details for the move operation.
1 property
1 required
Tool
object
The description of Tool. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you'…
13 properties
7 required
WorkRequest
object
An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work reque…
10 properties
7 required
ProvisionedCapacity
object
A provisioned capacity is a resource pool of Genrative AI DACs with properties like AgentRuntimeVersion, unit size, and a tool name to DAC ID mapping. To use a…
11 properties
5 required
DataSourceConfig
object
The details of data source.
2 properties
1 required
PromptInjectionGuardrailConfig
object
The configuration details for Prompt Injection.
1 property
UpdateKnowledgeBaseDetails
object
The data to update a knowledge base.
5 properties
DataSource
object
A data source points to the source of your data. After you add a data source to a knowledge base, you must ingest the data source's data, so that agents using…
14 properties
9 required
ChangeKnowledgeBaseCompartmentDetails
object
The configuration details for the move operation.
1 property
1 required
ProvisionedCapacitySummary
object
Summary information about a provisioned capacity.
11 properties
5 required
WorkRequestResource
object
A resource created or operated on by a work request.
5 properties
3 required
ToolSummary
object
Summary information of a Tool.
13 properties
6 required
ToolCollection
object
Results of a Tool search. Contains both ToolSummary items and other information, such as metadata.
1 property
1 required
LlmSelection
object
LLM selection configuration - either DEFAULT or CUSTOM.
1 property
1 required
GuardrailConfig
object
The configuration details about whether to apply the guardrail checks to input and output.
3 properties
UpdateToolDetails
object
The data to update a Tool.
6 properties
LlmConfig
object
Configuration to Agent LLM.
2 properties
ProvisionedCapacityCollection
object
Results of a provisioned capacity search. Contains both ProvisionedCapacitySummary items.
1 property
1 required
CreateAgentDetails
object
The data to create an agent.
8 properties
1 required
PlatformRuntimeConfig
object
Configuration for agent platform component.
2 properties
WorkRequestLogEntryCollection
object
A list of work request logs. Can contain both logs and other information, such as metadata.
1 property
1 required
DataIngestionJobSummary
object
Summary information about a data ingestion job.
14 properties
10 required
ContentModerationConfig
object
The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from r…
2 properties
CreateAgentEndpointDetails
object
The data to create an endpoint.
17 properties
2 required
KnowledgeBaseSummary
object
Summary information about a knowledge base.
11 properties
7 required
Error
object
Error information
2 properties
2 required
ToolConfig
object
The configuration and type of Tool.
1 property
1 required
ChangeAgentCompartmentDetails
object
The configuration details for the move operation.
1 property
1 required
ChangeAgentEndpointCompartmentDetails
object
The configuration details for the move operation.
1 property
1 required
AgentEndpointSummary
object
Summary information about an endpoint.
23 properties
5 required
OutputLocation
object
Location of the output.
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle 12
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
#generativeAiAgent
Where this information came from
This is an independent, third-party profile of Oracle Generative AI Agent 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.