Arango Control Plane (ACP) - API Reference

GenAIServiceV1 is a service that provides various endpoints for managing AI services.

HTTP Bindings

Endpoint	Method	RPC Method	Body
/v1/project	POST	CreateProject	*
/v1/project/{project_db_name}/{project_name}	DELETE	DeleteProject
/v1/all_project_names/{project_db_name}	GET	GetAllProjectNames
/v1/project_by_name/{project_db_name}/{project_name}	GET	GetProjectByName
/v1/all_projects/{project_db_name}	GET	GetAllProjects
/v1/graphanalytics	POST	CreateGraphAnalytics	*
/v1/graphrag	POST	CreateGraphRag	*
/v1/graphragimporter	POST	CreateGraphRagImporter	*
/v1/graphragretriever	POST	CreateGraphRagRetriever	*
/v1/autograph	POST	CreateAutoGraph	*
/v1/mlflow	POST	CreateMLFlow	*
/v1/mlflowregistry	POST	CreateMLFlowRegistry	*
/v1/notebook	POST	CreateNotebook	*
/v1/llmhost	POST	CreateLlmHost	*
/v1/uds	POST	CreateUserDefinedService	*
/v1/service	POST	CreateGenericService	*
/v1/service/{service_id}	DELETE	DeleteService
/v1/service/{service_id}	GET	CheckServiceStatus
/v1/service/{service_id}	PUT	UpgradeService	*
/v1/base-images	GET	GetBaseImages
/v1/health	GET	HealthCheck
/v1/list_services	POST	ListServices	*
/v1/secret_types	GET	GetSecretProfileTypes
/v1/secrets_batch	POST	CreateSecretProfiles	*
/v1/secrets_batch/delete	POST	DeleteSecretProfiles	*
/v1/secrets	GET	ListSecretProfiles
/v1/secrets	POST	CreateSecretProfile	*
/v1/secrets/{profile_id}	GET	GetSecretProfile
/v1/secrets/{profile_id}	PUT	UpdateSecretProfile	*
/v1/secrets/{profile_id}	PATCH	PartialUpdateSecretProfile	*
/v1/secrets/{profile_id}	DELETE	DeleteSecretProfile

Methods

