> ## Documentation Index
> Fetch the complete documentation index at: https://docs.base44.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get the agent profile
> This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.
Returns the facts an external coding agent needs before changing this app: the web framework and app type, the backend runtime, the scheduling pipeline, whether custom auth is enrolled, where Core integration calls may run, what the workspace plan allows, and the exact platform skill references to read for this app's shape. The references are the files Base44 publishes to the skills repository; install them with the `install_command` or read them from the repository directly.
Rate limit: 60 requests per minute per caller, shared across apps. Errors use the standard envelope `{"error": {"code", "message", "details"}}`.
## OpenAPI
````yaml /developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/agent-profile
openapi: 3.1.0
info:
title: Base44 App Management API
version: 1.0.0
servers:
- url: https://app.base44.com
security:
- PersonalAccessTokenAuth: []
paths:
/api/apps/{app_id}/agent-profile:
get:
summary: Get the agent profile
description: >-
This API is in beta. Endpoints, fields, and behavior may still
change, so avoid depending on it in production.
Returns the facts an external coding agent needs before changing this
app: the web framework and app type, the backend runtime, the scheduling
pipeline, whether custom auth is enrolled, where Core integration calls
may run, what the workspace plan allows, and the exact platform skill
references to read for this app's shape. The references are the files
Base44 publishes to the skills repository; install them with the
`install_command` or read them from the repository directly.
Rate limit: 60 requests per minute per caller, shared across apps.
Errors use the standard envelope `{"error": {"code", "message",
"details"}}`.
operationId: get_agent_profile_api_apps__app_id__agent_profile_get
parameters:
- name: app_id
in: path
required: true
schema:
type: string
description: ID of the app whose sandbox to operate on.
title: App Id
description: ID of the app whose sandbox to operate on.
example: 6820f3a4e7b91d003c45a1f2
responses:
'200':
description: The app's profile and the skill references that apply to it.
content:
application/json:
schema:
$ref: '#/components/schemas/AgentProfileResponse'
'401':
description: Missing or invalid credential (`unauthenticated`).
'403':
description: The credential cannot read this app (`forbidden`).
'404':
description: The app does not exist or you do not administer it (`not_found`).
'429':
description: >-
Rate limit reached (`rate_limited`): more than 60 requests in a
minute by this caller, across apps. Retry later.
security:
- PersonalAccessTokenAuth:
- read_only
- WorkspaceApiKeyAuth:
- read_only
- WorkspaceApiKeyBearerAuth:
- read_only
components:
schemas:
AgentProfileResponse:
properties:
app_id:
type: string
title: App Id
description: ID of the app.
example: 6820f3a4e7b91d003c45a1f2
app_type:
type: string
title: App Type
description: >-
The platform's app type: `user_app` (web), `mobile_app`,
`user_game`, `slide`, `imported_app`, `user_agent`, `grow` or
`user_workflows`.
example: user_app
framework:
anyOf:
- type: string
- type: 'null'
title: Framework
description: >-
Web framework the app was seeded with: `vite_spa` or
`tanstack_start` (a game is a `vite_spa` app). `null` for mobile
apps.
example: tanstack_start
backend_runtime:
type: string
title: Backend Runtime
description: >-
Generation of the runtime the app's backend functions run on:
`current`, or `legacy` for apps not yet migrated. Only `current`
apps have compiled skill references.
example: current
automation_pipeline:
type: string
title: Automation Pipeline
description: >-
Scheduling pipeline the app uses: `workflows` (the default) or
`legacy_automations` for apps that predate workflows.
example: workflows
custom_auth_enrolled:
type: boolean
title: Custom Auth Enrolled
description: >-
Whether the app ships the custom-auth boilerplate (its own login
pages) instead of the platform login.
example: true
core_integrations:
type: string
title: Core Integrations
description: >-
Where `base44.integrations.Core` calls other than file uploads and
signed URLs may run: `backend_functions_only` (the app has
core-integration control, the default for new apps; the runtime
rejects the call from client code) or `client_allowed`.
example: backend_functions_only
entitlements:
$ref: '#/components/schemas/AgentProfileEntitlements'
description: What the app's workspace plan lets it use.
skills:
$ref: '#/components/schemas/AgentProfileSkills'
description: >-
Where the compiled platform skills live and which references apply
to this app.
unsupported_reason:
anyOf:
- type: string
- type: 'null'
title: Unsupported Reason
description: >-
Why no skill references are listed: `app_type_not_supported` or
`legacy_runtime_not_compiled`. `null` when references are listed.
type: object
required:
- app_id
- app_type
- framework
- backend_runtime
- automation_pipeline
- custom_auth_enrolled
- core_integrations
- entitlements
- skills
- unsupported_reason
title: AgentProfileResponse
example:
app_id: 6820f3a4e7b91d003c45a1f2
app_type: user_app
automation_pipeline: workflows
backend_runtime: current
core_integrations: backend_functions_only
custom_auth_enrolled: true
entitlements:
actors: true
backend_functions: true
workflows: true
framework: tanstack_start
skills:
install_command: npx skills add base44/skills
items:
- capability: entities
path: skills/base44-platform-entities/references/web.md
repository: https://github.com/base44/skills
variant: web-tanstack
AgentProfileEntitlements:
properties:
backend_functions:
type: boolean
title: Backend Functions
description: >-
Whether the app's workspace plan includes backend functions (Builder
plan or above).
example: true
workflows:
type: boolean
title: Workflows
description: >-
Whether the app's workspace plan includes workflows (Builder plan or
above).
example: true
actors:
type: boolean
title: Actors
description: >-
Whether this app can run realtime actors: backend functions on the
current runtime.
example: true
type: object
required:
- backend_functions
- workflows
- actors
title: AgentProfileEntitlements
AgentProfileSkills:
properties:
repository:
type: string
title: Repository
description: Git repository that publishes the compiled platform skills.
example: https://github.com/base44/skills
install_command:
type: string
title: Install Command
description: >-
Command that installs the skills into a coding agent that supports
Agent Skills.
example: npx skills add base44/skills
variant:
anyOf:
- type: string
- type: 'null'
title: Variant
description: >-
The compiled skill variant this app maps to, or `null` when no
variant is compiled for it.
example: web-tanstack
items:
items:
$ref: '#/components/schemas/AgentProfileSkill'
type: array
title: Items
description: >-
The reference files to read for this app, one per capability
reference that serves its variant. Empty when `unsupported_reason`
is set.
example:
- capability: entities
path: skills/base44-platform-entities/references/web.md
type: object
required:
- repository
- install_command
- variant
- items
title: AgentProfileSkills
AgentProfileSkill:
properties:
capability:
type: string
title: Capability
description: >-
The platform capability this reference belongs to; its skill
directory is `skills/base44-platform-/`.
example: entities
path:
type: string
title: Path
description: Path of the reference file inside the skills repository.
example: skills/base44-platform-entities/references/web.md
type: object
required:
- capability
- path
title: AgentProfileSkill
securitySchemes:
PersonalAccessTokenAuth:
type: http
scheme: bearer
description: >-
Personal access token, sent as `Authorization: Bearer `. Each
operation lists the permission it needs: `read_only` or `full_access`. A
full-access token can call every operation. A read-only token can call
only the operations that list `read_only`; anything else returns 403
`read_only_credential_route_not_allowed`.
WorkspaceApiKeyAuth:
type: apiKey
in: header
name: api_key
description: >-
Workspace API key, sent as `api_key: `. Each operation that accepts
one lists what the key needs: a permission, `read_only` or
`full_access`, like a personal access token, or a scope. A key without
the scope gets 403 `workspace_api_key_scope_required`.
WorkspaceApiKeyBearerAuth:
type: http
scheme: bearer
description: >-
Workspace API key, sent as `Authorization: Bearer `. Accepted
wherever `api_key` is, with the same permission.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.