AgentStack User API
User profile, sessions, user API keys. REST compatibility surface; for new integrations prefer MCP actions, GET/POST /api/dna/data, or POST /api/commands (see docs/API_CHANNELS_AND_PROTOCOLS.md).
User profile, sessions, user API keys. REST compatibility surface; for new integrations prefer MCP actions, GET/POST /api/dna/data, or POST /api/commands (see docs/API_CHANNELS_AND_PROTOCOLS.md).
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/agentstack-tech:agentstack-tech-user-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: AgentStack Core User API
description: 'AgentStack is a Universal Processing System — a patented AI-first platform that replaces an entire backend stack and ships a ready admin UI. One ecosystem covers auth, payments, data, social, messenger, AI, knowledge base, game economy, RBAC and more — behind a single SDK, REST API and Model Context Protocol surface. You say the outcome. An AI with AgentStack connected hosts, configures, and reads the result back. Free tier from $0.
**Two layers:** (1) **Universal access** — `POST /mcp` (`agentstack.execute`), `GET /mcp/actions`, `GET /mcp/discovery`; `GET/POST /api/dna/data` (8DNA key-value); `POST /api/commands/*` (Protein, same stack as MCP `commands.execute`). (2) **REST compatibility** — many `/api/*` routes for SPA, SDK, OAuth, webhooks, uploads. See repo doc `docs/API_CHANNELS_AND_PROTOCOLS.md`.
**Channels:** Prefer MCP (`POST /mcp`, `GET /mcp/actions`), 8DNA (`/api/dna/data`), and Protein commands (`/api/commands/*`) for new integrations. REST paths below are the compatibility surface for SPA, SDKs, OAuth, and uploads. See `/api-docs`, `/mcp-docs`, and docs/API_CHANNELS_AND_PROTOCOLS.md.
**Try it:** Use Authorize with `X-API-Key` or Bearer JWT. Changelog: docs/api/API_CHANGELOG.md.'
version: 0.4.24
x-agentstack-version: 0.4.24
x-genetic-tag: docs.api.specs.gen1
x-changelog-url: docs/api/API_CHANGELOG.md
x-exported-at: '2026-11-01T04:40:16Z'
security:
- ApiKeyAuth: []
- BearerAuth: []
tags:
- name: User
description: User profile, sessions, user API keys. REST compatibility surface; for new integrations prefer MCP actions, GET/POST /api/dna/data, or POST /api/commands (see docs/API_CHANNELS_AND_PROTOCOLS.md).
paths:
/api/user/api-keys:
post:
tags:
- User
summary: Create User Api Key
description: Create a user or agent PAT (ecosystem identity, project_id=1 in JWT).
operationId: create_user_api_key_api_user_api_keys_post
parameters:
- name: Idempotency-Key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Idempotency-Key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserAPIKeyRequest'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserAPIKeyResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-channel: rest_compat
get:
tags:
- User
summary: List User Api Keys
description: 'List all user API keys
Returns a list of all API keys for the authenticated user.'
operationId: list_user_api_keys_api_user_api_keys_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UserAPIKeyResponse'
title: Response List User Api Keys Api User Api Keys Get
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'422':
description: Unprocessable Entity
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-channel: rest_compat
/api/user/api-keys/limits/check:
get:
tags:
- User
summary: Check User Api Key Limit
description: Return the caller's PAT quota (buff-aware).
operationId: check_user_api_key_limit_api_user_api_keys_limits_check_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
additionalProperties: true
type: object
title: Response Check User Api Key Limit Api User Api Keys Limits Check Get
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'422':
description: Unprocessable Entity
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-channel: rest_compat
/api/user/api-keys/{key_id}:
delete:
tags:
- User
summary: Delete User Api Key
description: 'Delete a user API key
Deletes (deactivates) a user API key. The key will no longer be valid.'
operationId: delete_user_api_key_api_user_api_keys__key_id__delete
parameters:
- name: key_id
in: path
required: true
schema:
type: string
title: Key Id
- $ref: '#/components/parameters/IdempotencyKey'
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-channel: rest_compat
patch:
tags:
- User
summary: Update User Api Key
description: 'Update a user API key
Updates the name or status of a user API key.'
operationId: update_user_api_key_api_user_api_keys__key_id__patch
parameters:
- name: key_id
in: path
required: true
schema:
type: string
title: Key Id
- $ref: '#/components/parameters/IdempotencyKey'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserAPIKeyRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UserAPIKeyResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-channel: rest_compat
get:
tags:
- User
summary: Get User Api Key
description: 'Get a specific user API key
Returns information about a specific API key.
Use reveal_secret=true to get the full API key (only available once after creation/rotation).
When reveal_secret=true, returns RevealedUserAPIKeyResponse with api_key field.'
operationId: get_user_api_key_api_user_api_keys__key_id__get
parameters:
- name: key_id
in: path
required: true
schema:
type: string
title: Key Id
- name: reveal_secret
in: query
required: false
schema:
type: boolean
description: Return full API key secret when true
default: false
title: Reveal Secret
description: Return full API key secret when true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UserAPIKeyResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-channel: rest_compat
/api/user/api-keys/{key_id}/rotate:
post:
tags:
- User
summary: Rotate User Api Key
description: 'Rotate a user API key
Generates a new API key for the specified key_id. The old key will be invalidated.
Returns the new API key - save it immediately as it won''t be shown again.'
operationId: rotate_user_api_key_api_user_api_keys__key_id__rotate_post
parameters:
- name: key_id
in: path
required: true
schema:
type: string
title: Key Id
- $ref: '#/components/parameters/IdempotencyKey'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Rotate User Api Key Api User Api Keys Key Id Rotate Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-channel: rest_compat
/api/user/sessions:
get:
tags:
- User
summary: Get user sessions
description: 'Convenience path. Canonical: GET /api/sessions. Returns active sessions for the authenticated user (user_id from session).'
operationId: get_user_sessions_alias_api_user_sessions_get
responses:
'200':
description: List of user sessions
content:
application/json:
schema: {}
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'422':
description: Unprocessable Entity
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-channel: rest_compat
/api/user/profile:
get:
tags:
- User
summary: Get user profile
description: 'Convenience path. Canonical: GET /api/profile. Returns profile for the authenticated user (user_id from session).'
operationId: get_user_profile_alias_api_user_profile_get
responses:
'200':
description: User profile
content:
application/json:
schema: {}
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'422':
description: Unprocessable Entity
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-channel: rest_compat
/api/user/wallet:
get:
tags:
- User
summary: Get user wallets
description: 'Convenience path. Canonical: GET /api/profile/wallets. Returns wallets for the authenticated user (user_id from session).'
operationId: get_user_wallet_alias_api_user_wallet_get
responses:
'200':
description: List of user wallets
content:
application/json:
schema: {}
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'409':
description: Conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'422':
description: Unprocessable Entity
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
x-channel: rest_compat
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
ResourceScopeModel:
properties:
mode:
type: string
enum:
- all_accessible
- projects
title: Mode
default: all_accessible
project_ids:
items:
type: integer
type: array
title: Project Ids
type: object
title: ResourceScopeModel
CreateUserAPIKeyRequest:
properties:
name:
type: string
title: Name
description: Name for the API key
expires_at:
anyOf:
- type: string
- type: 'null'
title: Expires At
description: Expiration date (ISO 8601 format)
actor_kind:
type: string
enum:
- user
- agent
title: Actor Kind
description: user = acts as you; agent = scoped agent
default: user
preset:
anyOf:
- type: string
- type: 'null'
title: Preset
description: agent_runner | readonly_data | commerce_bot | full_project | user_full
service_caps:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Service Caps
description: Explicit cap allowlist; overrides preset
resource_scope:
anyOf:
- $ref: '#/components/schemas/ResourceScopeModel'
- type: 'null'
description: Default from actor_kind
project_id:
anyOf:
- type: integer
- type: 'null'
title: Project Id
description: Pin for agent keys when resource_scope omitted
confirm_agent_all_accessible:
type: boolean
title: Confirm Agent All Accessible
description: Required when actor_kind=agent and resource_scope is all_accessible
default: false
type: object
required:
- name
title: CreateUserAPIKeyRequest
ProblemDetails:
type: object
description: RFC 7807 Problem Details (+ AgentStack trace_id).
required:
- title
- status
properties:
type:
type: string
format: uri
default: about:blank
description: URI reference identifying the problem type.
title:
type: string
description: Short, human-readable summary of the problem type.
status:
type: integer
minimum: 100
maximum: 599
description: HTTP status code for this occurrence.
detail:
type: string
description: Human-readable explanation specific to this occurrence.
instance:
type: string
format: uri
description: URI reference identifying this specific occurrence.
trace_id:
type: string
description: AgentStack request/trace correlation id (X-Trace-Id).
CreateUserAPIKeyResponse:
properties:
key_id:
type: string
title: Key Id
api_key:
type: string
title: Api Key
name:
type: string
title: Name
created_at:
type: string
title: Created At
expires_at:
anyOf:
- type: string
- type: 'null'
title: Expires At
status:
type: string
title: Status
actor_kind:
anyOf:
- type: string
- type: 'null'
title: Actor Kind
resource_scope:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Resource Scope
service_caps:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Service Caps
preset:
anyOf:
- type: string
- type: 'null'
title: Preset
type: object
required:
- key_id
- api_key
- name
- created_at
- expires_at
- status
title: CreateUserAPIKeyResponse
UpdateUserAPIKeyRequest:
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: New name for the API key
status:
anyOf:
- type: string
- type: 'null'
title: Status
description: New status (active/inactive)
type: object
title: UpdateUserAPIKeyRequest
UserAPIKeyResponse:
properties:
key_id:
type: string
title: Key Id
name:
type: string
title: Name
created_at:
anyOf:
- type: string
- type: 'null'
title: Created At
last_used_at:
anyOf:
- type: string
- type: 'null'
title: Last Used At
expires_at:
anyOf:
- type: string
- type: 'null'
title: Expires At
status:
type: string
title: Status
key_preview:
anyOf:
- type: string
- type: 'null'
title: Key Preview
actor_kind:
anyOf:
- type: string
- type: 'null'
title: Actor Kind
resource_scope:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Resource Scope
service_caps:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Service Caps
preset:
anyOf:
- type: string
- type: 'null'
title: Preset
pat_kind:
anyOf:
- type: string
- type: 'null'
title: Pat Kind
oauth_client_id:
anyOf:
- type: string
- type: 'null'
title: Oauth Client Id
type: object
required:
- key_id
- name
- created_at
- last_used_at
- expires_at
- status
title: UserAPIKeyResponse
parameters:
IdempotencyKey:
name: Idempotency-Key
in: header
required: false
description: Client-generated key to make mutating requests idempotent.
schema:
type: string
maxLength: 256
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: User session JWT from /auth/login.
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
description: 'Project API key. Optional service_caps whitelist is enforced before RBAC. See /dev/docs/secure/api-keys-scopes. OAuth 2.1 Device Code (RFC 8628) for plugins: see /oauth/device/code — documented in docs, not as a non-standard OAS flow.'
x-tagGroups:
- name: Unified access
tags:
- MCP
- 8DNA API
- Commands
- name: Field access policy
tags:
- DataAccess
- name: Identity & access
tags:
- Authentication
- User
- Profile
- Sessions
- RBAC
- Permissions
- OAuth 2.1
- API Keys
- name: Project platform
tags:
- Projects
- Project
- CRM
- Business
- Integrations
- Agents Fleet
- Support
- Bots
- Dashboard
- Notifications
- name: Commerce
tags:
- Payments
- AgentNet
- Commerce
- Commerce Shop
- Commerce Merchant
- Marketplace
- Assets
- Global Assets
- Invoices
- Buffs
- name: Automation
tags:
- Logic Engine
- Logic Templates
- Commands
- Scheduler
- Webhooks
- Unified API
- name: Data & AI
tags:
- 8DNA API
- RAG
- Neural Architecture
- Neural Events
- AI Builder
- Files
- Project Files
- Hosting
- name: Ops
tags:
- Health & Metrics
- Admin
- Analytics
- Backup Management
- OAuth 2.1 Admin
- Observability
- OpTrace
- API Hub
- name: Fabric & platform
tags:
- Fabric
# --- truncated at 32 KB (32 KB total) ---
# Full source: https://artifacts.apis.io/agentstack-tech/openapi/agentstack-tech-user-api-openapi.yml