Method Name	Request Type	Response Type
CreateProject	CreateProjectRequest	AIProject
Creates a new AI project and manages it in the metadata store
DeleteProject	DeleteProjectRequest	DeleteProjectResponse
Deletes an AI project by its ID. Note that deleting a project will NOT delete the services associated with it. This endpoint is used to delete the project metadata only from the metadata store.
GetAllProjectNames	GetAllProjectNamesRequest	GenAIProjectNames
Get all AI project names under a specific database. The database name is provided as a path parameter.
GetProjectByName	GetProjectByNameRequest	AIProject
Gets an AI project by its name and database. This endpoint is used to get the project metadata by its name.
GetAllProjects	GetAllProjectsRequest	GenAIProjects
CreateGraphAnalytics	CreateEntityRequest	CreateServiceResponse
CreateGraphRag	CreateEntityRequest	CreateServiceResponse
This service requires access to a Large Language Model (LLM) provider and an ArangoDB instance. The GraphRag service facilitates the retrieval of information from ArangoDB using natural language queries instead of AQL.
CreateGraphRagImporter	CreateEntityRequest	CreateServiceResponse
GraphRagImporter is a service that facilitates the import of text data into ArangoDB by creating a Knowledge Graph (KG) of the entities inside the data. This data is used by another service to answer natural language queries.
CreateGraphRagRetriever	CreateEntityRequest	CreateServiceResponse
GraphRagRetriever is a service that facilitates the retrieval of information from ArangoDB using natural language queries instead of AQL. This service requires access to a Large Language Model (LLM) provider and an ArangoDB instance. It is different than GraphRag as it requires the import of text data into ArangoDB first using the GraphRagImporter service.
CreateAutoGraph	CreateEntityRequest	CreateServiceResponse
AutoGraph is a service that facilitates automated graph construction and management.
CreateMLFlow	CreateEntityRequest	CreateServiceResponse
arangodb-mlflow is a service that provides an interface to MLflow server for managing machine learning experiments and models. This service needs to connect to a backend storage service for storing the artifacts.
CreateMLFlowRegistry	CreateEntityRequest	CreateServiceResponse
The artifacts of the MLflow service are stored in a registry. This service provides a registry for storing machine learning artifacts.
CreateNotebook	CreateEntityRequest	CreateServiceResponse
The notebook service provides a Jupyter notebook interface for running Python code on devstack
CreateLlmHost	CreateEntityRequest	CreateServiceResponse
This service allows hosting private Large Language Models (LLMs) using Triton Inference Server. LLM Host service needs access to the MLFlow service to download the model from there.
CreateUserDefinedService	CreateUDSRequest	CreateServiceResponse
Installs a user-defined service. The image_url parameter must NOT be set in the env (the image is managed by the platform). If app_instance_name is provided, it must be URL-compatible.
CreateGenericService	CreateGenericRequest	CreateServiceResponse
This endpoint can be used to install any service that has a chart image available and where dedicated API is not yet provided. Attention: Ensure that all required parameters by the service are provided. See the CreateGenericRequest message for more details.
DeleteService	DeleteServiceRequest	DeleteServiceResponse
Deletes a service by service_id. HTTP DELETE /v1/service/{service_id}, where service_id is the unique identifier of the service. Note that service_id is sent as a path parameter and not in the request body.
CheckServiceStatus	CheckStatusRequest	CheckStatusResponse
Checks the status of a service by service_id. Note that service_id is sent as a path parameter and not in the request body.
UpgradeService	UpgradeServiceRequest	UpgradeServiceResponse
Upgrades a service by service_id with new configuration, environment variables, or labels. HTTP PUT /v1/service/{service_id}, where service_id is the unique identifier of the service. Note that service_id is sent as a path parameter and not in the request body.
GetBaseImages	GetBaseImagesRequest	GetBaseImagesResponse
Returns the available UDS base images for Python and Node.js.
HealthCheck	HealthCheckRequest	HealthCheckResponse
Performs a health check on the gen-ai service.
ListServices	ListServicesRequest	ListServicesResponse
Lists all installed and deployed services.
GetSecretProfileTypes	GetSecretProfileTypesRequest	GetSecretProfileTypesResponse
Returns all available secret profile types with descriptions.
CreateSecretProfiles	CreateSecretProfilesRequest	BatchSecretProfileResponse
Creates multiple secret profiles in a batch.
DeleteSecretProfiles	DeleteSecretProfilesRequest	BatchSecretProfileResponse
Deletes multiple secret profiles by their IDs.
ListSecretProfiles	ListSecretProfilesRequest	ListSecretProfilesResponse
Lists secret profiles with optional filtering and pagination.
CreateSecretProfile	CreateSecretProfileRequest	SecretProfileResponse
Creates a new secret profile with encrypted storage.
GetSecretProfile	GetSecretProfileRequest	SecretProfileResponse
Retrieves a secret profile by its ID. Secret values are obfuscated in the response.
UpdateSecretProfile	UpdateSecretProfileRequest	SecretProfileResponse
Fully updates an existing secret profile.
PartialUpdateSecretProfile	PartialUpdateSecretProfileRequest	SecretProfileResponse
Partially updates a secret profile, modifying only specified fields.
DeleteSecretProfile	DeleteSecretProfileRequest	DeleteSecretProfileResponse
Deletes a secret profile by its ID.

AIProject

Field	Type	Label	Description
project_name	string		Unique project name, guaranteed in the gen-ai service upon project creation.
project_type	string
project_db_name	string		Name of the database under which the project is created.
project_metadata	GraphRAGProjectMetaData	optional	project metadata object. Initially empty by default.
project_description	string	optional
project_files	string	repeated	List of files uploaded to the project (shared across all services).
model_settings	AutoGraphModelSettings	optional	Durable AutoGraph model/provider configuration at the project (top) level, mirroring platform AiProject.model_settings (field 7) so it round-trips from the platform bytes and survives AutoGraph service teardown/redeploy.

AIService

Represents an AI service. This object contains the name of the service, the external URL of the service, the type of the service, the description of the service, the parameters of the service, the status of the service, and the version of the service.

