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

ArthurAI RAG Notebooks API

The RAG Notebooks API from ArthurAI — 4 operation(s) for rag notebooks.

ArthurAI RAG Notebooks API is one of 98 APIs that ArthurAI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include RAG Notebooks. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 4 paths, and defines 39 schemas. It is described by OpenAPI 3.2.0, at version 2.1.688.

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

8 operations 4 paths 39 schemas 1 DELETE4 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.1.688
Base URL
https://platform.arthur.ai/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

ArthurAI RAG Notebooks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API_Key).

  • API_Key — Bearer token authentication with an API key

Paths & Operations 8

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

RAG Notebooks 8
POST
/api/v1/tasks/{task_id}/rag_notebooks
Create a RAG notebook
create_rag_notebook_api_v1_tasks__task_id__rag_notebooks_post 1 param body → 201422
GET
/api/v1/tasks/{task_id}/rag_notebooks
List RAG notebooks
list_rag_notebooks_api_v1_tasks__task_id__rag_notebooks_get 5 params → 200422
GET
/api/v1/rag_notebooks/{notebook_id}
Get RAG notebook details
get_rag_notebook_api_v1_rag_notebooks__notebook_id__get 1 param → 200422
PUT
/api/v1/rag_notebooks/{notebook_id}
Update RAG notebook metadata
update_rag_notebook_api_v1_rag_notebooks__notebook_id__put 1 param body → 200422
DELETE
/api/v1/rag_notebooks/{notebook_id}
Delete RAG notebook
delete_rag_notebook_api_v1_rag_notebooks__notebook_id__delete 1 param → 204422
GET
/api/v1/rag_notebooks/{notebook_id}/state
Get RAG notebook state
get_rag_notebook_state_api_v1_rag_notebooks__notebook_id__state_get 1 param → 200422
PUT
/api/v1/rag_notebooks/{notebook_id}/state
Set RAG notebook state
set_rag_notebook_state_api_v1_rag_notebooks__notebook_id__state_put 1 param body → 200422
GET
/api/v1/rag_notebooks/{notebook_id}/history
Get RAG notebook history
get_rag_notebook_history_api_v1_rag_notebooks__notebook_id__history_get 4 params → 200422

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are WeaviateHybridSearchSettingsConfigurationRequest (16 properties), WeaviateHybridSearchSettingsConfigurationResponse (16 properties), RagExperimentSummary (14 properties), WeaviateVectorSimilarityTextSearchSettingsConfigurationResponse (12 properties). Each schema is shown below with its type and property counts.

ExperimentOutputSource
object
Reference to experiment output
1 property
DatasetRefInput
object
Reference to a dataset and version for input (without name)
2 properties 2 required
RagExperimentSummary
object
Summary of a RAG experiment
14 properties 11 required
MetadataQuery
object
Define which metadata should be returned in the query's results.
8 properties
NewDatasetVersionRowColumnItemRequest
object
Represents a single column-value pair in a dataset row.
2 properties 2 required
DatasetColumnSource
object
Reference to a dataset column
1 property 1 required
EvalRef-Output
object
Reference to an evaluation configuration
3 properties 3 required
PaginationSortMethod
string
ExperimentOutputVariableSource
object
Variable source from experiment output
2 properties 2 required
SetRagNotebookStateRequest
object
Request to set the RAG notebook state
1 property 1 required
RagNotebookSummary
object
Summary of a RAG notebook
9 properties 6 required
RagExperimentListResponse
object
Paginated list of RAG experiments
5 properties 5 required
RagNotebookStateResponse
object
Draft state of a RAG notebook - mirrors RAG experiment config but all fields optional. Used for responses (output).
4 properties
RagNotebookState
object
Draft state of a RAG notebook - mirrors RAG experiment config but all fields optional. Used for requests (input).
4 properties
HybridFusion
string
Define how the query's hybrid fusion operation should be performed.
ValidationError
object
5 properties 3 required
SavedRagConfig-Input
object
Configuration for a saved RAG setting configuration version
4 properties 3 required
WeaviateHybridSearchSettingsConfigurationResponse
object
16 properties 1 required
UnsavedRagConfigResponse
object
Configuration for an unsaved RAG search setting (response version)
5 properties 3 required
DatasetColumnVariableSource
object
Variable source from a dataset column
2 properties 2 required
_MultiTargetVectorJoinEnum
integer
Define how multi target vector searches should be combined.
SavedRagConfig-Output
object
Configuration for a saved RAG setting configuration version
4 properties 3 required
WeaviateVectorSimilarityTextSearchSettingsConfigurationResponse
object
12 properties 1 required
EvalVariableMapping-Output
object
Mapping of an eval variable to its source (dataset column or experiment output)
2 properties 2 required
RagNotebookListResponse
object
Paginated list of RAG notebooks
5 properties 5 required
_MultiTargetVectorJoin
object
3 properties 2 required
UpdateRagNotebookRequest
object
Request to update a RAG notebook
2 properties
HTTPValidationError
object
1 property
EvalRef-Input
object
Reference to an evaluation configuration
3 properties 3 required
RagNotebookDetail
object
Detailed RAG notebook information
8 properties 7 required
DatasetRef
object
Reference to a dataset and version (with name)
3 properties 3 required
ExperimentStatus
string
Status of an experiment
EvalVariableMapping-Input
object
Mapping of an eval variable to its source (dataset column or experiment output)
2 properties 2 required
CreateRagNotebookRequest
object
Request to create a new RAG notebook
3 properties 1 required
UnsavedRagConfig
object
Configuration for an unsaved RAG search setting
5 properties 3 required
WeaviateKeywordSearchSettingsConfigurationRequest
object
11 properties 1 required
WeaviateKeywordSearchSettingsConfigurationResponse
object
11 properties 1 required
WeaviateVectorSimilarityTextSearchSettingsConfigurationRequest
object
12 properties 1 required
WeaviateHybridSearchSettingsConfigurationRequest
object
16 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

arthurai-rag-notebooks-api-openapi.yml Raw ↑

Other APIs ArthurAI publishes across the network.

ArthurAI Agent Discovery API
ArthurAI Agentic Experiments API
ArthurAI Agentic Notebooks API
ArthurAI Agents V1 API
ArthurAI Alert Rules V1 API
ArthurAI Alerts V1 API
ArthurAI API Keys API
ArthurAI Authorization V1 API
ArthurAI Chatbot API
ArthurAI Configuration API
ArthurAI Connector Schemas V1 API
ArthurAI Connectors V1 API
Where this information came from

This is an independent, third-party profile of ArthurAI RAG Notebooks 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.