Skip to content
faros Docs
Open console

Enter a topic to search documentation.

    App Studio API reference

    Resource operations, examples, and schema definitions.

    Prerequisites and scope

    Use the workspace where App Studio is enabled. Authenticate with a credential authorized for the requested resource and operation. Inspect your deployed API discovery for the exact schema in your hub.

    Interfaces

    Project, Session, and Studio in ai.faros.sh/v1alpha1. Project bindings connect repositories, environments, and exact provider resources. Conversations use the provider message API rather than storing every message in a CR.

    Resource schemas

    Resource fields and validation rules are generated from the checked-in schemas, with a downloadable JSON bundle.

    Inspect a workspace

    Use a kubeconfig context that is already authenticated for the target workspace. The context supplies the bearer credential; do not put a token in a manifest or shell history.

    Terminal
    kubectl faros use
kubectl api-resources --api-group=ai.faros.sh
kubectl get projects.ai.faros.sh,studios.ai.faros.sh,sessions.ai.faros.sh
kubectl explain projects.ai.faros.sh.spec --api-version=ai.faros.sh/v1alpha1

    The list command returns workspace-scoped objects; these resources do not use Kubernetes namespaces. Forbidden means the credential lacks list permission in that workspace; an empty list means no objects matched. If the resource is unknown, verify provider installation and API discovery before applying a manifest.

    Authoritative definitions

    API definitions contain fields and contracts. For Kubernetes-style resources, use kubectl api-resources and kubectl explain RESOURCE against the intended workspace to inspect the installed schema.

    Databricks integration . Return to App Studio for prerequisites and the provider’s quickstart.