Field	Type	Label	Description
service_id	string		The name of the service, e.g. "graphrag-importer-12345".
service_url	string		The external URL of the service.
service_type	string		The type of the service, e.g. "importer", "retriever".
description	string		The description of the service, provided by the user at installation time.
service_parameters	AIService.ServiceParametersEntry	repeated
status	AIServiceStatus		The status of the service, e.g. "loading", "finished", "failed". Updated by the service itself.
service_version	string	optional	The version of the service, e.g. "0.0.1-c12345".
model_settings	RetrieverModelSettings	optional	Per-service model/provider configuration, mirroring platform AiService.model_settings (field 8) so it round-trips from the platform bytes. Only populated for retriever services — each retriever entry in retriever_services carries its own independent config.

AIService.ServiceParametersEntry

Field	Type	Label	Description
key	string
value	string

AIServiceStatus

Represents the status of an AI service. This object contains the status of the service, the progress of the service, and an optional message from the service.

Field	Type	Label	Description
status	string
progress	float
message	string	optional

AutoGraphModelSettings

Model/provider configuration for the AutoGraph workflow. Chat and embedding are configured independently. All fields are required (enforced by the platform ProjectManager) except multimodal_model, chat_api_url and embedding_api_url, which are optional.

Field	Type	Label	Description
chat_api_provider	string		Chat LLM provider, e.g. "openai".
embedding_api_provider	string		Embedding provider, e.g. "openai".
chat_model	string		Chat/completion model name.
embedding_model	string		Embedding model name.
multimodal_model	string	optional	Optional multi-modal model name.
chat_secret_profile_id	string		Secret profile for the chat provider.
embedding_secret_profile_id	string		Secret profile for the embedding provider.
chat_api_url	string	optional	Optional chat provider API base URL, e.g. "https://openrouter.ai/api/v1".
embedding_api_url	string	optional	Optional embedding provider API base URL.

AutoGraphService

Represents an AutoGraph service with its status tracking. This object contains the service information and status for corpus build, RAG strategizer, and importer orchestration processes.

Field	Type	Label	Description
service_id	string		The name of the service, e.g. "arangodb-graphrag-autograph-12345".
service_url	string		The external URL of the service.
service_type	string		The type of the service, e.g. "autograph".
description	string		The description of the service.
corpusbuild	CorpusBuildStatus	optional	Corpus build status (current status only).
ragstrategizer	RagStrategizerStatus	optional	RAG strategizer status (current status only).
importer_orchestration	ImporterOrchestrationStatus	optional	Importer orchestration status (current status only).

BatchSecretProfileFailure

Represents a failed operation in a batch.

Field	Type	Label	Description
profile_id	string
error	string

BatchSecretProfileResponse

Response for batch operations with per-item success/failure tracking.

Field	Type	Label	Description
succeeded	string	repeated
failed	BatchSecretProfileFailure	repeated

CheckStatusRequest

Represents a request to check the status of a service by its ID.

Field	Type	Label	Description
service_id	string		ID of the service to check the status of.

CheckStatusResponse

Represents a response containing the status information of a service.

Field	Type	Label	Description
service_info	ServiceInfo		Status information of the service.

CorpusBuildStatus

Represents the status of corpus build process for AutoGraph service.

Field	Type	Label	Description
status	string		Current status of the corpus build.
progress	float		Progress percentage (0.0-100.0).
message	string	optional	Optional status message.

CreateEntityRequest

Represents a request to create an entity with required parameters for the service and labels.

Field	Type	Label	Description
env	CreateEntityRequest.EnvEntry	repeated	Required parameters for the service.
labels	CreateEntityRequest.LabelsEntry	repeated	Labels for the entity. Used to filter installed charts in ListCharts.

CreateEntityRequest.EnvEntry

Field	Type	Label	Description
key	string
value	string

CreateEntityRequest.LabelsEntry

Field	Type	Label	Description
key	string
value	string

CreateGenericRequest

Represents a request to create a generic service with a specified name, required parameters for the service, and labels.

Field	Type	Label	Description
service_name	string		Service name must match the name of the service in the helm chart.
env	CreateGenericRequest.EnvEntry	repeated	Required parameters for the service.
labels	CreateGenericRequest.LabelsEntry	repeated	Labels for the entity. Used to filter installed charts in ListCharts.

CreateGenericRequest.EnvEntry

Field	Type	Label	Description
key	string
value	string

CreateGenericRequest.LabelsEntry

Field	Type	Label	Description
key	string
value	string

CreateProjectRequest

Request message for creating a new AI project

Field	Type	Label	Description
project_name	string		Name of the project to create, provided by the user at creation time.
project_type	string		Type of the project (e.g., "graphrag", "analytics"), provided by the user at creation time in the first iteration.
project_db_name	string		Name of the database under which the project is created.
project_description	string	optional	Optional description, provided by the user at creation time.

CreateSecretProfileRequest

Request to create a new secret profile.

Field	Type	Label	Description
profile_type	string		e.g. "LLM", "DATABASE", "CUSTOM"
name	string
secret_data	string
description	string	optional
metadata	CreateSecretProfileRequest.MetadataEntry	repeated
profile_id	string	optional
provider	string	optional	e.g. "openai", "anthropic", "openrouter"

CreateSecretProfileRequest.MetadataEntry

Field	Type	Label	Description
key	string
value	string

CreateSecretProfilesRequest

Request to create multiple secret profiles in a batch.

Field	Type	Label	Description
profiles	SecretProfileCreateItem	repeated

CreateServiceResponse

Represents a response containing information about a created service.

Field	Type	Label	Description
service_info	ServiceInfo		Information about the created service.

CreateUDSRequest

Field	Type	Label	Description
app_name	string		The app name for user-defined services.
app_version	string		The app version for user-defined service.
env	CreateUDSRequest.EnvEntry	repeated	Required parameters for the service
labels	CreateUDSRequest.LabelsEntry	repeated	Labels for the entity. Used to filter installed charts in ListCharts.

CreateUDSRequest.EnvEntry

Field	Type	Label	Description
key	string
value	string

CreateUDSRequest.LabelsEntry

Field	Type	Label	Description
key	string
value	string

DataSource

Represents a data source associated with a project. Non-sensitive configuration is stored in config; credentials are stored in Secrets.

Field	Type	Label	Description
source_id	string
source_name	string
source_type	string
source_config	DataSource.SourceConfigEntry	repeated
source_status	string
last_processed_at	google.protobuf.Timestamp	optional

DataSource.SourceConfigEntry

Field	Type	Label	Description
key	string
value	string

DeleteProjectRequest

Request message for deleting an AI project by its name

Field	Type	Label	Description
project_name	string
project_db_name	string

DeleteProjectResponse

Response message for deleting an AI project by its name

Field	Type	Label	Description
message	string		Message indicating the result of the deletion.
deleted_project	AIProject	optional	Optional: return the deleted project info.

DeleteSecretProfileRequest

Request to delete a secret profile by ID.

Field	Type	Label	Description
profile_id	string

DeleteSecretProfileResponse

Response for a delete operation.

Field	Type	Label	Description
deleted	bool
message	string

DeleteSecretProfilesRequest

Request to delete multiple secret profiles by their IDs.

Field	Type	Label	Description
profile_ids	string	repeated

DeleteServiceRequest

Represents a request to delete a service by its identifier.

Field	Type	Label	Description
service_id	string		ID of the service to delete.

DeleteServiceResponse

Represents a response containing information about a deleted service.

Field	Type	Label	Description
service_info	ServiceInfo		Information about the deleted service.

GenAIProjectNames

Represents a list of created GenAI project names. This object contains only the unique project names. The actual project objects are stored in the metadata store and can be retrieved using the GetProject method.

Field	Type	Label	Description
project_names	string	repeated

GenAIProjects

Represents a list of created GenAI projects. This object contains the actual project objects. The projects are stored in the metadata store and can be retrieved using the GetProjectByName method.

Field	Type	Label	Description
projects	GenAIProjects.ProjectsEntry	repeated

GenAIProjects.ProjectsEntry

Field	Type	Label	Description
key	string
value	AIProject

GenAIProjectsByDatabase

GenAIProjects by database

Field	Type	Label	Description
projects_by_db	GenAIProjectsByDatabase.ProjectsByDbEntry	repeated

GenAIProjectsByDatabase.ProjectsByDbEntry

Field	Type	Label	Description
key	string
value	GenAIProjects

GetAllProjectNamesRequest

Request message for getting all AI project names under a specific database

Field	Type	Label	Description
project_db_name	string

GetAllProjectsRequest

Request message for getting all AI projects under a specific database

Field	Type	Label	Description
project_db_name	string

GetBaseImagesRequest

Request to get all available secret profile types.

GetBaseImagesResponse

Field	Type	Label	Description
python_images	string	repeated
nodejs_images	string	repeated

GetProjectByNameRequest

Request message for getting an AI project by its name

Field	Type	Label	Description
project_name	string
project_db_name	string

GetSecretProfileRequest

Request to retrieve a secret profile by ID.

Field	Type	Label	Description
profile_id	string

GetSecretProfileTypesRequest

GetSecretProfileTypesResponse

Response containing all available secret profile types.

Field	Type	Label	Description
profile_types	SecretProfileTypeInfo	repeated

GraphRAGProjectMetaData

These types will be soon moved to the arangodb_platform_internal library Upon moving, we will re-visit the naming of the fields.

Field	Type	Label	Description
importer_services	AIService	repeated	Importer services associated with the project.
retriever_services	AIService	repeated	Retriever services associated with the project.
knowledge_graph	KGMetadata		Knowledge graph associated with the project.
last_modified_timestamp	google.protobuf.Timestamp		The timestamp of the last modification of the project metadata.
autograph_service	AutoGraphService	optional	optional AIService virtual_graph_service = 5; // Virtual graph service associated with the project. optional VirtualGraphMetadata virtual_graph = 6; // Virtual graph associated with the project. AutoGraph service associated with the project (single service).

HealthCheckRequest

Represents a request to perform a health check.

HealthCheckResponse

Represents a response containing the status of a health check.

Field	Type	Label	Description
status	string		Status of the health check, e.g., "OK" or "BAD".
message	string	optional	Optional additional details, e.g., "Deployed".

ImporterOrchestrationStatus

Represents the status of importer orchestration for AutoGraph service.

Field	Type	Label	Description
status	string		Current status of the importer orchestration.
total_jobs	int32		Total number of jobs.
running	int32		Number of running jobs.
completed	int32		Number of completed jobs.
failed	int32		Number of failed jobs.
message	string	optional	Optional status message.

ImporterServiceMeta

Field	Type	Label	Description
chat_api_provider	string		CHAT_API_PROVIDER used by the importer service.
embedding_api_provider	string		EMBEDDING_API_PROVIDER used by the importer service.
chat_model	string		CHAT_MODEL configured for the importer service.
embedding_model	string		EMBEDDING_MODEL configured for the importer service.

KGMetadata

Represents the metadata of the knowledge graph associated with the project. This object contains the name of the knowledge graph and its properties. The properties are key-value pairs that can be used to store additional information about the knowledge graph.

Field	Type	Label	Description
kg_name	string
kg_properties	KGMetadata.KgPropertiesEntry	repeated

KGMetadata.KgPropertiesEntry

Field	Type	Label	Description
key	string
value	string

ListSecretProfilesRequest

Request to list secret profiles with optional filtering and pagination.

Field	Type	Label	Description
profile_type	string	optional	e.g. "LLM", "DATABASE"
name_contains	string	optional
limit	int32	optional
offset	int32
provider	string	optional	e.g. "openai", "anthropic"

ListSecretProfilesResponse

Response containing a paginated list of secret profile summaries.

Field	Type	Label	Description
profiles	SecretProfileSummary	repeated
total	int32
limit	int32	optional
offset	int32
has_more	bool

ListServicesRequest

Represents a request to list installed services. `options` parameter provides a way to set the selecting options.

Field	Type	Label	Description
options	ListServicesRequestOptions	optional

ListServicesRequestOptions

Represents label selectors for the list request options object for now contains only the selectors map, which is key-value pairs of services labels. services will be filteres based on these labels upon listing. labels here are the ones provided by the user at installation time under `labels` parameter of CreateEntityRequest or CreateGenericRequest.

Field	Type	Label	Description
selectors	ListServicesRequestOptions.SelectorsEntry	repeated	selectors work in AND logic, which means it matches all provided labels. e.g. {"environment": "dev", "dbversion": "latest"} will match services that have both values.

ListServicesRequestOptions.SelectorsEntry

Field	Type	Label	Description
key	string
value	string

ListServicesResponse

Represents a response containing a list of all installed services.

Field	Type	Label	Description
services	ServiceInfo	repeated	List of all installed services

PartialUpdateSecretProfileRequest

Request to partially update a secret profile. Only provided fields are updated.

Field	Type	Label	Description
profile_id	string
name	string	optional
description	string	optional
metadata	PartialUpdateSecretProfileRequest.MetadataEntry	repeated
secret_data	string
profile_type	string	optional	e.g. "LLM", "DATABASE", "CUSTOM"
provider	string	optional	e.g. "openai", "anthropic", "openrouter"

PartialUpdateSecretProfileRequest.MetadataEntry

Field	Type	Label	Description
key	string
value	string

ProviderInfo

Information about a provider for a secret profile type.

Field	Type	Label	Description
name	string
description	string	optional

RagStrategizerStatus

Represents the status of RAG strategizer process for AutoGraph service.

Field	Type	Label	Description
status	string		Current status of the RAG strategizer.
progress	float		Progress percentage (0.0-100.0).
message	string	optional	Optional status message.

RetrieverModelSettings

Model/provider configuration for a Retriever service. Chat and embedding are configured independently. All fields are required (enforced by the platform ProjectManager) except chat_api_url and embedding_api_url, which are optional. Mirrors platform RetrieverModelSettings field-for-field.

Field	Type	Label	Description
chat_api_provider	string		Chat LLM provider, e.g. "openai".
embedding_api_provider	string		Embedding provider, e.g. "openai".
chat_model	string		Chat/completion model name.
embedding_model	string		Embedding model name.
chat_secret_profile_id	string		Secret profile for the chat provider.
embedding_secret_profile_id	string		Secret profile for the embedding provider.
chat_api_url	string	optional	Optional chat provider API base URL, e.g. "https://api.openai.com/v1".
embedding_api_url	string	optional	Optional embedding provider API base URL.

RetrieverServiceMeta

Field	Type	Label	Description
chat_api_provider	string		CHAT_API_PROVIDER used by the retriever service.
embedding_api_provider	string		EMBEDDING_API_PROVIDER used by the retriever service.
chat_model	string		CHAT_MODEL configured for the retriever service.
embedding_model	string		EMBEDDING_MODEL configured for the retriever service.
chat_secret_profile_id	string	optional	Secret profile id (reference, not the secret) for the chat provider.
embedding_secret_profile_id	string	optional	Secret profile id (reference, not the secret) for the embedding provider.
chat_api_url	string	optional	Chat provider API base URL, if configured.
embedding_api_url	string	optional	Embedding provider API base URL, if configured.

SecretProfile

API-facing secret profile with string-based profile_type.

Field	Type	Label	Description
profile_id	string
profile_type	string		e.g. "LLM", "DATABASE", "CUSTOM"
name	string
description	string
metadata	SecretProfile.MetadataEntry	repeated
secret_data	string		Obfuscated in responses
version	int32
created_at	google.protobuf.Timestamp
updated_at	google.protobuf.Timestamp
provider	string		e.g. "openai", "anthropic", "openrouter"

SecretProfile.MetadataEntry

Field	Type	Label	Description
key	string
value	string

SecretProfileCreateItem

A single item in a batch create request.

Field	Type	Label	Description
profile_type	string		e.g. "LLM", "DATABASE", "CUSTOM"
name	string
secret_data	string
description	string	optional
metadata	SecretProfileCreateItem.MetadataEntry	repeated
profile_id	string	optional
provider	string	optional	e.g. "openai", "anthropic", "openrouter"

SecretProfileCreateItem.MetadataEntry

Field	Type	Label	Description
key	string
value	string

SecretProfileResponse

Response containing a single secret profile (secret values are obfuscated).

Field	Type	Label	Description
profile	SecretProfile

SecretProfileSummary

Summary of a secret profile for list operations (no secret data exposed).

Field	Type	Label	Description
profile_id	string
profile_id_masked	string
profile_type	string		e.g. "LLM", "DATABASE"
name	string
description	string
provider	string		e.g. "openai", "anthropic"

SecretProfileTypeInfo

Information about a single secret profile type.

Field	Type	Label	Description
type	string
value	int32
description	string
providers	ProviderInfo	repeated

Secrets

Container for sensitive project-specific secrets. Stores key-value pairs such as datasource credentials.

Field	Type	Label	Description
values	Secrets.ValuesEntry	repeated

Secrets.ValuesEntry

Field	Type	Label	Description
key	string
value	string

SemanticUnitRun

Represents a SemanticUnit workflow run and its status.

Field	Type	Label	Description
run_id	string
name	string	optional
started_at	google.protobuf.Timestamp
finished_at	google.protobuf.Timestamp	optional
status	string
datasource_ids	string	repeated
metadata	SemanticUnitRun.MetadataEntry	repeated

SemanticUnitRun.MetadataEntry

Field	Type	Label	Description
key	string
value	string

ServiceInfo

Contains information about a service, including its ID, description, status, and namespace.

Field	Type	Label	Description
service_id	string		Unique identifier of the service, generated during installation by combining the service name with a unique five-character identifier.
description	string		Description of the service.
status	string		Current status of the service.
namespace	string		Namespace in which the service is running.
db_name	string	optional	Database name associated with the service, if available.
managing_entity	string	optional	The orchestration service that manages this service, if applicable.
genai_project_name	string	optional	The name of the GenAI project associated with the service, if available.
service_meta	ServiceMeta	optional	Additional meta for the service, if available.

ServiceMeta

Field	Type	Label	Description
service_type	string		Prefix of service-id, e.g. "arangodb-graphrag-importer".
importer_meta	ImporterServiceMeta		Meta specific to importer service.
retriever_meta	RetrieverServiceMeta		Meta specific to retriever service.
uds_meta	UDSMeta		Meta specific to user-defined service.

UDSMeta

Field	Type	Label	Description
app_instance_name	string		The app instance name for user-defined services, if applicable.
app_name	string	optional	The app name for user-defined services, if applicable.
version	string	optional	The app version for user-defined services, if applicable.
base_image	string	optional	The base image for user-defined services, if applicable.
image_url	string	optional	The image URL for user-defined services, if applicable.
has_ui	bool		Indicates whether the user-defined service has a UI component.
display_name	string	optional	A user-friendly display name for the service, if applicable.
description	string	optional	A description of the user-defined service, if provided.

UpdateSecretProfileRequest

Request to fully update an existing secret profile.

Field	Type	Label	Description
profile_id	string
profile_type	string		e.g. "LLM", "DATABASE", "CUSTOM"
name	string
description	string	optional
metadata	UpdateSecretProfileRequest.MetadataEntry	repeated
secret_data	string
provider	string	optional	e.g. "openai", "anthropic", "openrouter"

UpdateSecretProfileRequest.MetadataEntry

Field	Type	Label	Description
key	string
value	string

UpgradeServiceRequest

Represents a request to upgrade a service with new configuration. Note that service_id is populated from the URL path parameter by the gateway.

Field	Type	Label	Description
service_id	string		ID of the service to upgrade (populated from URL path).
env	UpgradeServiceRequest.EnvEntry	repeated	Updated environment parameters for the service.
labels	UpgradeServiceRequest.LabelsEntry	repeated	Updated labels for the service.

UpgradeServiceRequest.EnvEntry

Field	Type	Label	Description
key	string
value	string

UpgradeServiceRequest.LabelsEntry

Field	Type	Label	Description
key	string
value	string

UpgradeServiceResponse

Represents a response containing information about an upgraded service.

Field	Type	Label	Description
service_info	ServiceInfo		Information about the upgraded service.

Scalar Value Types